This reference page is linked to from the following overview topics: Schematic View API, Schematic View Events.
Detailed Description
Represents a node in the schematic view graph and provides a few methods for querying information about the node.
- See also:
- IGraphObjectManager, Object, Animatable
#include <svcore.h>
Public Member Functions |
|
| virtual Animatable * | GetAnim ()=0 |
| Returns the Animatable associated with this node.
|
|
| virtual IGraphNode * | GetParentNode ()=0 |
| Returns the "primary parent" of this node.
|
|
| virtual Animatable * | GetOwner ()=0 |
| Returns the "owner" of this node. |
|
| virtual int | GetID ()=0 |
| Returns the ID of this node. |
|
Member Function Documentation
| virtual Animatable* GetAnim | ( | ) | [pure virtual] |
Returns the Animatable associated with this node.
| virtual IGraphNode* GetParentNode | ( | ) | [pure virtual] |
Returns the "primary parent" of this node.
Nodes can have multiple parents (objects referencing this node) so this function is not strictly accurate. That said, many nodes have the concept of an owner node, which is what this function returns.
| virtual Animatable* GetOwner | ( | ) | [pure virtual] |
Returns the "owner" of this node.
Some nodes have multiple owners. When this is the case, this function returns the "first" owner (the object that first added this node to the schematic view).
| virtual int GetID | ( | ) | [pure virtual] |
Returns the ID of this node.
When nodes are added to the schematic view (via the IGraphObjectManager::AddAnimatable() method), an integer is provided. This value is not used internally by the schematic view. Rather, it is available to implementers of the Animatable::Sv*() methods to aid in identifying the node.
