Tool Class Reference

Public Member Functions
string	category (void)
string	uuid (void)
string	caption (void)
ParameterContainer *	paramContainer (NodeGraphList &graphList)
void	execute (NodeGraphList &graphList, ParameterContainer &pc)

Detailed Description

The Tool class represents a tool available to RaySupreme to modify or create NodeGraph's and their Mesh. Tools are available to RaySupreme inside the Tool Browser and can also be addressed via Scripts. Actually Tools can also be script based. However, inside the Script API, only tools are available which do not require User Interface interaction but only set their Parameters via a ParameterContainer. A tool is uniquely identified by it's uuid.

Member Function Documentation

string Tool::caption

(

void

)

Returns a descriptive caption for the tool.

Returns

The descriptive caption of the tool.

string Tool::category

(

void

)

Returns the category of the tool, this is not a unique identifier but rather defines the general class of functions this tool provides.

Returns

The category for this tool.

void Tool::execute	(	NodeGraphList &	graphList,
		ParameterContainer &	pc
	)

Executes the tool on the NodeGraphs in the list using the attributes of the given ParameterContainer.

Parameters

graphList	The list of NodeGraph's on which this tool should be applied.
pc	The ParameterContainer previously retrived (and maybe modified) via paramContainer().

ParameterContainer* Tool::paramContainer

(

NodeGraphList &

graphList)

Returns the ParameterContainer of this tool. You can modify the Parameters of the Container and pass it to the execute() function.

Parameters

graphList

The list of NodeGraph's for which the ParameterContainer should be generated.

Returns

The ParameterContainer of the Tool for the given set of NodeGraphs.

string Tool::uuid

(

void

)

Returns the uuid of this tool. The uuid is used to uniquely identify each tool.

Returns

The uuid of the tool.