VSN::HotPointWidget Class Referencefinal
HotPointWidget is a special HotPoint control. Instances of this object located in the scene are intended to manipulate scene objects. More...
#include <vsn_hotpointwidget.h>
Inheritance diagram for VSN::HotPointWidget: Collaboration diagram for VSN::HotPointWidget:Public Types | |
| enum class | Style |
| Enumeration of the control's display style. | |
Public Member Functions | |
| HotPointWidget (GraphicsScene *pScene, Style eStyle=Style::Sphera) | |
| Default constructor. | |
| virtual | ~HotPointWidget () |
| Destructor. | |
| HotPointWidget::Style | GetStyle () const |
| Return the control's current style. | |
| void | SetStyle (HotPointWidget::Style eStyle) |
| Set the current control style. | |
| Color | GetColor () const |
| Return the control's current color. | |
| void | SetColor (const Color &color) |
| Set the current control color. | |
| Color | GetHighlightColor () const |
| Return the control's current highlight color. | |
| void | SetHighlightColor (const Color &color) |
| Set the control's current highlight color. | |
| float | GetSize () const |
| Return the control's current size. | |
| void | SetSize (float fValue) |
| Set the control's current size. | |
| const AbsCoordLocator * | GetLocator () const |
| Return the control's current locator. | |
| void | SetLocator (AbsCoordLocator *pLocator) |
| Set the control's current locator. | |
| Public Member Functions inherited from VSN::SceneWidget | |
| SceneWidget (GraphicsScene *pScene, WidgetModelPtr ptrModel, const Point3DF &origin={}) | |
| Сonstructor. | |
| SceneWidget (GraphicsScene *pScene, WidgetModelPtr ptrModel, const Matrix3DF &transform) | |
| Сonstructor. | |
| virtual | ~SceneWidget () |
| Destructor. | |
| virtual void | Render (RenderContext &context) const override |
| Render the control. | |
| virtual std::pair< int, double > | Intersect (const MbLine3D &ray) const override |
| NOT TRANSLATED. | |
| virtual std::pair< int, float > | Intersect (const Ray3DF &ray) const override |
| Search the geometry by the ray. | |
| virtual bool | IsScreenOnly () const override |
| Draw control only in screen coordinates. | |
| virtual bool | IsHighlight () const override |
| Check the highlight of the control. | |
| virtual bool | IsHighlightEnable () const override |
| Check the highlight of the control. | |
| void | SetHighlight (bool value) |
| Set the highlight of the control. | |
| void | SetHighlightEnable (bool value) |
| Set the highlight of the control. | |
| void | Init (const Point3DF &origin) |
| Change the position of the control without initiation the modify signal. | |
| void | Init (const Matrix3DF &transform) |
| Change the position of the control without initiation the modify signal. | |
| const Matrix3DF & | GetTransform () const |
| Get position of the control. | |
| void | SetScene (GraphicsScene *pScene) |
| Set the Scene where the control will be displayed. | |
| bool | IsVisible () const |
| Check the visibility of the contro. | |
| void | SetVisible (bool bVisible) |
| Set the visibility of the contro. | |
| void | SetState (int state) |
| Set the display state. | |
| int | GetState () const |
| Get the display state. | |
| Point3DF | GetOrigin () const |
| Get constrol position. | |
| void | SetOrigin (const Point3DF &origin) |
| Set constrol position. | |
| void | Rotate (const MbAxis3D &axis, double angle) |
| Rotate the control. | |
| void | Rotate (const Point3DF &origin, const Vector3DF vAxis, float angle) |
| Rotate the control. | |
| MbCube | GetSize () const |
| Get the bounding box. | |
| virtual void | AssignProcess (int id, WidgetProcess *process) override |
| Signal about the change of control placement. More... | |
| virtual WidgetProcess * | GetAssignedProcess (int id) const override |
| Get a process connected to a component of the control. | |
| Public Member Functions inherited from VSN::Node | |
| Node (Node *pParent=nullptr) | |
| Constructor with parent. | |
| virtual | ~Node () |
| Destructor. | |
| NodeKey | GetUniqueKey () const |
| Returns key identifing Node instance. | |
| void | SetUniqueKey (const NodeKey &key) |
| Sets the unique key for the instance. | |
| NodeKey | GetCustomKey () const |
| Returns custom key identifing Node instance. | |
| void | SetCustomKey (const NodeKey &key) |
| Sets the custom unique key for the instance. | |
| Node * | GetParentNode () const |
| Returns pointer to the parent object or nullptr if no parent. | |
| bool | IsEnabled () const |
| Returns the Node enabled flag. By default, the flag is always on. | |
| ObjectList< Node * > | GetChildNodes () const |
| Return an array of child nodes for this node. | |
| void | SetParent (Node *pParent) |
| Sets parent object to the object. | |
| bool | IsNotificationsBlocked () const |
| True if notifications are blocked, otherwise, False. | |
| bool | SetBlockNotifications (bool block) |
| Sets blocking of notifications and returns the previous blocking value. | |
| Public Member Functions inherited from VSN::Object | |
| Object (Object *pParent=nullptr) | |
| Default constructor. More... | |
| virtual | ~Object () |
| Destructor. | |
| void | SetParent (Object *pParent) |
| NO TRANSLATION. | |
| Mutex * | GetMutex () |
| Object mutex. | |
| String | GetObjectName () const |
| Returns name. | |
| void | SetObjectName (const String &name) |
| Sets name. | |
| bool | IsControlType () const |
| TRANSLATION. | |
| Object * | GetParent () const |
| NO TRANSLATION. | |
| Variant | GetProperty (const String &name) const |
| NO TRANSLATION. | |
| bool | IsSignalsBlocked () const |
| NO TRANSLATION. | |
| bool | SetBlockSignals (bool bBlock) |
| NO TRANSLATION. | |
| void | AddEventListener (Object *pObject) |
| NO TRANSLATION. | |
| void | RemoveEventListener (Object *pObject) |
| NO TRANSLATION. | |
| Object * | GetSender () const |
| NO TRANSLATION. | |
| Thread * | GetThread () const |
| NO TRANSLATION. | |
| void | BindWithThread (Thread *thread) |
| NO TRANSLATION. | |
| int | StartTimer (int interval, TimerType timerType=tt_CoarseTimer) |
| NO TRANSLATION. | |
| void | KillTimer (int id) |
| NO TRANSLATION. | |
| const ObjectList< Object * > & | GetChildren () const |
| NO TRANSLATION. | |
| template<typename T > | |
| T | FindChild (const String &objName=String()) const |
| NO TRANSLATION. | |
| template<typename T > | |
| ObjectList< T > | FindChildren (const String &objName=String(), VSN::ChildFindingPolicies policies=VSN::FindAllNestedChildren) const |
| NO TRANSLATION. | |
| Public Member Functions inherited from VSN::BasicObject | |
| BasicObject () | |
| Default constructor. | |
| virtual | ~BasicObject () |
| Destructor. | |
Additional Inherited Members | |
| Protected Member Functions inherited from VSN::Node | |
| Node (NodePrivate &dd, Node *pParent) | |
| Sets the node enable flag. More... | |
| virtual void | SceneModificationEvent (const std::shared_ptr< SceneModification > &modification) |
| The function is called in case of scene being modified. | |
Detailed Description
HotPointWidget is a special HotPoint control. Instances of this object located in the scene are intended to manipulate scene objects.
HotPointWidget is an interactive tool that interacts with the MoveWidgetProcess. HotPointWidget has two types of representation: "3D sphere" and "2D square". For HotPointWidget, you can set restrictions using any of the locators, which are a descendant of AbsCoordLocator; you can set a locator using the SetLocator function. You can also assign your own locator, which should inherit from AbsCoordLocator.
The documentation for this class was generated from the following file:
