Description

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

Definition at line 22 of file VuoCable.hh.

Public Member Functions
	VuoCable (VuoNode fromNode, VuoPort fromPort, VuoNode toNode, VuoPort toPort, bool addCableToPorts=true)
	Creates a cable from `fromNode's` `fromPort` to `toNode's` `toPort`. More...

VuoNode *	getFromNode (void)
	Returns the node from which this cable is output. More...

VuoPort *	getFromPort (void)
	Returns the port from which this cable is output. More...

VuoNode *	getToNode (void)
	Returns the node to which this cable is input. More...

VuoPort *	getToPort (void)
	Returns the port to which this cable is input. More...

void	setFrom (VuoNode fromNode, VuoPort fromPort)
	Sets the node and port from which this cable is output. More...

void	setTo (VuoNode toNode, VuoPort toPort)
	Sets the node and port to which this cable is input. More...

bool	isPublished (void)
	Returns true if either of the cable's endpoints is an externally visible published port. More...

bool	isPublishedInputCable (void)
	Returns true if this cable has an externally visible published input port as one of its endpoints. More...

bool	isPublishedOutputCable (void)
	Returns true if this cable has an externally visible published output port as one of its endpoints. More...

Public Member Functions inherited from VuoBase< VuoCompilerCable, VuoRendererCable >
	VuoBase (string id)
	Creates a base class. More...

void	setCompiler (VuoCompilerCable *compiler)
	Sets the base class instance's compiler detail class instance. More...

VuoCompilerCable *	getCompiler (void) const
	Returns the base class instance's compiler detail class instance. More...

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

void	setRenderer (VuoRendererCable *renderer)
	Sets the base class instance's renderer detail class instance. More...

VuoRendererCable *	getRenderer (void) const
	Returns the base class instance's renderer detail class instance. More...

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

Constructor & Destructor Documentation

◆ VuoCable()

VuoCable::VuoCable	(	VuoNode *	fromNode,
		VuoPort *	fromPort,
		VuoNode *	toNode,
		VuoPort *	toPort,
		bool	addCableToPorts = `true`
	)

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

Definition at line 16 of file VuoCable.cc.

Member Function Documentation

◆ getFromNode()

VuoNode * VuoCable::getFromNode ( void )

Returns the node from which this cable is output.

Definition at line 37 of file VuoCable.cc.

◆ getFromPort()

VuoPort * VuoCable::getFromPort ( void )

Returns the port from which this cable is output.

Definition at line 45 of file VuoCable.cc.

◆ getToNode()

VuoNode * VuoCable::getToNode ( void )

Returns the node to which this cable is input.

Definition at line 53 of file VuoCable.cc.

◆ getToPort()

VuoPort * VuoCable::getToPort ( void )

Returns the port to which this cable is input.

Definition at line 61 of file VuoCable.cc.

◆ isPublished()

bool VuoCable::isPublished ( void )

Returns true if either of the cable's endpoints is an externally visible published port.

Definition at line 111 of file VuoCable.cc.

◆ isPublishedInputCable()

bool VuoCable::isPublishedInputCable ( void )

Returns true if this cable has an externally visible published input port as one of its endpoints.

Definition at line 119 of file VuoCable.cc.

◆ isPublishedOutputCable()

bool VuoCable::isPublishedOutputCable ( void )

Returns true if this cable has an externally visible published output port as one of its endpoints.

Definition at line 127 of file VuoCable.cc.

◆ setFrom()

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

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

Updates the lists of connected cables maintained internally by this cable's previous and new fromPorts appropriately.

Definition at line 71 of file VuoCable.cc.

◆ setTo()

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

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

Updates the lists of connected cables maintained internally by this cable's previous and new toPorts appropriately.

Definition at line 92 of file VuoCable.cc.

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

base/VuoCable.hh
base/VuoCable.cc