|
HDK
|
#include <UNI_Node.h>
Inheritance diagram for UNI_Node:Public Member Functions | |
| UNI_NodeID | createNode (const UT_StringHolder &node_name, const UT_StringHolder &node_type_name, const UT_StringHolder &signature_name=UT_StringHolder()) const |
| Create a new child node. More... | |
| UNI_NodeID | createSubnet (const UT_StringHolder &subnet_node_name, const UNI_PortIDList &create_input_ports, const UNI_PortIDList &create_output_ports) const |
| Create a new subnet node with a pre-populates its inputs and outputs. More... | |
| void | setName (const UT_StringHolder &name) const |
| Sets the node name. More... | |
| void | setSignature (const UT_StringHolder &signature_name) const |
| Sets the current signature for this node. More... | |
| void | updateDownstreamPortTypes (bool update_node) const |
| void | setPosition (const UT_Vector2D &pos) const |
| Sets the node position in the graph editor. More... | |
| void | setColor (const UT_Color &clr) const |
| Sets the node color. More... | |
| void | setComment (const UT_StringHolder &comment) const |
| Sets the node comment. More... | |
| void | setTags (const UT_StringArray &tags) const |
| Sets the node tags. More... | |
| void | setParmValue (const UT_StringRef &parm_name, const UNI_ParmValue &value) |
| Sets a parm value. More... | |
| UNI_StickyNoteID | createStickyNote (const UT_StringHolder &name) const |
| Create a sticky note child. More... | |
| void | destroy () const |
| Destroys this node. More... | |
| void | setContainerConnectPosition (UNI_ContainerConnectType contype, const UT_Vector2D &pos) |
| void | setContainerConnectColor (UNI_ContainerConnectType contype, const UT_Color &clr) |
| bool | pasteItems (UNI_NodeIDList &node_ids, UNI_StickyNoteIDList ¬e_ids, std::istream &is, UT_StringMap< UT_StringHolder > *rename_map) |
| Paste items into this node from a stream (created by copyItems). More... | |
| Public Member Functions inherited from UNI_Item< UNI_NodeID, UNI_SessionNodeID, UNI_ConstNode > | |
| UNI_Item ()=default | |
| Constructor. More... | |
| UNI_Item (const UNI_GraphHandle &graph_handle, UNI_NodeIDid) | |
| UNI_Item (UNI_GraphHandle &&graph_handle, UNI_NodeIDid) | |
| Constructor with r-value for the intrusive graph pointer. More... | |
| UNI_Graph * | graph () const |
| Returns the graph inside which the node lives. More... | |
| UNI_Item (UNI_SessionNodeIDsession_id) | |
| Other convenience constructors. More... | |
| UNI_Item (UNI_GraphID graph_id, UNI_NodeIDid) | |
| Other convenience constructors. More... | |
| Public Member Functions inherited from UNI_ConstNode | |
| bool | isRootNode () const |
| Returns true if this is the graph root node. More... | |
| bool | isSubnet () const |
| Returns true if this node is a subnet (can contain other nodes). More... | |
| bool | isEditableSubnet () const |
| Returns true if this subnet's contents can be modified. More... | |
| bool | isEditable () const |
| Returns true if this is the graph root node. More... | |
| UT_StringHolder | name () const |
| Returns the name of the node. More... | |
| UT_StringHolder | path () const |
| Return the full path from the root of the graph to this node. More... | |
| UT_StringHolder | categoryName () const |
| Returns the category name of the node. More... | |
| UT_StringHolder | typeName () const |
| Returns the type name of the node. More... | |
| UT_StringHolder | signatureName () const |
| Returns the name of the current signature of this node. More... | |
| UT_Vector2D | position () const |
| Returns the node position in the graph editor. More... | |
| UT_Color | color () const |
| Returns the color tint of the node in the graph editor. More... | |
| UT_StringHolder | iconName () const |
| Returns the icon name for the given node. More... | |
| UT_StringHolder | comment () const |
| Returns the comment for the node. More... | |
| UT_StringArray | tags () const |
| Returns the tags (a set of keywords) assigned to the node. More... | |
| UT_StringHolder | parmDialogScript () const |
| Returns a dialog script describing this node's parms. More... | |
| UNI_ParmValue | parmValue (const UT_StringRef &parm_name) const |
| Get the value of a parm on this node. More... | |
| UNI_NodeID | parent () const |
| UNI_NodeID | findNode (const UT_StringRef &path) const |
| UNI_NodeIDList | childNodes () const |
| Returns array of ids of all direct children of this node. More... | |
| UNI_StickyNoteIDList | childStickyNotes () const |
| Returns all sticky notes contained by this node. More... | |
| UNI_StickyNoteID | findStickyNote (const UT_StringRef &path) const |
| Find a sticky note using a path specified relative to this node. More... | |
| UNI_PortIDList | inputPorts () const |
| Input ports of a node. More... | |
| UNI_PortIDList | outputPorts () const |
| Output ports of a node. More... | |
| bool | hasDynamicPorts (UNI_NodeID node_id) const |
| Does this node have dynamic input or output ports (not subports). More... | |
| UT_Vector2D | containerConnectPosition (UNI_ContainerConnectType contype) const |
| UT_Color | containerConnectColor (UNI_ContainerConnectType contype) const |
| bool | copyItems (const UNI_NodeIDList &node_ids, const UNI_StickyNoteIDList ¬e_ids, std::ostream &os) const |
| Copy items contained by this node. More... | |
| Public Member Functions inherited from UNI_ConstItem< UNI_NodeID > | |
| UNI_ConstItem ()=default | |
| Constructor. More... | |
| UNI_ConstItem (const UNI_ConstGraphHandle &graph_handle, UNI_NodeIDid) | |
| UNI_ConstItem (UNI_ConstGraphHandle &&graph_handle, UNI_NodeIDid) | |
| Constructor with r-value for the intrusive graph pointer. More... | |
| const UNI_Graph * | graph () const |
| Returns the graph inside which the node lives. More... | |
| UNI_NodeID | id () const |
| Returns the ID of the node in the graph. More... | |
| bool | isValid () const |
| operator bool () const | |
Additional Inherited Members | |
| Public Types inherited from UNI_Item< UNI_NodeID, UNI_SessionNodeID, UNI_ConstNode > | |
| using | ChangeBlock = UNI_Graph::ChangeBlock |
| Alias the change block for use in this class, for brevity. More... | |
| using | ChangeType = UNI_GraphChangeType |
| Protected Member Functions inherited from UNI_ConstItem< UNI_NodeID > | |
| const UNI_ConstGraphHandle & | graphHandle () const |
| Returns the underlying graph handle. More... | |
Definition at line 127 of file UNI_Node.h.
| UNI_NodeID UNI_Node::createNode | ( | const UT_StringHolder & | node_name, |
| const UT_StringHolder & | node_type_name, | ||
| const UT_StringHolder & | signature_name = UT_StringHolder() |
||
| ) | const |
Create a new child node.
| UNI_StickyNoteID UNI_Node::createStickyNote | ( | const UT_StringHolder & | name | ) | const |
Create a sticky note child.
| UNI_NodeID UNI_Node::createSubnet | ( | const UT_StringHolder & | subnet_node_name, |
| const UNI_PortIDList & | create_input_ports, | ||
| const UNI_PortIDList & | create_output_ports | ||
| ) | const |
Create a new subnet node with a pre-populates its inputs and outputs.
| void UNI_Node::destroy | ( | ) | const |
Destroys this node.
| bool UNI_Node::pasteItems | ( | UNI_NodeIDList & | node_ids, |
| UNI_StickyNoteIDList & | note_ids, | ||
| std::istream & | is, | ||
| UT_StringMap< UT_StringHolder > * | rename_map | ||
| ) |
Paste items into this node from a stream (created by copyItems).
| void UNI_Node::setComment | ( | const UT_StringHolder & | comment | ) | const |
Sets the node comment.
| void UNI_Node::setContainerConnectColor | ( | UNI_ContainerConnectType | contype, |
| const UT_Color & | clr | ||
| ) |
Set the color of the special "connect to my container" UI element in the graph editor when viewing inside this node.
| void UNI_Node::setContainerConnectPosition | ( | UNI_ContainerConnectType | contype, |
| const UT_Vector2D & | pos | ||
| ) |
Set the position of the special "connect to my container" UI element in the graph editor when viewing inside this node.
| void UNI_Node::setName | ( | const UT_StringHolder & | name | ) | const |
Sets the node name.
| void UNI_Node::setParmValue | ( | const UT_StringRef & | parm_name, |
| const UNI_ParmValue & | value | ||
| ) |
Sets a parm value.
| void UNI_Node::setPosition | ( | const UT_Vector2D & | pos | ) | const |
Sets the node position in the graph editor.
| void UNI_Node::setSignature | ( | const UT_StringHolder & | signature_name | ) | const |
Sets the current signature for this node.
| void UNI_Node::setTags | ( | const UT_StringArray & | tags | ) | const |
Sets the node tags.
| void UNI_Node::updateDownstreamPortTypes | ( | bool | update_node | ) | const |
Ensures the node signatures and port types for the downstream nodes are up-to-date. If update_node is true, this node is updated too.
1.8.6 
