Vuo  0.3
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions | List of all members
VuoNode Class Reference

Description

This class represents an instance of a VuoNodeClass.

There may exist 0 to many VuoNodes for each VuoNodeClass, depending on the graph being processed.

See Also
VuoCompilerNode
VuoRendererNode

Public Member Functions

 VuoNode (VuoNodeClass *nodeClass, string displayName, VuoPort *receptorPort, vector< VuoPort * >inputPorts, vector< VuoPort * > outputPorts, double x, double y)
 Creates a base node instance from a VuoNodeClass.
 
VuoNodeClassgetNodeClass (void)
 Returns the node class this node is an instance of.
 
VuoPortgetInputPortWithName (string portName)
 Returns the input port matching the specified portName, if one exists.
 
VuoPortgetOutputPortWithName (string portName)
 Returns the output port matching the specified portName, if one exists.
 
vector< VuoPort * > getInputPorts (void)
 Returns all input ports.
 
vector< VuoPort * > getOutputPorts (void)
 Returns all output ports.
 
VuoPortgetReceptorPort (void)
 Returns the receptor port.
 
string getDisplayName (void)
 Returns the node instance's display name.
 
void setDisplayName (string displayName)
 Sets the node instance's display name.
 
string getGraphvizName (void)
 Returns the node instance's Graphviz name.
 
void setGraphvizName (string graphvizName)
 Sets the node instance's Graphviz name.
 
bool isTypecastNode (void)
 Returns true if this node is a typecast node.
 
double getX (void)
 Returns the x coordinate at which this node instance is drawn in the editor.
 
void setX (double x)
 Sets the x coordinate at which this node instance is drawn in the editor.
 
double getY (void)
 Returns the y coordinate at which this node instance is drawn in the editor.
 
void setY (double y)
 Sets the y coordinate at which this node instance is drawn in the editor.
 
bool getHadStoredCoords ()
 Returns a boolean indicating whether this node had coordinates specified in a graph file.
 
void setHadStoredCoords (bool stored)
 Sets the boolean indicating whether this node had coordinates specified in a graph file.
 
void print (void)
 Prints info about this node and its ports, for debugging.
 
- Public Member Functions inherited from VuoBase< VuoCompilerNode, VuoRendererNode >
 VuoBase (string id)
 Creates a VuoNode base class.
 
void setCompiler (VuoCompilerNode *compiler)
 Sets the VuoNode base class instance's VuoCompilerNode detail class instance.
 
VuoCompilerNodegetCompiler (void) const
 Returns the VuoNode base class instance's VuoCompilerNode detail class instance.
 
bool hasCompiler (void) const
 Returns true if this base class instance has a compiler detail.
 
void setRenderer (VuoRendererNode *renderer)
 Sets the VuoNode base class instance's VuoRendererNode detail class instance.
 
VuoRendererNodegetRenderer (void) const
 Returns the VuoNode base class instance's VuoRendererNode detail class instance.
 
bool hasRenderer (void) const
 Returns true if this base class instance has a renderer detail.
 

Constructor & Destructor Documentation

VuoNode::VuoNode ( VuoNodeClass nodeClass,
string  displayName,
VuoPort receptorPort,
vector< VuoPort * >  inputPorts,
vector< VuoPort * >  outputPorts,
double  x,
double  y 
)

Creates a base node instance from a VuoNodeClass.

You'll probably want to use the factories VuoNodeClass::newNode or VuoCompilerNodeClass::newNode instead, for convenience.

Member Function Documentation

string VuoNode::getDisplayName ( void  )

Returns the node instance's display name.

See Also
VuoNode::VuoNode
Example:
My Awesome Sum
string VuoNode::getGraphvizName ( void  )

Returns the node instance's Graphviz name.

See Also
VuoNode::VuoNode
Example:
MyAwesomeSum
VuoPort * VuoNode::getInputPortWithName ( string  portName)

Returns the input port matching the specified portName, if one exists.

Otherwise null.

VuoPort * VuoNode::getOutputPortWithName ( string  portName)

Returns the output port matching the specified portName, if one exists.

Otherwise null.

void VuoNode::setDisplayName ( string  displayName)

Sets the node instance's display name.

See Also
VuoNode::VuoNode
Example:
My Awesome Sum
void VuoNode::setGraphvizName ( string  graphvizName)

Sets the node instance's Graphviz name.

See Also
VuoNode::VuoNode
Example:
MyAwesomeSum

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