Description

This class represents an instance of a VuoNodeClass.

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

See Also: VuoCompilerNode; VuoRendererNode

Public Types
enum	TintColor { TintNone, TintYellow, TintOrange, TintMagenta, TintViolet, TintCyan, TintGreen }
	Possible colors with which the user can tint a node. More...

Public Member Functions
	VuoNode (VuoNodeClass nodeClass, string title, VuoPort refreshPort, VuoPort donePort, vector< VuoPort >inputPorts, vector< VuoPort * > outputPorts, double x=0, double y=0, bool collapsed=false, VuoNode::TintColor tintColor=TintNone)
	Creates a base node instance from a `VuoNodeClass`.

VuoNodeClass *	getNodeClass (void)
	Returns the node class this node is an instance of.

VuoPort *	getInputPortWithName (string portName)
	Returns the input port matching the specified `portName`, if one exists.

VuoPort *	getOutputPortWithName (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.

VuoPort *	getRefreshPort (void)
	Returns the refresh port.

VuoPort *	getDonePort (void)
	Returns the done port.

string	getTitle (void)
	Returns the node instance's title.

void	setTitle (string title)
	Sets the node instance's title.

bool	isTypecastNode (void)
	Returns true if this node is a typecast node.

int	getX (void)
	Returns the x coordinate at which this node instance is drawn in the editor.

void	setX (int x)
	Sets the x coordinate at which this node instance is drawn in the editor.

int	getY (void)
	Returns the y coordinate at which this node instance is drawn in the editor.

void	setY (int y)
	Sets the y coordinate at which this node instance is drawn in the editor.

bool	isCollapsed (void)
	Returns true if this node is to be rendered collapsed against its parent (output) node.

void	setCollapsed (bool collapsed)
	Sets whether this node is to be rendered collapsed against its parent (output) node.

enum TintColor	getTintColor (void)
	Returns this node's tint color.

string	getTintColorGraphvizName (void)
	Returns this node's tint color as a Graphviz color name, or emptystring if there is no tint.

void	setTintColor (enum TintColor tintColor)
	Sets this node's tint color.

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.

VuoCompilerNode *	getCompiler (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.

VuoRendererNode *	getRenderer (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.

Member Enumeration Documentation

enum VuoNode::TintColor

Possible colors with which the user can tint a node.

(Red is reserved for error reporting; Blue is reserved for selection/hovering/highlighting.)

Constructor & Destructor Documentation

VuoNode::VuoNode	(	VuoNodeClass *	nodeClass,
		string	title,
		VuoPort *	refreshPort,
		VuoPort *	donePort,
		vector< VuoPort * >	inputPorts,
		vector< VuoPort * >	outputPorts,
		double	x = `0`,
		double	y = `0`,
		bool	collapsed = `false`,
		VuoNode::TintColor	tintColor = `TintNone`
	)

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

VuoPort * VuoNode::getDonePort ( void )

Returns the done port.

vector< VuoPort * > VuoNode::getInputPorts ( void )

Returns all input ports.

VuoPort * VuoNode::getInputPortWithName ( string portName )

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

Otherwise null.

VuoNodeClass * VuoNode::getNodeClass ( void )

Returns the node class this node is an instance of.

vector< VuoPort * > VuoNode::getOutputPorts ( void )

Returns all output ports.

VuoPort * VuoNode::getOutputPortWithName ( string portName )

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

Otherwise null.

VuoPort * VuoNode::getRefreshPort ( void )

Returns the refresh port.

enum VuoNode::TintColor VuoNode::getTintColor ( void )

Returns this node's tint color.

string VuoNode::getTintColorGraphvizName ( void )

Returns this node's tint color as a Graphviz color name, or emptystring if there is no tint.

string VuoNode::getTitle ( void )

Returns the node instance's title.

See Also: VuoNode::VuoNode

Example:: My Awesome Sum

int VuoNode::getX ( void )

Returns the x coordinate at which this node instance is drawn in the editor.

int VuoNode::getY ( void )

Returns the y coordinate at which this node instance is drawn in the editor.

bool VuoNode::isCollapsed ( void )

Returns true if this node is to be rendered collapsed against its parent (output) node.

bool VuoNode::isTypecastNode ( void )

Returns true if this node is a typecast node.

void VuoNode::print ( void )

Prints info about this node and its ports, for debugging.

void VuoNode::setCollapsed ( bool collapsed )

Sets whether this node is to be rendered collapsed against its parent (output) node.

void VuoNode::setTintColor ( enum TintColor tintColor )

Sets this node's tint color.

void VuoNode::setTitle ( string title )

Sets the node instance's title.

See Also: VuoNode::VuoNode

Example:: My Awesome Sum

void VuoNode::setX ( int x )

Sets the x coordinate at which this node instance is drawn in the editor.

void VuoNode::setY ( int y )

Sets the y coordinate at which this node instance is drawn in the editor.

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

base/VuoNode.hh
base/VuoNode.cc

Description

Public Types

Public Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation