Description

A collection of nodes and the cables connecting them.

Public Member Functions
	VuoComposition (void)
	Creates an empty composition.

void	setName (string name)
	Sets the composition's display name.

string	getName (void)
	Returns the composition's display name.

void	setDirectory (string directory)
	Sets the directory containing the composition's .vuo source file.

string	getDirectory (void)
	Returns the directory containing the composition's .vuo source file.

void	setDescription (string description)
	Sets the composition's description (documentation).

string	getDescription (void)
	Returns the composition's description (documentation).

void	setCopyright (string copyright)
	Sets the composition's copyright.

string	getCopyright (void)
	Returns the composition's copyright.

void	addNode (VuoNode *node)
	Adds a node to the composition.

void	removeNode (VuoNode *node)
	Removes a node from the composition.

void	replaceNode (VuoNode oldNode, VuoNode newNode)
	Replaces oldNode with newNode in the composition, transferring all cable and published port connections from oldNode to newNode.

set< VuoNode * >	getNodes (void)
	Returns the nodes in this composition.

void	addCable (VuoCable *cable)
	Adds a cable to the composition.

void	removeCable (VuoCable *cable)
	Disconnects and removes a cable from the composition.

set< VuoCable * >	getCables (void)
	Returns the cables in this composition.

void	addPublishedInputCable (VuoCable *cable)
	Adds a published input cable to the composition.

void	removePublishedInputCable (VuoCable *cable)
	Disconnects and removes a published input cable from the composition.

set< VuoCable * >	getPublishedInputCables (void)
	Returns the psuedo-cables attached to the output ports of the published input pseudo-node, if any.

void	addPublishedOutputCable (VuoCable *cable)
	Adds a published output cable to the composition.

void	removePublishedOutputCable (VuoCable *cable)
	Disconnects and removes a published output cable from the composition.

set< VuoCable * >	getPublishedOutputCables (void)
	Returns the psuedo-cables attached to the input ports of the published output pseudo-node, if any.

void	addPublishedInputPort (VuoPublishedPort *port, int index)
	Adds a published port to this composition's list of published input ports at the given index.

void	addPublishedOutputPort (VuoPublishedPort *port, int index)
	Adds a published port to this composition's list of published output ports at the given index.

void	removePublishedInputPort (int index)
	Removes the published port at the given index from this composition's list of published input ports.

void	removePublishedOutputPort (int index)
	Removes the published port at the given index from this composition's list of published input ports.

vector< VuoPublishedPort * >	getPublishedInputPorts (void)
	Returns the published input ports in this composition.

vector< VuoPublishedPort * >	getPublishedOutputPorts (void)
	Returns the published output ports in this composition.

VuoPublishedPort *	getPublishedInputPortWithName (string name)
	Returns the published input port with the given name, or null if none matches.

VuoPublishedPort *	getPublishedOutputPortWithName (string name)
	Returns the published output port with the given name, or null if none matches.

set< VuoPublishedPort * >	getPublishedInputPortsConnectedToPort (VuoPort *port)
	Returns the set of published input ports connected to the given port.

set< VuoPublishedPort * >	getPublishedOutputPortsConnectedToPort (VuoPort *port)
	Returns the set of published output ports connected to the given port.

set< pair< VuoPublishedPort , VuoPort > >	getPublishedInputPortsConnectedToNode (VuoNode *node)
	Returns the set of published input ports connected to the node, and the port on the node to which each is connected.

set< pair< VuoPublishedPort , VuoPort > >	getPublishedOutputPortsConnectedToNode (VuoNode *node)
	Returns the set of published output ports connected to the node, and the port on the node to which each is connected.

int	getIndexOfPublishedPort (VuoPublishedPort *port, bool isInput)
	Returns the index of the published port in the list of published input or output ports.

Public Member Functions inherited from VuoBase< VuoCompilerComposition, VuoRendererComposition >
	VuoBase (string id)
	Creates a VuoComposition base class.

void	setCompiler (VuoCompilerComposition *compiler)
	Sets the VuoComposition base class instance's VuoCompilerComposition detail class instance.

VuoCompilerComposition *	getCompiler (void) const
	Returns the VuoComposition base class instance's VuoCompilerComposition detail class instance.

bool	hasCompiler (void) const
	Returns true if this base class instance has a compiler detail.

void	setRenderer (VuoRendererComposition *renderer)
	Sets the VuoComposition base class instance's VuoRendererComposition detail class instance.

VuoRendererComposition *	getRenderer (void) const
	Returns the VuoComposition base class instance's VuoRendererComposition detail class instance.

bool	hasRenderer (void) const
	Returns true if this base class instance has a renderer detail.

Static Public Member Functions
static void	parseHeader (const string &compositionAsString, string &name, string &description, string &copyright)
	Parses the composition's Doxygen header to retrieve its name, description, and copyright.

Constructor & Destructor Documentation

VuoComposition::VuoComposition ( void )

Creates an empty composition.

Member Function Documentation

void VuoComposition::addCable ( VuoCable * cable )

Adds a cable to the composition.

The caller is responsible for adding the nodes on either end of the cable to the composition.

void VuoComposition::addNode ( VuoNode * node )

Adds a node to the composition.

void VuoComposition::addPublishedInputCable ( VuoCable * cable )

Adds a published input cable to the composition.

The caller is responsible for adding the cable's "To" node to the composition.

void VuoComposition::addPublishedInputPort	(	VuoPublishedPort *	port,
		int	index
	)

Adds a published port to this composition's list of published input ports at the given index.

void VuoComposition::addPublishedOutputCable ( VuoCable * cable )

Adds a published output cable to the composition.

The caller is responsible for adding the cable's "From" node to the composition.

void VuoComposition::addPublishedOutputPort	(	VuoPublishedPort *	port,
		int	index
	)

Adds a published port to this composition's list of published output ports at the given index.

set< VuoCable * > VuoComposition::getCables ( void )

Returns the cables in this composition.

string VuoComposition::getCopyright ( void )

Returns the composition's copyright.

string VuoComposition::getDescription ( void )

Returns the composition's description (documentation).

string VuoComposition::getDirectory ( void )

Returns the directory containing the composition's .vuo source file.

int VuoComposition::getIndexOfPublishedPort	(	VuoPublishedPort *	port,
		bool	isInput
	)

Returns the index of the published port in the list of published input or output ports.

string VuoComposition::getName ( void )

Returns the composition's display name.

set< VuoNode * > VuoComposition::getNodes ( void )

Returns the nodes in this composition.

set< VuoCable * > VuoComposition::getPublishedInputCables ( void )

Returns the psuedo-cables attached to the output ports of the published input pseudo-node, if any.

vector< VuoPublishedPort * > VuoComposition::getPublishedInputPorts ( void )

Returns the published input ports in this composition.

set< pair< VuoPublishedPort *, VuoPort * > > VuoComposition::getPublishedInputPortsConnectedToNode ( VuoNode * node )

Returns the set of published input ports connected to the node, and the port on the node to which each is connected.

set< VuoPublishedPort * > VuoComposition::getPublishedInputPortsConnectedToPort ( VuoPort * port )

Returns the set of published input ports connected to the given port.

VuoPublishedPort * VuoComposition::getPublishedInputPortWithName ( string name )

Returns the published input port with the given name, or null if none matches.

set< VuoCable * > VuoComposition::getPublishedOutputCables ( void )

Returns the psuedo-cables attached to the input ports of the published output pseudo-node, if any.

vector< VuoPublishedPort * > VuoComposition::getPublishedOutputPorts ( void )

Returns the published output ports in this composition.

set< pair< VuoPublishedPort *, VuoPort * > > VuoComposition::getPublishedOutputPortsConnectedToNode ( VuoNode * node )

Returns the set of published output ports connected to the node, and the port on the node to which each is connected.

set< VuoPublishedPort * > VuoComposition::getPublishedOutputPortsConnectedToPort ( VuoPort * port )

Returns the set of published output ports connected to the given port.

VuoPublishedPort * VuoComposition::getPublishedOutputPortWithName ( string name )

Returns the published output port with the given name, or null if none matches.

void VuoComposition::parseHeader	(	const string &	compositionAsString,
		string &	name,
		string &	description,
		string &	copyright
	)

static

Parses the composition's Doxygen header to retrieve its name, description, and copyright.

If a Doxygen line starts ``, the name is the remainder of that line.

If a Doxygen line starts @copyright, the copyright is the remainder of that paragraph.

The remaining Doxygen lines are the description.

void VuoComposition::removeCable ( VuoCable * cable )

Disconnects and removes a cable from the composition.

void VuoComposition::removeNode ( VuoNode * node )

Removes a node from the composition.

The caller is responsible for removing any cables attached to the node.

void VuoComposition::removePublishedInputCable ( VuoCable * cable )

Disconnects and removes a published input cable from the composition.

void VuoComposition::removePublishedInputPort ( int index )

Removes the published port at the given index from this composition's list of published input ports.

void VuoComposition::removePublishedOutputCable ( VuoCable * cable )

Disconnects and removes a published output cable from the composition.

void VuoComposition::removePublishedOutputPort ( int index )

Removes the published port at the given index from this composition's list of published input ports.

void VuoComposition::replaceNode	(	VuoNode *	oldNode,
		VuoNode *	newNode
	)

Replaces oldNode with newNode in the composition, transferring all cable and published port connections from oldNode to newNode.

void VuoComposition::setCopyright ( string copyright )

Sets the composition's copyright.

void VuoComposition::setDescription ( string description )

Sets the composition's description (documentation).

void VuoComposition::setDirectory ( string directory )

Sets the directory containing the composition's .vuo source file.

void VuoComposition::setName ( string name )

Sets the composition's display name.

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

base/VuoComposition.hh
base/VuoComposition.cc

Description

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation