VSN::SceneWidget Class Reference

The class of the control element located on the scene. More...

#include <vsn_widgets.h>

Inheritance diagram for VSN::SceneWidget:

Collaboration diagram for VSN::SceneWidget:

Public Member Functions
	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

The class of the control element located on the scene.

Instances of this class are designed to manage elements (properties) of the scene.

• Allows you to move a point in the global coordinate system.

Member Function Documentation

AssignProcess()

virtual void VSN::SceneWidget::AssignProcess ( int  id, WidgetProcess *  process  )

overridevirtual

Signal about the change of control placement.

Process start event. Process stop event. Signal about the change of position. Connect process to a component of the control.

Implements VSN::WidgetBase.

---

The documentation for this class was generated from the following file:

• vsn_widgets.h