PI_EditScriptedParm Class Reference

#include <PI_EditScriptedParms.h>

List of all members.

Classes

class PI_ParmType

Public Member Functions

PI_EditScriptedParm ()

PI_EditScriptedParm (const PRM_Template &tplate, OP_Node *node, bool init_auto_links=true)

PI_EditScriptedParm (PI_EditScriptedParmFolderType ftype)

PI_EditScriptedParm (const PI_EditScriptedParm &src)

~PI_EditScriptedParm ()

void setType (const char *type)

const UT_String & getType () const

void changeTypeToRampColor ()

void changeTypeToRampFloat ()

void copyDefaultValuesFromParm (PRM_Parm *parm, int subidx)

void setAutolinksToCurrentLinks (OP_Node *node, int subidx)

void addParametersToAutolink (const UT_StringArray &parms, const char *nodepath, bool linkinvisibles, PI_EditScriptedParms *owner, UT_StringArray &errors)

void setRange (const PRM_Range &range)

int save (ostream &os, int indent, OP_Operator *op, const PI_EditScriptedParm *nextparm, bool in_import_block)

int saveSelectors (ostream &os, const char *tokeni, OP_Operator *op)

void saveSpareData (ostream &os, const char *tokeni, bool skip_import_data)

void saveSpareValue (ostream &os, const char *tokeni, const char *spare_token)

void dump (ostream &os)

int getNMenu () const

void addMenu (const char *token=0, const char *label=0)

void moveMenu (int idx)

void destroyMenu (int idx)

int checkNullMenu ()

void clearMenuItems ()

void setMenu (const PRM_ChoiceList *menu, bool minimenu)

int getParmTypeIdxForChannels () const

void setSize (int size)

void buildChannelNames (UT_StringArray &ch) const

const UT_PtrArray< const char * > & getChannelNames () const

void extractGroupSpareData (const PRM_SpareData *ref, int index)

void mergeSpareData (const PRM_SpareData *srcsparedata)

const char * getSpareValue (const char *token) const

void setSpareValue (const char *token, const char *value)

void copySpareValue (const char *token, const PRM_SpareData &ref)

const char * getCallbackData () const

void setCallbackData (const char *value)

CH_ScriptLanguage getCallbackLanguage () const

void setCallbackLanguage (CH_ScriptLanguage language)

const char * getOpFilter () const

void setOpFilter (const char *value)

void setOpFilter (const PRM_SpareData *spareptr)

const char * getRManType () const

void setRManType (const char *value)

int getMultiStartOffset () const

void setMultiStartOffset (int value)

void setRampColorType (UT_ColorType color_type)

UT_ColorType getRampColorType () const

const char * getRampBasisVar () const

void setRampBasisVar (const char *value)

const char * getRampKeysVar () const

void setRampKeysVar (const char *value)

const char * getRampValuesVar () const

void setRampValuesVar (const char *value)

const char * getImportSource () const

void setImportSource (const char *value)

const char * getImportToken () const

void setImportToken (const char *value)

const char * getImportMask () const

void setImportMask (const char *value)

bool getImportEnable () const

void setImportEnable (bool value)

bool getExportDisable () const

void setExportDisable (bool value)

bool getUnquotedFlag () const

void setUnquotedFlag (bool value)

bool getIsGroupStart () const

bool getIsGroupEnd () const

bool getIsGroupParm () const

bool getIsMultiParm () const

bool getIsRampParm () const

bool getIsRampParmColor () const

bool getIsRampParmFloat () const

bool getIsFileParm () const

bool getIsBasicStringParm () const

const char * getRampBasisDefault () const

void setRampBasisDefault (const char *value)

bool getRampShowControlsDefault () const

void setRampShowControlsDefault (bool value)

void clearRampDefaults ()

const char * getFileChooserMode () const

void setFileChooserMode (const char *value)

Static Public Member Functions

static const char * getScriptType (const PRM_Type &ptype, PRM_TypeExtended etype, PRM_MultiType mtype, int size)

static bool parmTypeUsesOpFilter (const char *type)

static const char * getExportDisableToken ()

Public Attributes

UT_String myName

UT_String myLabel

bool myUseLabel

UT_String myClass

UT_String myCategory

int myGroupID

bool myInvisible

int myExport

int mySize

UT_String myDefaults [PI_MAX_SCRIPT_PARM_SIZE]

CH_ExprLanguage myDefaultExprLanguage

int myRangeEnable

float myRange [2]

bool myRangeLock [2]

PI_EditScriptedParmMenuEnable myMenuEnable

PI_EditScriptedParmMenuType myMenuType

PI_EditScriptedParmFolderType myFolderType

UT_String myMenuScript

CH_ScriptLanguage myMenuScriptLanguage

int myDoAutolink [PI_MAX_SCRIPT_PARM_SIZE]

UT_String myAutolink [PI_MAX_SCRIPT_PARM_SIZE]

UT_String myOldAutolink [PI_MAX_SCRIPT_PARM_SIZE]

UT_String myDisable

UT_String myHelpText

UT_PtrArray
< PI_EditScriptedParmMenu * > myMenu

PRM_SpareData * mySpareData

bool myJoinNextFlag

bool myTabBreak

bool myReserved

Static Public Attributes

static PI_ParmType theParmTypes []

Detailed Description

Definition at line 84 of file PI_EditScriptedParms.h.

Constructor & Destructor Documentation

PI_EditScriptedParm::PI_EditScriptedParm ( )

PI_EditScriptedParm::PI_EditScriptedParm	(	const PRM_Template &	tplate,
		OP_Node *	node,
		bool	init_auto_links = `true`
	)

PI_EditScriptedParm::PI_EditScriptedParm ( PI_EditScriptedParmFolderType ftype )

PI_EditScriptedParm::PI_EditScriptedParm ( const PI_EditScriptedParm & src )

PI_EditScriptedParm::~PI_EditScriptedParm ( )

Member Function Documentation

void PI_EditScriptedParm::addMenu	(	const char *	token = `0`,
		const char *	label = `0`
	)

void PI_EditScriptedParm::addParametersToAutolink	(	const UT_StringArray &	parms,
		const char *	nodepath,
		bool	linkinvisibles,
		PI_EditScriptedParms *	owner,
		UT_StringArray &	errors
	)

void PI_EditScriptedParm::buildChannelNames ( UT_StringArray & ch ) const

void PI_EditScriptedParm::changeTypeToRampColor ( )

void PI_EditScriptedParm::changeTypeToRampFloat ( )

int PI_EditScriptedParm::checkNullMenu ( )

void PI_EditScriptedParm::clearMenuItems ( )

void PI_EditScriptedParm::clearRampDefaults ( )

void PI_EditScriptedParm::copyDefaultValuesFromParm	(	PRM_Parm *	parm,
		int	subidx
	)

void PI_EditScriptedParm::copySpareValue	(	const char *	token,
		const PRM_SpareData &	ref
	)

void PI_EditScriptedParm::destroyMenu ( int idx )

void PI_EditScriptedParm::dump ( ostream & os )

void PI_EditScriptedParm::extractGroupSpareData	(	const PRM_SpareData *	ref,
		int	index
	)

const char* PI_EditScriptedParm::getCallbackData ( ) const

CH_ScriptLanguage PI_EditScriptedParm::getCallbackLanguage ( ) const

const UT_PtrArray<const char *>& PI_EditScriptedParm::getChannelNames ( ) const

bool PI_EditScriptedParm::getExportDisable ( ) const

static const char* PI_EditScriptedParm::getExportDisableToken ( ) [static]

const char* PI_EditScriptedParm::getFileChooserMode ( ) const

bool PI_EditScriptedParm::getImportEnable ( ) const

const char* PI_EditScriptedParm::getImportMask ( ) const

const char* PI_EditScriptedParm::getImportSource ( ) const

const char* PI_EditScriptedParm::getImportToken ( ) const

bool PI_EditScriptedParm::getIsBasicStringParm ( ) const

bool PI_EditScriptedParm::getIsFileParm ( ) const

bool PI_EditScriptedParm::getIsGroupEnd ( ) const

bool PI_EditScriptedParm::getIsGroupParm ( ) const

bool PI_EditScriptedParm::getIsGroupStart ( ) const

bool PI_EditScriptedParm::getIsMultiParm ( ) const

bool PI_EditScriptedParm::getIsRampParm ( ) const

bool PI_EditScriptedParm::getIsRampParmColor ( ) const

bool PI_EditScriptedParm::getIsRampParmFloat ( ) const

int PI_EditScriptedParm::getMultiStartOffset ( ) const

int PI_EditScriptedParm::getNMenu ( ) const [inline]

Definition at line 140 of file PI_EditScriptedParms.h.

const char* PI_EditScriptedParm::getOpFilter ( ) const

int PI_EditScriptedParm::getParmTypeIdxForChannels ( ) const

const char* PI_EditScriptedParm::getRampBasisDefault ( ) const

const char* PI_EditScriptedParm::getRampBasisVar ( ) const

UT_ColorType PI_EditScriptedParm::getRampColorType ( ) const

const char* PI_EditScriptedParm::getRampKeysVar ( ) const

bool PI_EditScriptedParm::getRampShowControlsDefault ( ) const

const char* PI_EditScriptedParm::getRampValuesVar ( ) const

const char* PI_EditScriptedParm::getRManType ( ) const

static const char* PI_EditScriptedParm::getScriptType	(	const PRM_Type &	ptype,
		PRM_TypeExtended	etype,
		PRM_MultiType	mtype,
		int	size
	)			`[static]`

const char* PI_EditScriptedParm::getSpareValue ( const char * token ) const

const UT_String& PI_EditScriptedParm::getType ( void ) const [inline]

Definition at line 99 of file PI_EditScriptedParms.h.

bool PI_EditScriptedParm::getUnquotedFlag ( ) const

void PI_EditScriptedParm::mergeSpareData ( const PRM_SpareData * srcsparedata )

void PI_EditScriptedParm::moveMenu ( int idx )

static bool PI_EditScriptedParm::parmTypeUsesOpFilter ( const char * type ) [static]

int PI_EditScriptedParm::save	(	ostream &	os,
		int	indent,
		OP_Operator *	op,
		const PI_EditScriptedParm *	nextparm,
		bool	in_import_block
	)

int PI_EditScriptedParm::saveSelectors	(	ostream &	os,
		const char *	tokeni,
		OP_Operator *	op
	)

void PI_EditScriptedParm::saveSpareData	(	ostream &	os,
		const char *	tokeni,
		bool	skip_import_data
	)

void PI_EditScriptedParm::saveSpareValue	(	ostream &	os,
		const char *	tokeni,
		const char *	spare_token
	)

void PI_EditScriptedParm::setAutolinksToCurrentLinks	(	OP_Node *	node,
		int	subidx
	)

void PI_EditScriptedParm::setCallbackData ( const char * value )

void PI_EditScriptedParm::setCallbackLanguage ( CH_ScriptLanguage language )

void PI_EditScriptedParm::setExportDisable ( bool value )

void PI_EditScriptedParm::setFileChooserMode ( const char * value )

void PI_EditScriptedParm::setImportEnable ( bool value )

void PI_EditScriptedParm::setImportMask ( const char * value )

void PI_EditScriptedParm::setImportSource ( const char * value )

void PI_EditScriptedParm::setImportToken ( const char * value )

void PI_EditScriptedParm::setMenu	(	const PRM_ChoiceList *	menu,
		bool	minimenu
	)

void PI_EditScriptedParm::setMultiStartOffset ( int value )

void PI_EditScriptedParm::setOpFilter ( const PRM_SpareData * spareptr )

void PI_EditScriptedParm::setOpFilter ( const char * value )

void PI_EditScriptedParm::setRampBasisDefault ( const char * value )

void PI_EditScriptedParm::setRampBasisVar ( const char * value )

void PI_EditScriptedParm::setRampColorType ( UT_ColorType color_type )

void PI_EditScriptedParm::setRampKeysVar ( const char * value )

void PI_EditScriptedParm::setRampShowControlsDefault ( bool value )

void PI_EditScriptedParm::setRampValuesVar ( const char * value )

void PI_EditScriptedParm::setRange ( const PRM_Range & range )

void PI_EditScriptedParm::setRManType ( const char * value )

void PI_EditScriptedParm::setSize ( int size )

void PI_EditScriptedParm::setSpareValue	(	const char *	token,
		const char *	value
	)

void PI_EditScriptedParm::setType ( const char * type ) [inline]

Definition at line 94 of file PI_EditScriptedParms.h.

void PI_EditScriptedParm::setUnquotedFlag ( bool value )

Member Data Documentation

UT_String PI_EditScriptedParm::myAutolink[PI_MAX_SCRIPT_PARM_SIZE]

Definition at line 261 of file PI_EditScriptedParms.h.

UT_String PI_EditScriptedParm::myCategory

Definition at line 245 of file PI_EditScriptedParms.h.

UT_String PI_EditScriptedParm::myClass

Definition at line 244 of file PI_EditScriptedParms.h.

CH_ExprLanguage PI_EditScriptedParm::myDefaultExprLanguage

Definition at line 251 of file PI_EditScriptedParms.h.

UT_String PI_EditScriptedParm::myDefaults[PI_MAX_SCRIPT_PARM_SIZE]

Definition at line 250 of file PI_EditScriptedParms.h.

UT_String PI_EditScriptedParm::myDisable

Definition at line 263 of file PI_EditScriptedParms.h.

int PI_EditScriptedParm::myDoAutolink[PI_MAX_SCRIPT_PARM_SIZE]

Definition at line 260 of file PI_EditScriptedParms.h.

int PI_EditScriptedParm::myExport

Definition at line 248 of file PI_EditScriptedParms.h.

PI_EditScriptedParmFolderType PI_EditScriptedParm::myFolderType

Definition at line 257 of file PI_EditScriptedParms.h.

int PI_EditScriptedParm::myGroupID

Definition at line 246 of file PI_EditScriptedParms.h.

UT_String PI_EditScriptedParm::myHelpText

Definition at line 264 of file PI_EditScriptedParms.h.

bool PI_EditScriptedParm::myInvisible

Definition at line 247 of file PI_EditScriptedParms.h.

bool PI_EditScriptedParm::myJoinNextFlag

Definition at line 267 of file PI_EditScriptedParms.h.

UT_String PI_EditScriptedParm::myLabel

Definition at line 242 of file PI_EditScriptedParms.h.

UT_PtrArray<PI_EditScriptedParmMenu *> PI_EditScriptedParm::myMenu

Definition at line 265 of file PI_EditScriptedParms.h.

PI_EditScriptedParmMenuEnable PI_EditScriptedParm::myMenuEnable

Definition at line 255 of file PI_EditScriptedParms.h.

UT_String PI_EditScriptedParm::myMenuScript

Definition at line 258 of file PI_EditScriptedParms.h.

CH_ScriptLanguage PI_EditScriptedParm::myMenuScriptLanguage

Definition at line 259 of file PI_EditScriptedParms.h.

PI_EditScriptedParmMenuType PI_EditScriptedParm::myMenuType

Definition at line 256 of file PI_EditScriptedParms.h.

UT_String PI_EditScriptedParm::myName

Definition at line 241 of file PI_EditScriptedParms.h.

UT_String PI_EditScriptedParm::myOldAutolink[PI_MAX_SCRIPT_PARM_SIZE]

Definition at line 262 of file PI_EditScriptedParms.h.

float PI_EditScriptedParm::myRange[2]

Definition at line 253 of file PI_EditScriptedParms.h.

int PI_EditScriptedParm::myRangeEnable

Definition at line 252 of file PI_EditScriptedParms.h.

bool PI_EditScriptedParm::myRangeLock[2]

Definition at line 254 of file PI_EditScriptedParms.h.

bool PI_EditScriptedParm::myReserved

Definition at line 269 of file PI_EditScriptedParms.h.

int PI_EditScriptedParm::mySize

Definition at line 249 of file PI_EditScriptedParms.h.

PRM_SpareData* PI_EditScriptedParm::mySpareData

Definition at line 266 of file PI_EditScriptedParms.h.

bool PI_EditScriptedParm::myTabBreak

Definition at line 268 of file PI_EditScriptedParms.h.

bool PI_EditScriptedParm::myUseLabel

Definition at line 243 of file PI_EditScriptedParms.h.

PI_ParmType PI_EditScriptedParm::theParmTypes[] [static]

Definition at line 287 of file PI_EditScriptedParms.h.

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

PI/PI_EditScriptedParms.h


Classes
class	PI_ParmType
Public Member Functions
	PI_EditScriptedParm ()
	PI_EditScriptedParm (const PRM_Template &tplate, OP_Node *node, bool init_auto_links=true)
	PI_EditScriptedParm (PI_EditScriptedParmFolderType ftype)
	PI_EditScriptedParm (const PI_EditScriptedParm &src)
	~PI_EditScriptedParm ()
void	setType (const char *type)
const UT_String &	getType () const
void	changeTypeToRampColor ()
void	changeTypeToRampFloat ()
void	copyDefaultValuesFromParm (PRM_Parm *parm, int subidx)
void	setAutolinksToCurrentLinks (OP_Node *node, int subidx)
void	addParametersToAutolink (const UT_StringArray &parms, const char nodepath, bool linkinvisibles, PI_EditScriptedParms owner, UT_StringArray &errors)
void	setRange (const PRM_Range &range)
int	save (ostream &os, int indent, OP_Operator op, const PI_EditScriptedParm nextparm, bool in_import_block)
int	saveSelectors (ostream &os, const char tokeni, OP_Operator op)
void	saveSpareData (ostream &os, const char *tokeni, bool skip_import_data)
void	saveSpareValue (ostream &os, const char tokeni, const char spare_token)
void	dump (ostream &os)
int	getNMenu () const
void	addMenu (const char token=0, const char label=0)
void	moveMenu (int idx)
void	destroyMenu (int idx)
int	checkNullMenu ()
void	clearMenuItems ()
void	setMenu (const PRM_ChoiceList *menu, bool minimenu)
int	getParmTypeIdxForChannels () const
void	setSize (int size)
void	buildChannelNames (UT_StringArray &ch) const
const UT_PtrArray< const char * > &	getChannelNames () const
void	extractGroupSpareData (const PRM_SpareData *ref, int index)
void	mergeSpareData (const PRM_SpareData *srcsparedata)
const char *	getSpareValue (const char *token) const
void	setSpareValue (const char token, const char value)
void	copySpareValue (const char *token, const PRM_SpareData &ref)
const char *	getCallbackData () const
void	setCallbackData (const char *value)
CH_ScriptLanguage	getCallbackLanguage () const
void	setCallbackLanguage (CH_ScriptLanguage language)
const char *	getOpFilter () const
void	setOpFilter (const char *value)
void	setOpFilter (const PRM_SpareData *spareptr)
const char *	getRManType () const
void	setRManType (const char *value)
int	getMultiStartOffset () const
void	setMultiStartOffset (int value)
void	setRampColorType (UT_ColorType color_type)
UT_ColorType	getRampColorType () const
const char *	getRampBasisVar () const
void	setRampBasisVar (const char *value)
const char *	getRampKeysVar () const
void	setRampKeysVar (const char *value)
const char *	getRampValuesVar () const
void	setRampValuesVar (const char *value)
const char *	getImportSource () const
void	setImportSource (const char *value)
const char *	getImportToken () const
void	setImportToken (const char *value)
const char *	getImportMask () const
void	setImportMask (const char *value)
bool	getImportEnable () const
void	setImportEnable (bool value)
bool	getExportDisable () const
void	setExportDisable (bool value)
bool	getUnquotedFlag () const
void	setUnquotedFlag (bool value)
bool	getIsGroupStart () const
bool	getIsGroupEnd () const
bool	getIsGroupParm () const
bool	getIsMultiParm () const
bool	getIsRampParm () const
bool	getIsRampParmColor () const
bool	getIsRampParmFloat () const
bool	getIsFileParm () const
bool	getIsBasicStringParm () const
const char *	getRampBasisDefault () const
void	setRampBasisDefault (const char *value)
bool	getRampShowControlsDefault () const
void	setRampShowControlsDefault (bool value)
void	clearRampDefaults ()
const char *	getFileChooserMode () const
void	setFileChooserMode (const char *value)
Static Public Member Functions
static const char *	getScriptType (const PRM_Type &ptype, PRM_TypeExtended etype, PRM_MultiType mtype, int size)
static bool	parmTypeUsesOpFilter (const char *type)
static const char *	getExportDisableToken ()
Public Attributes
UT_String	myName
UT_String	myLabel
bool	myUseLabel
UT_String	myClass
UT_String	myCategory
int	myGroupID
bool	myInvisible
int	myExport
int	mySize
UT_String	myDefaults [PI_MAX_SCRIPT_PARM_SIZE]
CH_ExprLanguage	myDefaultExprLanguage
int	myRangeEnable
float	myRange [2]
bool	myRangeLock [2]
PI_EditScriptedParmMenuEnable	myMenuEnable
PI_EditScriptedParmMenuType	myMenuType
PI_EditScriptedParmFolderType	myFolderType
UT_String	myMenuScript
CH_ScriptLanguage	myMenuScriptLanguage
int	myDoAutolink [PI_MAX_SCRIPT_PARM_SIZE]
UT_String	myAutolink [PI_MAX_SCRIPT_PARM_SIZE]
UT_String	myOldAutolink [PI_MAX_SCRIPT_PARM_SIZE]
UT_String	myDisable
UT_String	myHelpText
UT_PtrArray < PI_EditScriptedParmMenu * >	myMenu
PRM_SpareData *	mySpareData
bool	myJoinNextFlag
bool	myTabBreak
bool	myReserved
Static Public Attributes
static PI_ParmType	theParmTypes []