VOP_NodeParmManager Class Reference

#include <VOP_NodeParmManager.h>

Public Member Functions
	VOP_NodeParmManager (VOP_Language *language)
	Constructor. More...
int	getNumParmTypes () const
	Returns the number of parameters and parameter types known to manager. More...
int	getTypeSize (VOP_Type voptype) const
bool	allowsMenu (int idx) const
	Returns true if parameter allows a drop down menu. More...
VOP_Type	getParmType (int idx) const
	Returns the basic info about the i-th parameter. More...
VOP_Type	getUnconditionedParmType (int idx) const
	Returns the basic info about the i-th parameter. More...
const char *	getParmName (int idx) const
	Returns the basic info about the i-th parameter. More...
int	getParmIndex (VOP_Type type) const
	Find parameter index based on VOP data type. More...
int	findUnconditionedParmIndex (VOP_Type type) const
	Find parameter index based on VOP data type. More...
int	guessParmIndex (VOP_Type voptype, PRM_Type parmtype, int size) const
	Find parameter index based on VOP data type. More...
void	fillSwitcherTemplate (PRM_Template *tplate, bool with_ranges) const
	Methods for obtaining PRM information for a i-th parameter. More...
void	fillParmTemplate (int idx, PRM_Template *tplate) const
	Methods for obtaining PRM information for a i-th parameter. More...
int	fillDialogScript (int idx, UT_String &ds_type, int &ds_size) const
	Methods for obtaining PRM information for a i-th parameter. More...
int	fillVexPragma (int idx, UT_String &vex_pragma) const
	Methods for obtaining PRM information for a i-th parameter. More...
bool	fillParmOpFilter (int idx, UT_String &op_filter, UT_String &op_relative) const
	Methods for obtaining PRM information for a i-th parameter. More...
bool	isSingleFloatParmIndex (int idx) const
	Checks the data type of i-th parameter. More...
bool	isSingleIntParmIndex (int idx) const
	Checks the data type of i-th parameter. More...
bool	isPossibleOpListIndex (int idx) const
	Checks the data type of i-th parameter. More...
PRM_ChoiceList *	getParmTypeMenu () const
	Obtains PRM menu with parameter types. More...
PRM_ChoiceList *	getParmTypeNameMenu () const
	Obtains PRM menu with parameter types. More...
bool	supportsUniformVarying () const
	Tests uniform-varying type. More...
bool	isParameterUniformVarying (int idx) const
	Tests uniform-varying type. More...
const char *	getParameterOpName (const VOP_TypeInfo &t) const
	Returns the node operator name for parameters and constants. More...
const char *	getConstantOpName () const
	Returns the node operator name for parameters and constants. More...

Detailed Description

Class for providing information about node parameters that correspond to VOP data types. This manager maps VOP_Type to an appropriate PRM parameter on a node, essentially describing the parameter UI.

Definition at line 28 of file VOP_NodeParmManager.h.

Constructor & Destructor Documentation

VOP_NodeParmManager::VOP_NodeParmManager

(

VOP_Language *

language

)

Constructor.

Member Function Documentation

bool VOP_NodeParmManager::allowsMenu

(

int

idx

)

const

Returns true if parameter allows a drop down menu.

int VOP_NodeParmManager::fillDialogScript	(	int	idx,
		UT_String &	ds_type,
		int &	ds_size
	)		const

Methods for obtaining PRM information for a i-th parameter.

bool VOP_NodeParmManager::fillParmOpFilter	(	int	idx,
		UT_String &	op_filter,
		UT_String &	op_relative
	)		const

Methods for obtaining PRM information for a i-th parameter.

void VOP_NodeParmManager::fillParmTemplate	(	int	idx,
		PRM_Template *	tplate
	)		const

Methods for obtaining PRM information for a i-th parameter.

void VOP_NodeParmManager::fillSwitcherTemplate	(	PRM_Template *	tplate,
		bool	with_ranges
	)		const

Methods for obtaining PRM information for a i-th parameter.

int VOP_NodeParmManager::fillVexPragma	(	int	idx,
		UT_String &	vex_pragma
	)		const

Methods for obtaining PRM information for a i-th parameter.

int VOP_NodeParmManager::findUnconditionedParmIndex

(

VOP_Type

type

)

const

Find parameter index based on VOP data type.

const char* VOP_NodeParmManager::getConstantOpName

(

)

const

Returns the node operator name for parameters and constants.

int VOP_NodeParmManager::getNumParmTypes

(

)

const

Returns the number of parameters and parameter types known to manager.

const char* VOP_NodeParmManager::getParameterOpName

(

const VOP_TypeInfo &

t

)

const

Returns the node operator name for parameters and constants.

int VOP_NodeParmManager::getParmIndex

(

VOP_Type

type

)

const

Find parameter index based on VOP data type.

const char* VOP_NodeParmManager::getParmName

(

int

idx

)

const

Returns the basic info about the i-th parameter.

VOP_Type VOP_NodeParmManager::getParmType

(

int

idx

)

const

Returns the basic info about the i-th parameter.

PRM_ChoiceList* VOP_NodeParmManager::getParmTypeMenu

(

)

const

Obtains PRM menu with parameter types.

PRM_ChoiceList* VOP_NodeParmManager::getParmTypeNameMenu

(

)

const

Obtains PRM menu with parameter types.

int VOP_NodeParmManager::getTypeSize

(

VOP_Type

voptype

)

const

Returns the approximate number of fields in a type. For example, for float returns 1, for color 3. For arrays and strings returns 1.

VOP_Type VOP_NodeParmManager::getUnconditionedParmType

(

int

idx

)

const

Returns the basic info about the i-th parameter.

int VOP_NodeParmManager::guessParmIndex	(	VOP_Type	voptype,
		PRM_Type	parmtype,
		int	size
	)		const

Find parameter index based on VOP data type.

bool VOP_NodeParmManager::isParameterUniformVarying

(

int

idx

)

const

Tests uniform-varying type.

bool VOP_NodeParmManager::isPossibleOpListIndex

(

int

idx

)

const

Checks the data type of i-th parameter.

bool VOP_NodeParmManager::isSingleFloatParmIndex

(

int

idx

)

const

Checks the data type of i-th parameter.

bool VOP_NodeParmManager::isSingleIntParmIndex

(

int

idx

)

const

Checks the data type of i-th parameter.

bool VOP_NodeParmManager::supportsUniformVarying

(

)

const

Tests uniform-varying type.

---

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

• VOP/VOP_NodeParmManager.h