NodeComponentProxy Class Reference
NodeComponent is the base class for all node components. More...
Inheritance diagram for NodeComponentProxy:
Public Member Functions | |
| Node | getNode () |
| Returns the node the node component is attached to or null handle if node component is not attached to a node. | |
| NodeComponentState | getState () |
| Gets the state of node component indicating if component is attached to a node, detached from any node or in process of attaching/detaching. | |
 Public Member Functions inherited from KanziObject | |
| boolean | equals (Object object) |
| Domain | getDomain () |
| Returns the domain the object belongs to. | |
| Metaclass | getDynamicMetaclass () |
| Returns the metaclass of the dynamic type of the object. | |
| long | getNative () |
| Gets a pointer to the backing C++ instance. | |
| TDataType | getOptionalProperty (PropertyType< TDataType > propertyType) |
| Returns the current value of a property type, but does not use the default value if there are no inputs to the property value. | |
| TDataType | getProperty (PropertyType< TDataType > propertyType) |
| Returns the current value of a property type. | |
| int | hashCode () |
| boolean | hasValue (PropertyType< TDataType > propertyType) |
| Evaluates whether there are any inputs into the property value. | |
| boolean | isStale () |
| Test if the object is stale i.e. | |
| void | removeLocalValue (PropertyType< TDataType > propertyType) |
| Removes the local value associated with the property. | |
| void | setFlagKeepDuringPatching (PropertyType< TDataType > propertyType) |
| Sets the flag to indicate that the property was loaded from KZB. | |
| void | setProperty (PropertyType< TDataType > propertyType, TDataType value) |
| Sets the local value of a property type. | |
| ObjectRef< TType > | tryCreateObjectRef (Class< TType > clazz) |
| Tries to create an owning ObjectRef instance to this KanziObject. | |
Static Public Attributes | |
| static final Metaclass | metaclass |
| The Metaclass for the class. | |
| Static Public Attributes inherited from KanziObject | |
| static final Metaclass | metaclass = new AbstractMetaclass("Kanzi.Object") |
| The Metaclass for the class. | |
Additional Inherited Members | |
| Public Attributes inherited from NodeComponentMetadata | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.NodeComponent") |
| Metaclass for NodeComponent. | |
| DynamicPropertyType< String > | NameProperty |
| Name. | |
Detailed Description
NodeComponent is the base class for all node components.
Node component is an isolated piece of logic which can be attached to any node in order to add additional functionality to it. Examples of node component could be Trigger which performs specific actions when certain conditions are met or AnimationPlayer which animates specific properties of the node it is attached to and its child nodes.
Member Function Documentation
◆ getNode()
| Node getNode | ( | ) |
Returns the node the node component is attached to or null handle if node component is not attached to a node.
- Returns
- Node the node component is attached to.
◆ getState()
| NodeComponentState getState | ( | ) |
Gets the state of node component indicating if component is attached to a node, detached from any node or in process of attaching/detaching.
- Returns
- State of node component.