Main Page | Compound List | Compound Members

VUEFunctionGraph Class Reference


Your Ad Here


List of all members.

Public Member Functions

int AddNode (int nodeID)
 Adds a node, given a node ID. Returns the index of the newly created node.
None ConnectNodes (int inNodeNum, int outNum, int outNodeNum, int inNum)
 Connects the output of a node to the input of another node. Note that more than one node can be connected to an output, but only one node can be connected to an input.
int CountNodeInputs (int nodeNum)
 Returns the number of inputs of a node.
int CountNodeOutputs (int nodeNum)
 Returns the number of outputs of a node.
int CountNodeParameters (int nodeNum)
 Returns the number of parameters for a given node.
int CountNodes ()
 Returns the number of nodes in the graph.
function GetNodeParameter (int nodeNum, int paramNum)
 Returns the value of a parameter.
str GetNodeParameterName (int nodeNum, int paramNum)
 Returns the name of a parameter.
function InputConnection (int nodeNum, int inNum)
 If a node is connected to the specified input of the given node, returns a pair with the number of the node, and the number of the output of the node that is connected. If no node is connected, returns None.
int NodeByTitle (str title)
 Returns the index of the first node with the given title. An error is thrown if no such node exists.
str NodeDescription (int nodeNum)
 Returns the description of a given node.
int NodeID (int nodeNum)
 Returns the ID of a given node. The node ID is a unique identifier for a node kind.
str NodeInputName (int nodeNum, int inNum)
 Returns the name of a node input.
str NodeName (int nodeNum)
 Returns the name of a given node.
str NodeOutputName (int nodeNum, int outNum)
 Returns the name of a node output.
str NodeTitle (int nodeNum)
 Returns the title of a given node.
function OutputConnections (int nodeNum, int outNum)
 Returns a list of connections on the given output. For each connection, a pair indicates the number of the node, and the number of the input which is connected.
None RemoveNode (int nodeNum)
 Removes the given node.
None SetNodeDescription (int nodeNum, str descr)
 Sets the description of a given node.
None SetNodeParameter (int nodeNum, int paramNum, function param)
 Changes the value of a parameter. Color and vector parameters are specified as tuples. For the filter, colormap and image parameters, a filename is expected.
None SetNodeTitle (int nodeNum, str title)
 Sets the title of a given node.

Member Function Documentation

int AddNode int  nodeID  ) 
 

Adds a node, given a node ID. Returns the index of the newly created node.

None ConnectNodes int  inNodeNum,
int  outNum,
int  outNodeNum,
int  inNum
 

Connects the output of a node to the input of another node. Note that more than one node can be connected to an output, but only one node can be connected to an input.

int CountNodeInputs int  nodeNum  ) 
 

Returns the number of inputs of a node.

int CountNodeOutputs int  nodeNum  ) 
 

Returns the number of outputs of a node.

int CountNodeParameters int  nodeNum  ) 
 

Returns the number of parameters for a given node.

int CountNodes  ) 
 

Returns the number of nodes in the graph.

function GetNodeParameter int  nodeNum,
int  paramNum
 

Returns the value of a parameter.

str GetNodeParameterName int  nodeNum,
int  paramNum
 

Returns the name of a parameter.

function InputConnection int  nodeNum,
int  inNum
 

If a node is connected to the specified input of the given node, returns a pair with the number of the node, and the number of the output of the node that is connected. If no node is connected, returns None.

int NodeByTitle str  title  ) 
 

Returns the index of the first node with the given title. An error is thrown if no such node exists.

str NodeDescription int  nodeNum  ) 
 

Returns the description of a given node.

int NodeID int  nodeNum  ) 
 

Returns the ID of a given node. The node ID is a unique identifier for a node kind.

str NodeInputName int  nodeNum,
int  inNum
 

Returns the name of a node input.

str NodeName int  nodeNum  ) 
 

Returns the name of a given node.

str NodeOutputName int  nodeNum,
int  outNum
 

Returns the name of a node output.

str NodeTitle int  nodeNum  ) 
 

Returns the title of a given node.

function OutputConnections int  nodeNum,
int  outNum
 

Returns a list of connections on the given output. For each connection, a pair indicates the number of the node, and the number of the input which is connected.

None RemoveNode int  nodeNum  ) 
 

Removes the given node.

None SetNodeDescription int  nodeNum,
str  descr
 

Sets the description of a given node.

None SetNodeParameter int  nodeNum,
int  paramNum,
function  param
 

Changes the value of a parameter. Color and vector parameters are specified as tuples. For the filter, colormap and image parameters, a filename is expected.

None SetNodeTitle int  nodeNum,
str  title
 

Sets the title of a given node.


Generated using doxygen on Wed Nov 29 17:50:19 2006.
©2003 e-on software, inc. All rights reserved.

Return to Vue Index


Your Ad Here