VuoCable Class Reference

Description

Represents a connection from a node's output port to a node's input port.

Public Member Functions
	VuoCable (VuoNode *fromNode, VuoPort *fromPort, VuoNode *toNode, VuoPort *toPort)
	Creates a cable from fromNode's fromPort to toNode's toPort.
VuoNode *	getFromNode (void)
	Returns the node from which this cable is output.
VuoPort *	getFromPort (void)
	Returns the port from which this cable is output.
VuoNode *	getToNode (void)
	Returns the node to which this cable is input.
VuoPort *	getToPort (void)
	Returns the port to which this cable is input.
void	setFrom (VuoNode *fromNode, VuoPort *fromPort)
	Sets the node and port from which this cable is output.
void	setTo (VuoNode *toNode, VuoPort *toPort)
	Sets the node and port to which this cable is input.
bool	isPublishedCable (void)
	Returns a boolean indicating whether this cable has an externally visible published port as one of its endpoints.
bool	isPublishedInputCable (void)
	Returns a boolean indicating whether this cable has an externally visible published input port as one of its endpoints.
bool	isPublishedOutputCable (void)
	Returns a boolean indicating whether this cable has an externally visible published output port as one of its endpoints.
Public Member Functions inherited from VuoBase< VuoCompilerCable, VuoRendererCable >
	VuoBase (string id)
	Creates a VuoCable base class.
void	setCompiler (VuoCompilerCable *compiler)
	Sets the VuoCable base class instance's VuoCompilerCable detail class instance.
VuoCompilerCable *	getCompiler (void) const
	Returns the VuoCable base class instance's VuoCompilerCable detail class instance.
bool	hasCompiler (void) const
	Returns true if this base class instance has a compiler detail.
void	setRenderer (VuoRendererCable *renderer)
	Sets the VuoCable base class instance's VuoRendererCable detail class instance.
VuoRendererCable *	getRenderer (void) const
	Returns the VuoCable base class instance's VuoRendererCable detail class instance.
bool	hasRenderer (void) const
	Returns true if this base class instance has a renderer detail.

Constructor & Destructor Documentation

VuoCable::VuoCable	(	VuoNode *	fromNode,
		VuoPort *	fromPort,
		VuoNode *	toNode,
		VuoPort *	toPort
	)

Creates a cable from fromNode's fromPort to toNode's toPort.

Member Function Documentation

VuoNode * VuoCable::getFromNode

(

void

)

Returns the node from which this cable is output.

VuoPort * VuoCable::getFromPort

(

void

)

Returns the port from which this cable is output.

VuoNode * VuoCable::getToNode

(

void

)

Returns the node to which this cable is input.

VuoPort * VuoCable::getToPort

(

void

)

Returns the port to which this cable is input.

bool VuoCable::isPublishedCable

(

void

)

Returns a boolean indicating whether this cable has an externally visible published port as one of its endpoints.

bool VuoCable::isPublishedInputCable

(

void

)

Returns a boolean indicating whether this cable has an externally visible published input port as one of its endpoints.

bool VuoCable::isPublishedOutputCable

(

void

)

Returns a boolean indicating whether this cable has an externally visible published output port as one of its endpoints.

void VuoCable::setFrom	(	VuoNode *	fromNode,
		VuoPort *	fromPort
	)

Sets the node and port from which this cable is output.

void VuoCable::setTo	(	VuoNode *	toNode,
		VuoPort *	toPort
	)

Sets the node and port to which this cable is input.

---

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

• base/VuoCable.hh
• base/VuoCable.cc