VSN::Essence Class Reference
Essence is a node subclass that aggregating several instances of features for entity behavior definition. More...
#include <vsn_essence.h>
Inheritance diagram for VSN::Essence: Collaboration diagram for VSN::Essence:Public Member Functions | |
| Essence (Node *pParent=nullptr) | |
| Default constructor setting parent node. | |
| virtual | ~Essence () |
| Destructor. | |
| void | AddFeature (Feature *pFeature) |
| Adds new pointer to Feature. | |
| void | RemoveFeature (Feature *pFeature) |
| Removes specified pointer to Feature. | |
| FeatureVector | GetFeatures () const |
| Returns feature instance list to which Essence refers. | |
| Essence * | GetParentEssence () const |
| Returns pointer to Essence parent instance. | |
| 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. | |
Protected Member Functions | |
| Essence (EssencePrivate &dd, Node *parent=nullptr) | |
| Constructor setting parent node and private data. | |
| 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
Essence is a node subclass that aggregating several instances of features for entity behavior definition.
Essence class is an empty wrapper in itself. The behavior of Essence object is defined by Feature objects it refers to. Each feature, knowing features Essence consists of, will be able to interpret and process that class. The feature can solve such problems as object transformation and at the same time perform keyboard input and so on.
The documentation for this class was generated from the following file:
