PRM_Parm Class Reference

#include <PRM_Parm.h>

Inheritance diagram for PRM_Parm:

List of all members.

Public Member Functions

PRM_Parm (PRM_Template *thetemplate, CH_Collection *thechgroupptr, PRM_ParmList *owner, PRM_ParmOwner *node)

PRM_Parm (PRM_Parm *theprm, CH_Collection *thechgroupptr, PRM_ParmList *owner, PRM_ParmOwner *node)

~PRM_Parm ()

void adopt (PRM_Parm &thesrcparm)

void adoptOverrides (PRM_Parm &srcparm)

void revertToDefaults (double time)

void revertToDefault (double time, int index, bool propagate=true)

void restoreFactoryDefaults ()

void restoreFactoryDefault (int index)

int isDefault () const

int isDefault (int index) const

int isFactoryDefault () const

int isFactoryDefault (int index) const

int isTrueFactoryDefault (int index) const

int isTrueFactoryDefault () const

int isFactoryDefaultUI (int index) const

int isFactoryDefaultUI () const

void overwriteDefaults (double time)

void overwriteDefault (double time, int index)

CH_Channel * getChannel (int subindex) const

void buildOpDependencies (const PRM_RefId &ref_id, int thread)

void changeOpRef (const char *new_fullpath, const char *old_fullpath, const char *old_cwd, const char *chan_name, const char *old_chan_name, void(*undo_callback)(void *), void *undo_data, int thread)

void getValue (double time, int32 &intref, int index, int thread) const

void getValue (double time, int64 &intref, int index, int thread) const

void getValue (double time, fpreal32 &floatref, int index, int thread) const

void getValue (double time, fpreal64 &floatref, int index, int thread) const

void getValue (double time, UT_String &strref, int index, bool expand, int thread) const

void getValues (double time, float *floatref, int thread) const

void getValues (double time, int *intref, int thread) const

void getDefaultValue (float &floatref, int index) const

void getExpressionStringForUI (double thetime, UT_String &thestrref, int theindex, int thread) const

void getExpressionOrValue (double thetime, UT_String &thestrref, int theindex, int thread) const

void getExpressionOnly (double thetime, UT_String &thestrref, int theindex, int thread) const

bool setExpression (double thetime, const UT_String &thestrref, CH_ExprLanguage language, int theindex, bool evaluate=true, bool rmchannel=false, bool propagate=true)

int addChannel (const char *name)

int addChannel (const char *name, const char *expr, CH_ExprLanguage language)

void reloadChannelPtrs ()

int channelPtrModified (const char *name)

bool setValue (const double thetime, const UT_String &thestrref, CH_StringMeaning meaning, const int thekillexprflag=0, const int theindex=0, const int thehardenflag=0, bool propagate=1)

bool setValue (const double thetime, const float thefloat, const int thekillexprflag=0, const int theindex=0, const int thehardenflag=0, bool propagate=1)

bool setValue (const double thetime, const int theint, const int thekillexprflag=0, const int theindex=0, const int thehardenflag=0, bool propagate=1)

bool setValues (const double thetime, const float *thefloats, const int thekillexprflag=0, const int thehardenFlag=0, bool propagate=1)

bool setValues (const double thetime, const int *theints, const int thekillexprflag=0, const int thehardenFlag=0, bool propagate=1)

bool isMultiParm () const

void insertMultiParmItem (int index, bool propagate=1)

void removeMultiParmItem (int index, bool propagate=1)

void revertMultiParmItem (int index)

void assignMultiParmItem (int from, int to)

int getMultiParmNumItems () const

int getMultiParmInstancesPerItem () const

const char * getMultiParmToken (int p, int index) const

int getMultiParmUIEntries () const

const PRM_Template * getMultiParmTemplate (int idx) const

PRM_Template * getMultiParmTemplate (int idx)

PRM_Parm * getMultiParm (int idx) const

int getMultiParmCount () const

void valueChanged (int propagate=1)

void sendValueChanged (int propagate=1)

void indirectChange (bool expr_changed=false)

PRM_Callback getCallback ()

int setOverride (int theindex, int data_idx, const char *source)

const char * getOverride (int theindex) const

int getOverrideDataIndex (int theindex) const

bool getOverrideNodePath (int theindex, UT_String &path) const

bool getOverrideTrackName (int theindex, UT_String &trackname) const

int setOverrideDisable (int theindex, int onoff)

int getIsOverrideActive (int theindex) const

void copyParm (PRM_Parm &src)

void copyValue (double t, int dest_vi, const PRM_Parm &src_parm, int src_vi, bool set_name_alias, bool current_value_only)

void addChannels ()

void addChannel (int theindex)

void addChannel (int theindex, const char *theexpr, CH_ExprLanguage language)

void removeChannel (int theindex)

void clearAndDestroyChannels ()

int getChannelCount () const

int isTimeDependent () const

bool isTimeDependent (int subindex) const

int isDataDependent (float gtime) const

bool isDataDependent (float gtime, int subindex) const

void forceTimeDependent (void)

const PRM_Type & getType () const

PRM_TypeExtended getTypeExtended () const

PRM_MultiType getMultiType () const

float getMultiSize () const

int getMultiStartOffset () const

bool isRampType () const

bool isRampTypeColor () const

int getVectorSize () const

void getChannelToken (UT_String &thestrref, int theindex=0) const

void getChannelLabel (UT_String &thestrref, int theindex=0) const

void getToken (UT_String &thestrref) const

void getLabel (UT_String &thestrref) const

void getHelpText (UT_String &helptext) const

void getHelpUrl (UT_String &helptext) const

void getHelpTitle (UT_String &helptext) const

const char * getToken () const

const char * getLabel () const

void getChannelLabelForUI (UT_String &thestrref, int vec_idx) const

const PRM_SpareData * getSparePtr () const

unsigned getTokenHash () const

bool hasChannelAlias (int subindex) const

void getChannelAlias (UT_String &stringref, int subindex) const

bool canAccess (uint mask) const

bool setChannelAlias (const char *token_alias, int subindex)

PRM_ChoiceList * getChoiceListPtr ()

const PRM_ChoiceList * getChoiceListPtr () const

PRM_Value * inputNotifyValue ()

void createInputNotifyValue ()

int isDirty (int vector_idx=0) const

int areAllFlagsClean () const

void clearAllDirtyFlags ()

int findParmIndex (const char *thechannelname, bool allow_alias)

const PRM_Template * getTemplatePtr () const

PRM_Template * getTemplatePtr ()

PRM_Instance * getInstancePtr ()

void setChannelGroupPtr (CH_Collection *thechgroupptr)

CH_Collection * getChannelGroupPtr () const

unsigned getEnableState (int comp=-1) const

unsigned getInstanceEnableState (int comp=-1) const

bool getActiveTakeFlag () const

bool getAlwaysTakeFlag () const

void setActiveTakeFlag (int onoff)

int setEnableState (int thestate, int comp=-1)

bool getBypassFlag () const

void setBypassFlag (bool v)

int getExpressionState ()

void setExpressionState (int state)

int getValueState ()

void setValueState (int state)

void hardenChanges (double time, bool forceflag=0, const char *patt=0, CH_ChannelRefList *list=0)

void hardenChanges (double time, int index, bool forceflag=0, const char *patt=0, CH_ChannelRefList *list=0)

void setKey (double time, int index)

void setKey (double time, int index, const char *exp, CH_ExprLanguage language, const char *patt=0, CH_ChannelRefList *list=0)

void setFullKey (float gtime, int index, CH_FullKey const &key, bool accel_ratios=true)

CH_StringMeaning getStringMeaning (double time, int index) const

CH_ExprLanguage getExprLanguageIfMadeAnExpression (double time, int index) const

bool languageIsNodesLanguage (double time, int index)

int changePending (int index)

PRM_ChanState getChanState (double thetime) const

PRM_ChanState getChanState (double time, int index) const

void save (ostream &os, int binary, bool compiled) const

bool load (UT_IStream &is)

void saveCommand (ostream &os, int values=0, int index=-1) const

int loadCommand (int argc, char *argv[], int theindex, int vonly, PRM_KeySetType set_type)

float findNextKey (double theoldtime, int theindex=-1)

float findPrevKey (double theoldtime, int theindex=-1)

int findString (const char *str, bool fullword, bool usewildcards) const

int changeString (const char *from, const char *to, bool fullword)

int getInterestDirtyFlag ()

void setInterestDirtyFlag ()

void clearInterestDirtyFlag ()

int getExtraInterestFlag ()

void setExtraInterestFlag ()

void clearExtraInterestFlag ()

bool getUndoSavedFlag ()

void setUndoSavedFlag (bool f)

bool getAutoTakeUndoSavedFlag ()

void setAutoTakeUndoSavedFlag (bool f)

bool getLockedFlag (int vec_idx) const

bool areAllComponentsLocked () const

void setLockedFlag (int vec_idx, bool f)

unsigned int getLockedField () const

bool getAutoScopedFlag (int vec_idx) const

void setAutoScopedFlag (int vec_idx, bool f)

unsigned int getAutoScopedField () const

bool getMagicString (UT_TokenString &string, double t, int parm_group_mask, bool add_if_default, bool ignore_group, int thread)

void destroyChildParms ()

PRM_ParmList * getOwner () const

void setMostRecentCallbackValue (int value)

int getMostRecentCallbackValue () const

PRM_ParmOwner * getParmOwner () const

void clearParmOwner ()

bool isCompatible (const PRM_Parm &other_parm) const

bool isOfBasicType (PRM_Type check_type) const

bool isParmValueEqual (PRM_Parm &other_parm, int vec_index, double time, int thread) const

bool isParmValueEqual (int vec_index, PRM_Parm &other_parm, int other_index, double time, int thread) const

bool hasChannelName (const char *channame, int vec_index) const

void getAllChannelAliases (UT_String &aliasstring, char sep='/') const

bool isActive (const int index) const

void setActive (const int index, const bool active)

int64 getMemUsage (UT_Bool onlythis) const

bool isSpareParm () const

void setSpareParm (bool sp) const

const PRM_Instance * getMultiParmOwner () const

void setMultiParmOwner (const PRM_Multi *multiparmowner)

int getMultiInstanceIndex (UT_IntArray &indices, bool instance_index=true) const

void rebuildParmDependency ()

bool isRotationParm () const

void setChannelReference (double thetime, int theindex, const char *path, const char *ch_name=NULL, bool evaluate=true, bool rmchannel=false)

void constructChannelReference (UT_String &reference, CH_ExprLanguage language, const char *path, const char *ch_name=NULL)

Static Public Member Functions

static bool getDestructiveRevertToDefaultFlag ()

static void setDestructiveRevertToDefaultFlag (bool v)

static bool getRevertInvisibleToDefaultsFlag ()

static void setRevertInvisibleToDefaultsFlag (bool v)

static bool getMakeSpareParmsForUnknownChannelsFlag ()

static void setMakeSpareParmsForUnknownChannelsFlag (bool v)

static bool isFloatExpression (const char *str)

static bool isStringExpression (const char *str, CH_StringMeaning meaning, PRM_Template *tplate=NULL)

static bool isOrdinalExpression (const char *str, const PRM_Template *tplate=NULL)

static bool isOrdinalExpression (const PRM_Default &dflt, const PRM_Template *tplate=NULL)

static void convertStringToExprLanguage (const char *str, UT_String &expr, PRM_Template *tplate=NULL)

static void convertStringFromExprLanguage (const char *str, UT_String &expr)

static bool getIsAddingOrRemovingMultiParms ()

static bool replaceMultiNumber (UT_String &str, const char *replace)

static bool replaceRemainingMultiNumbers (UT_String &str)

static void instanceMultiString (UT_String &token, const UT_IntArray &indexlist, bool fill_remaining=true)

static void instanceMultiString (UT_String &token, const int *indexlist, int num, bool fill_remaining=true)

static int getAlwaysHardenFlag ()

static void setAlwaysHardenFlag (int o)

static bool isChanRefString (const char *str, bool is_expr, UT_String *chref=0)

Detailed Description

Examples:: SOP/MSS_CustomBrushState.C, SOP/SOP_CopRaster.C, and SOP/SOP_CopRaster.h.

Definition at line 53 of file PRM_Parm.h.

Constructor & Destructor Documentation

PRM_Parm::PRM_Parm	(	PRM_Template *	thetemplate,
		CH_Collection *	thechgroupptr,
		PRM_ParmList *	owner,
		PRM_ParmOwner *	node
	)

PRM_Parm::PRM_Parm	(	PRM_Parm *	theprm,
		CH_Collection *	thechgroupptr,
		PRM_ParmList *	owner,
		PRM_ParmOwner *	node
	)

PRM_Parm::~PRM_Parm ( )

Member Function Documentation

void PRM_Parm::addChannel	(	int	theindex,
		const char *	theexpr,
		CH_ExprLanguage	language
	)

void PRM_Parm::addChannel ( int theindex )

int PRM_Parm::addChannel	(	const char *	name,
		const char *	expr,
		CH_ExprLanguage	language
	)

int PRM_Parm::addChannel ( const char * name )

void PRM_Parm::addChannels ( )

void PRM_Parm::adopt ( PRM_Parm & thesrcparm )

void PRM_Parm::adoptOverrides ( PRM_Parm & srcparm )

bool PRM_Parm::areAllComponentsLocked ( ) const

int PRM_Parm::areAllFlagsClean ( ) const

void PRM_Parm::assignMultiParmItem	(	int	from,
		int	to
	)

void PRM_Parm::buildOpDependencies	(	const PRM_RefId &	ref_id,
		int	thread
	)

bool PRM_Parm::canAccess ( uint mask ) const

void PRM_Parm::changeOpRef	(	const char *	new_fullpath,
		const char *	old_fullpath,
		const char *	old_cwd,
		const char *	chan_name,
		const char *	old_chan_name,
		void()(void )	undo_callback,
		void *	undo_data,
		int	thread
	)

int PRM_Parm::changePending ( int index )

int PRM_Parm::changeString	(	const char *	from,
		const char *	to,
		bool	fullword
	)

int PRM_Parm::channelPtrModified ( const char * name )

void PRM_Parm::clearAllDirtyFlags ( )

void PRM_Parm::clearAndDestroyChannels ( )

void PRM_Parm::clearExtraInterestFlag ( )

void PRM_Parm::clearInterestDirtyFlag ( )

void PRM_Parm::clearParmOwner ( )

void PRM_Parm::constructChannelReference	(	UT_String &	reference,
		CH_ExprLanguage	language,
		const char *	path,
		const char *	ch_name = `NULL`
	)

static void PRM_Parm::convertStringFromExprLanguage	(	const char *	str,
		UT_String &	expr
	)			`[static]`

static void PRM_Parm::convertStringToExprLanguage	(	const char *	str,
		UT_String &	expr,
		PRM_Template *	tplate = `NULL`
	)			`[static]`

void PRM_Parm::copyParm ( PRM_Parm & src )

copyParm() copies the value of an entire parm, including channels. If it is a multi-parm, then all instance parameters will be also be copied. If the they are a mismatch of vector sizes, the smaller of the two sizes will be used.

void PRM_Parm::copyValue	(	double	t,
		int	dest_vi,
		const PRM_Parm &	src_parm,
		int	src_vi,
		bool	set_name_alias,
		bool	current_value_only
	)

copyValue copies the value for a particular parm component. If current_value_only is true, then only the value evaluated at time t will be copied. Otherwise, any channels in the src_parm will be copied wholesale.

void PRM_Parm::createInputNotifyValue ( )

void PRM_Parm::destroyChildParms ( )

float PRM_Parm::findNextKey	(	double	theoldtime,
		int	theindex = `-1`
	)

int PRM_Parm::findParmIndex	(	const char *	thechannelname,
		bool	allow_alias
	)

float PRM_Parm::findPrevKey	(	double	theoldtime,
		int	theindex = `-1`
	)

int PRM_Parm::findString	(	const char *	str,
		bool	fullword,
		bool	usewildcards
	)			const

void PRM_Parm::forceTimeDependent ( void )

bool PRM_Parm::getActiveTakeFlag ( ) const

void PRM_Parm::getAllChannelAliases	(	UT_String &	aliasstring,
		char	sep = `'/'`
	)			const

static int PRM_Parm::getAlwaysHardenFlag ( ) [inline, static]

Definition at line 129 of file PRM_Parm.h.

bool PRM_Parm::getAlwaysTakeFlag ( ) const

unsigned int PRM_Parm::getAutoScopedField ( ) const

bool PRM_Parm::getAutoScopedFlag ( int vec_idx ) const

bool PRM_Parm::getAutoTakeUndoSavedFlag ( )

bool PRM_Parm::getBypassFlag ( ) const

PRM_Callback PRM_Parm::getCallback ( ) [inline]

Definition at line 263 of file PRM_Parm.h.

CH_Channel* PRM_Parm::getChannel ( int subindex ) const

void PRM_Parm::getChannelAlias	(	UT_String &	stringref,
		int	subindex
	)			const

int PRM_Parm::getChannelCount ( ) const

CH_Collection* PRM_Parm::getChannelGroupPtr ( ) const

void PRM_Parm::getChannelLabel	(	UT_String &	thestrref,
		int	theindex = `0`
	)			const

void PRM_Parm::getChannelLabelForUI	(	UT_String &	thestrref,
		int	vec_idx
	)			const

void PRM_Parm::getChannelToken	(	UT_String &	thestrref,
		int	theindex = `0`
	)			const

PRM_ChanState PRM_Parm::getChanState	(	double	time,
		int	index
	)			const

PRM_ChanState PRM_Parm::getChanState ( double thetime ) const

const PRM_ChoiceList* PRM_Parm::getChoiceListPtr ( ) const

PRM_ChoiceList* PRM_Parm::getChoiceListPtr ( )

void PRM_Parm::getDefaultValue	(	float &	floatref,
		int	index
	)			const

static bool PRM_Parm::getDestructiveRevertToDefaultFlag ( ) [inline, static]

Definition at line 79 of file PRM_Parm.h.

unsigned PRM_Parm::getEnableState ( int comp = -1 ) const

void PRM_Parm::getExpressionOnly	(	double	thetime,
		UT_String &	thestrref,
		int	theindex,
		int	thread
	)			const

void PRM_Parm::getExpressionOrValue	(	double	thetime,
		UT_String &	thestrref,
		int	theindex,
		int	thread
	)			const

int PRM_Parm::getExpressionState ( )

void PRM_Parm::getExpressionStringForUI	(	double	thetime,
		UT_String &	thestrref,
		int	theindex,
		int	thread
	)			const

CH_ExprLanguage PRM_Parm::getExprLanguageIfMadeAnExpression	(	double	time,
		int	index
	)			const

int PRM_Parm::getExtraInterestFlag ( )

void PRM_Parm::getHelpText ( UT_String & helptext ) const

void PRM_Parm::getHelpTitle ( UT_String & helptext ) const

void PRM_Parm::getHelpUrl ( UT_String & helptext ) const

unsigned PRM_Parm::getInstanceEnableState ( int comp = -1 ) const

PRM_Instance* PRM_Parm::getInstancePtr ( )

int PRM_Parm::getInterestDirtyFlag ( )

static bool PRM_Parm::getIsAddingOrRemovingMultiParms ( ) [static]

int PRM_Parm::getIsOverrideActive ( int theindex ) const

const char* PRM_Parm::getLabel ( ) const

void PRM_Parm::getLabel ( UT_String & thestrref ) const

unsigned int PRM_Parm::getLockedField ( ) const

bool PRM_Parm::getLockedFlag ( int vec_idx ) const

bool PRM_Parm::getMagicString	(	UT_TokenString &	string,
		double	t,
		int	parm_group_mask,
		bool	add_if_default,
		bool	ignore_group,
		int	thread
	)

static bool PRM_Parm::getMakeSpareParmsForUnknownChannelsFlag ( ) [inline, static]

Definition at line 89 of file PRM_Parm.h.

int64 PRM_Parm::getMemUsage ( UT_Bool onlythis ) const

int PRM_Parm::getMostRecentCallbackValue ( ) const

int PRM_Parm::getMultiInstanceIndex	(	UT_IntArray &	indices,
		bool	instance_index = `true`
	)			const

Return the list of instance indicies for this parameter. If this parameter is part of a multi-parameter, then its index in the multi-parm array will be inserted into the indices array. If the multi-parm is nested in other multi-parms, then the indices array will have multiple entries (with the outer multi-parm listed first, and the inner-most multi-parm last in the array).

Parameters:

	indices	The list of index instances.
	instance_index	Each multi-parm can have multiple parameters in each instance. If instance_index is true, the instance number will be returned. Otherwise the raw offset into the multi-parm will be extracted.

PRM_Parm* PRM_Parm::getMultiParm ( int idx ) const

int PRM_Parm::getMultiParmCount ( ) const

int PRM_Parm::getMultiParmInstancesPerItem ( ) const

int PRM_Parm::getMultiParmNumItems ( ) const

const PRM_Instance* PRM_Parm::getMultiParmOwner ( ) const

PRM_Template* PRM_Parm::getMultiParmTemplate ( int idx )

const PRM_Template* PRM_Parm::getMultiParmTemplate ( int idx ) const

const char* PRM_Parm::getMultiParmToken	(	int	p,
		int	index
	)			const

int PRM_Parm::getMultiParmUIEntries ( ) const

float PRM_Parm::getMultiSize ( ) const

int PRM_Parm::getMultiStartOffset ( ) const

PRM_MultiType PRM_Parm::getMultiType ( ) const

const char* PRM_Parm::getOverride ( int theindex ) const

int PRM_Parm::getOverrideDataIndex ( int theindex ) const

bool PRM_Parm::getOverrideNodePath	(	int	theindex,
		UT_String &	path
	)			const

bool PRM_Parm::getOverrideTrackName	(	int	theindex,
		UT_String &	trackname
	)			const

PRM_ParmList* PRM_Parm::getOwner ( ) const

PRM_ParmOwner* PRM_Parm::getParmOwner ( ) const

static bool PRM_Parm::getRevertInvisibleToDefaultsFlag ( ) [inline, static]

Definition at line 84 of file PRM_Parm.h.

const PRM_SpareData* PRM_Parm::getSparePtr ( ) const

CH_StringMeaning PRM_Parm::getStringMeaning	(	double	time,
		int	index
	)			const

PRM_Template* PRM_Parm::getTemplatePtr ( )

const PRM_Template* PRM_Parm::getTemplatePtr ( ) const

const char* PRM_Parm::getToken ( ) const

void PRM_Parm::getToken ( UT_String & thestrref ) const

unsigned PRM_Parm::getTokenHash ( ) const

const PRM_Type& PRM_Parm::getType ( ) const

PRM_TypeExtended PRM_Parm::getTypeExtended ( ) const

bool PRM_Parm::getUndoSavedFlag ( )

void PRM_Parm::getValue	(	double	time,
		UT_String &	strref,
		int	index,
		bool	expand,
		int	thread
	)			const

void PRM_Parm::getValue	(	double	time,
		fpreal64 &	floatref,
		int	index,
		int	thread
	)			const

void PRM_Parm::getValue	(	double	time,
		fpreal32 &	floatref,
		int	index,
		int	thread
	)			const

void PRM_Parm::getValue	(	double	time,
		int64 &	intref,
		int	index,
		int	thread
	)			const

void PRM_Parm::getValue	(	double	time,
		int32 &	intref,
		int	index,
		int	thread
	)			const

void PRM_Parm::getValues	(	double	time,
		int *	intref,
		int	thread
	)			const

void PRM_Parm::getValues	(	double	time,
		float *	floatref,
		int	thread
	)			const

int PRM_Parm::getValueState ( )

int PRM_Parm::getVectorSize ( ) const

void PRM_Parm::hardenChanges	(	double	time,
		int	index,
		bool	forceflag = `0`,
		const char *	patt = `0`,
		CH_ChannelRefList *	list = `0`
	)

void PRM_Parm::hardenChanges	(	double	time,
		bool	forceflag = `0`,
		const char *	patt = `0`,
		CH_ChannelRefList *	list = `0`
	)

bool PRM_Parm::hasChannelAlias ( int subindex ) const

bool PRM_Parm::hasChannelName	(	const char *	channame,
		int	vec_index
	)			const

void PRM_Parm::indirectChange ( bool expr_changed = false )

PRM_Value* PRM_Parm::inputNotifyValue ( )

void PRM_Parm::insertMultiParmItem	(	int	index,
		bool	propagate = `1`
	)

static void PRM_Parm::instanceMultiString	(	UT_String &	token,
		const int *	indexlist,
		int	num,
		bool	fill_remaining = `true`
	)			`[static]`

static void PRM_Parm::instanceMultiString	(	UT_String &	token,
		const UT_IntArray &	indexlist,
		bool	fill_remaining = `true`
	)			`[static]`

bool PRM_Parm::isActive ( const int index ) const

static bool PRM_Parm::isChanRefString	(	const char *	str,
		bool	is_expr,
		UT_String *	chref = `0`
	)			`[static]`

bool PRM_Parm::isCompatible ( const PRM_Parm & other_parm ) const

bool PRM_Parm::isDataDependent	(	float	gtime,
		int	subindex
	)			const

int PRM_Parm::isDataDependent ( float gtime ) const

int PRM_Parm::isDefault ( int index ) const

int PRM_Parm::isDefault ( ) const

int PRM_Parm::isDirty ( int vector_idx = 0 ) const

int PRM_Parm::isFactoryDefault ( int index ) const

int PRM_Parm::isFactoryDefault ( ) const

int PRM_Parm::isFactoryDefaultUI ( ) const

int PRM_Parm::isFactoryDefaultUI ( int index ) const

static bool PRM_Parm::isFloatExpression ( const char * str ) [static]

bool PRM_Parm::isMultiParm ( ) const

bool PRM_Parm::isOfBasicType ( PRM_Type check_type ) const

static bool PRM_Parm::isOrdinalExpression	(	const PRM_Default &	dflt,
		const PRM_Template *	tplate = `NULL`
	)			`[static]`

static bool PRM_Parm::isOrdinalExpression	(	const char *	str,
		const PRM_Template *	tplate = `NULL`
	)			`[static]`

bool PRM_Parm::isParmValueEqual	(	int	vec_index,
		PRM_Parm &	other_parm,
		int	other_index,
		double	time,
		int	thread
	)			const

bool PRM_Parm::isParmValueEqual	(	PRM_Parm &	other_parm,
		int	vec_index,
		double	time,
		int	thread
	)			const

bool PRM_Parm::isRampType ( ) const

bool PRM_Parm::isRampTypeColor ( ) const

bool PRM_Parm::isRotationParm ( ) const

bool PRM_Parm::isSpareParm ( ) const

static bool PRM_Parm::isStringExpression	(	const char *	str,
		CH_StringMeaning	meaning,
		PRM_Template *	tplate = `NULL`
	)			`[static]`

bool PRM_Parm::isTimeDependent ( int subindex ) const

int PRM_Parm::isTimeDependent ( ) const

int PRM_Parm::isTrueFactoryDefault ( ) const

int PRM_Parm::isTrueFactoryDefault ( int index ) const

bool PRM_Parm::languageIsNodesLanguage	(	double	time,
		int	index
	)

bool PRM_Parm::load ( UT_IStream & is )

int PRM_Parm::loadCommand	(	int	argc,
		char *	argv[],
		int	theindex,
		int	vonly,
		PRM_KeySetType	set_type
	)

void PRM_Parm::overwriteDefault	(	double	time,
		int	index
	)

void PRM_Parm::overwriteDefaults ( double time )

void PRM_Parm::rebuildParmDependency ( )

void PRM_Parm::reloadChannelPtrs ( )

void PRM_Parm::removeChannel ( int theindex )

void PRM_Parm::removeMultiParmItem	(	int	index,
		bool	propagate = `1`
	)

static bool PRM_Parm::replaceMultiNumber	(	UT_String &	str,
		const char *	replace
	)			`[static]`

static bool PRM_Parm::replaceRemainingMultiNumbers ( UT_String & str ) [static]

void PRM_Parm::restoreFactoryDefault ( int index )

void PRM_Parm::restoreFactoryDefaults ( )

void PRM_Parm::revertMultiParmItem ( int index )

void PRM_Parm::revertToDefault	(	double	time,
		int	index,
		bool	propagate = `true`
	)

void PRM_Parm::revertToDefaults ( double time )

void PRM_Parm::save	(	ostream &	os,
		int	binary,
		bool	compiled
	)			const

void PRM_Parm::saveCommand	(	ostream &	os,
		int	values = `0`,
		int	index = `-1`
	)			const

void PRM_Parm::sendValueChanged ( int propagate = 1 )

void PRM_Parm::setActive	(	const int	index,
		const bool	active
	)

void PRM_Parm::setActiveTakeFlag ( int onoff )

static void PRM_Parm::setAlwaysHardenFlag ( int o ) [inline, static]

Definition at line 130 of file PRM_Parm.h.

void PRM_Parm::setAutoScopedFlag	(	int	vec_idx,
		bool	f
	)

void PRM_Parm::setAutoTakeUndoSavedFlag ( bool f )

void PRM_Parm::setBypassFlag ( bool v )

bool PRM_Parm::setChannelAlias	(	const char *	token_alias,
		int	subindex
	)

void PRM_Parm::setChannelGroupPtr ( CH_Collection * thechgroupptr )

void PRM_Parm::setChannelReference	(	double	thetime,
		int	theindex,
		const char *	path,
		const char *	ch_name = `NULL`,
		bool	evaluate = `true`,
		bool	rmchannel = `false`
	)

static void PRM_Parm::setDestructiveRevertToDefaultFlag ( bool v ) [inline, static]

Definition at line 81 of file PRM_Parm.h.

int PRM_Parm::setEnableState	(	int	thestate,
		int	comp = `-1`
	)

bool PRM_Parm::setExpression	(	double	thetime,
		const UT_String &	thestrref,
		CH_ExprLanguage	language,
		int	theindex,
		bool	evaluate = `true`,
		bool	rmchannel = `false`,
		bool	propagate = `true`
	)

void PRM_Parm::setExpressionState ( int state )

void PRM_Parm::setExtraInterestFlag ( )

void PRM_Parm::setFullKey	(	float	gtime,
		int	index,
		CH_FullKey const &	key,
		bool	accel_ratios = `true`
	)

void PRM_Parm::setInterestDirtyFlag ( )

void PRM_Parm::setKey	(	double	time,
		int	index,
		const char *	exp,
		CH_ExprLanguage	language,
		const char *	patt = `0`,
		CH_ChannelRefList *	list = `0`
	)

void PRM_Parm::setKey	(	double	time,
		int	index
	)

void PRM_Parm::setLockedFlag	(	int	vec_idx,
		bool	f
	)

static void PRM_Parm::setMakeSpareParmsForUnknownChannelsFlag ( bool v ) [inline, static]

Definition at line 91 of file PRM_Parm.h.

void PRM_Parm::setMostRecentCallbackValue ( int value )

void PRM_Parm::setMultiParmOwner ( const PRM_Multi * multiparmowner )

int PRM_Parm::setOverride	(	int	theindex,
		int	data_idx,
		const char *	source
	)

int PRM_Parm::setOverrideDisable	(	int	theindex,
		int	onoff
	)

static void PRM_Parm::setRevertInvisibleToDefaultsFlag ( bool v ) [inline, static]

Definition at line 86 of file PRM_Parm.h.

void PRM_Parm::setSpareParm ( bool sp ) const

void PRM_Parm::setUndoSavedFlag ( bool f )

bool PRM_Parm::setValue	(	const double	thetime,
		const int	theint,
		const int	thekillexprflag = `0`,
		const int	theindex = `0`,
		const int	thehardenflag = `0`,
		bool	propagate = `1`
	)

bool PRM_Parm::setValue	(	const double	thetime,
		const float	thefloat,
		const int	thekillexprflag = `0`,
		const int	theindex = `0`,
		const int	thehardenflag = `0`,
		bool	propagate = `1`
	)

bool PRM_Parm::setValue	(	const double	thetime,
		const UT_String &	thestrref,
		CH_StringMeaning	meaning,
		const int	thekillexprflag = `0`,
		const int	theindex = `0`,
		const int	thehardenflag = `0`,
		bool	propagate = `1`
	)

Examples:: SOP/MSS_CustomBrushState.C.

bool PRM_Parm::setValues	(	const double	thetime,
		const int *	theints,
		const int	thekillexprflag = `0`,
		const int	thehardenFlag = `0`,
		bool	propagate = `1`
	)

bool PRM_Parm::setValues	(	const double	thetime,
		const float *	thefloats,
		const int	thekillexprflag = `0`,
		const int	thehardenFlag = `0`,
		bool	propagate = `1`
	)

void PRM_Parm::setValueState ( int state )

void PRM_Parm::valueChanged ( int propagate = 1 ) [inline]

Definition at line 258 of file PRM_Parm.h.

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

PRM/PRM_Parm.h


Public Member Functions
	PRM_Parm (PRM_Template thetemplate, CH_Collection thechgroupptr, PRM_ParmList owner, PRM_ParmOwner node)
	PRM_Parm (PRM_Parm theprm, CH_Collection thechgroupptr, PRM_ParmList owner, PRM_ParmOwner node)
	~PRM_Parm ()
void	adopt (PRM_Parm &thesrcparm)
void	adoptOverrides (PRM_Parm &srcparm)
void	revertToDefaults (double time)
void	revertToDefault (double time, int index, bool propagate=true)
void	restoreFactoryDefaults ()
void	restoreFactoryDefault (int index)
int	isDefault () const
int	isDefault (int index) const
int	isFactoryDefault () const
int	isFactoryDefault (int index) const
int	isTrueFactoryDefault (int index) const
int	isTrueFactoryDefault () const
int	isFactoryDefaultUI (int index) const
int	isFactoryDefaultUI () const
void	overwriteDefaults (double time)
void	overwriteDefault (double time, int index)
CH_Channel *	getChannel (int subindex) const
void	buildOpDependencies (const PRM_RefId &ref_id, int thread)
void	changeOpRef (const char new_fullpath, const char old_fullpath, const char old_cwd, const char chan_name, const char old_chan_name, void(undo_callback)(void ), void undo_data, int thread)
void	getValue (double time, int32 &intref, int index, int thread) const
void	getValue (double time, int64 &intref, int index, int thread) const
void	getValue (double time, fpreal32 &floatref, int index, int thread) const
void	getValue (double time, fpreal64 &floatref, int index, int thread) const
void	getValue (double time, UT_String &strref, int index, bool expand, int thread) const
void	getValues (double time, float *floatref, int thread) const
void	getValues (double time, int *intref, int thread) const
void	getDefaultValue (float &floatref, int index) const
void	getExpressionStringForUI (double thetime, UT_String &thestrref, int theindex, int thread) const
void	getExpressionOrValue (double thetime, UT_String &thestrref, int theindex, int thread) const
void	getExpressionOnly (double thetime, UT_String &thestrref, int theindex, int thread) const
bool	setExpression (double thetime, const UT_String &thestrref, CH_ExprLanguage language, int theindex, bool evaluate=true, bool rmchannel=false, bool propagate=true)
int	addChannel (const char *name)
int	addChannel (const char name, const char expr, CH_ExprLanguage language)
void	reloadChannelPtrs ()
int	channelPtrModified (const char *name)
bool	setValue (const double thetime, const UT_String &thestrref, CH_StringMeaning meaning, const int thekillexprflag=0, const int theindex=0, const int thehardenflag=0, bool propagate=1)
bool	setValue (const double thetime, const float thefloat, const int thekillexprflag=0, const int theindex=0, const int thehardenflag=0, bool propagate=1)
bool	setValue (const double thetime, const int theint, const int thekillexprflag=0, const int theindex=0, const int thehardenflag=0, bool propagate=1)
bool	setValues (const double thetime, const float *thefloats, const int thekillexprflag=0, const int thehardenFlag=0, bool propagate=1)
bool	setValues (const double thetime, const int *theints, const int thekillexprflag=0, const int thehardenFlag=0, bool propagate=1)
bool	isMultiParm () const
void	insertMultiParmItem (int index, bool propagate=1)
void	removeMultiParmItem (int index, bool propagate=1)
void	revertMultiParmItem (int index)
void	assignMultiParmItem (int from, int to)
int	getMultiParmNumItems () const
int	getMultiParmInstancesPerItem () const
const char *	getMultiParmToken (int p, int index) const
int	getMultiParmUIEntries () const
const PRM_Template *	getMultiParmTemplate (int idx) const
PRM_Template *	getMultiParmTemplate (int idx)
PRM_Parm *	getMultiParm (int idx) const
int	getMultiParmCount () const
void	valueChanged (int propagate=1)
void	sendValueChanged (int propagate=1)
void	indirectChange (bool expr_changed=false)
PRM_Callback	getCallback ()
int	setOverride (int theindex, int data_idx, const char *source)
const char *	getOverride (int theindex) const
int	getOverrideDataIndex (int theindex) const
bool	getOverrideNodePath (int theindex, UT_String &path) const
bool	getOverrideTrackName (int theindex, UT_String &trackname) const
int	setOverrideDisable (int theindex, int onoff)
int	getIsOverrideActive (int theindex) const
void	copyParm (PRM_Parm &src)
void	copyValue (double t, int dest_vi, const PRM_Parm &src_parm, int src_vi, bool set_name_alias, bool current_value_only)
void	addChannels ()
void	addChannel (int theindex)
void	addChannel (int theindex, const char *theexpr, CH_ExprLanguage language)
void	removeChannel (int theindex)
void	clearAndDestroyChannels ()
int	getChannelCount () const
int	isTimeDependent () const
bool	isTimeDependent (int subindex) const
int	isDataDependent (float gtime) const
bool	isDataDependent (float gtime, int subindex) const
void	forceTimeDependent (void)
const PRM_Type &	getType () const
PRM_TypeExtended	getTypeExtended () const
PRM_MultiType	getMultiType () const
float	getMultiSize () const
int	getMultiStartOffset () const
bool	isRampType () const
bool	isRampTypeColor () const
int	getVectorSize () const
void	getChannelToken (UT_String &thestrref, int theindex=0) const
void	getChannelLabel (UT_String &thestrref, int theindex=0) const
void	getToken (UT_String &thestrref) const
void	getLabel (UT_String &thestrref) const
void	getHelpText (UT_String &helptext) const
void	getHelpUrl (UT_String &helptext) const
void	getHelpTitle (UT_String &helptext) const
const char *	getToken () const
const char *	getLabel () const
void	getChannelLabelForUI (UT_String &thestrref, int vec_idx) const
const PRM_SpareData *	getSparePtr () const
unsigned	getTokenHash () const
bool	hasChannelAlias (int subindex) const
void	getChannelAlias (UT_String &stringref, int subindex) const
bool	canAccess (uint mask) const
bool	setChannelAlias (const char *token_alias, int subindex)
PRM_ChoiceList *	getChoiceListPtr ()
const PRM_ChoiceList *	getChoiceListPtr () const
PRM_Value *	inputNotifyValue ()
void	createInputNotifyValue ()
int	isDirty (int vector_idx=0) const
int	areAllFlagsClean () const
void	clearAllDirtyFlags ()
int	findParmIndex (const char *thechannelname, bool allow_alias)
const PRM_Template *	getTemplatePtr () const
PRM_Template *	getTemplatePtr ()
PRM_Instance *	getInstancePtr ()
void	setChannelGroupPtr (CH_Collection *thechgroupptr)
CH_Collection *	getChannelGroupPtr () const
unsigned	getEnableState (int comp=-1) const
unsigned	getInstanceEnableState (int comp=-1) const
bool	getActiveTakeFlag () const
bool	getAlwaysTakeFlag () const
void	setActiveTakeFlag (int onoff)
int	setEnableState (int thestate, int comp=-1)
bool	getBypassFlag () const
void	setBypassFlag (bool v)
int	getExpressionState ()
void	setExpressionState (int state)
int	getValueState ()
void	setValueState (int state)
void	hardenChanges (double time, bool forceflag=0, const char patt=0, CH_ChannelRefList list=0)
void	hardenChanges (double time, int index, bool forceflag=0, const char patt=0, CH_ChannelRefList list=0)
void	setKey (double time, int index)
void	setKey (double time, int index, const char exp, CH_ExprLanguage language, const char patt=0, CH_ChannelRefList *list=0)
void	setFullKey (float gtime, int index, CH_FullKey const &key, bool accel_ratios=true)
CH_StringMeaning	getStringMeaning (double time, int index) const
CH_ExprLanguage	getExprLanguageIfMadeAnExpression (double time, int index) const
bool	languageIsNodesLanguage (double time, int index)
int	changePending (int index)
PRM_ChanState	getChanState (double thetime) const
PRM_ChanState	getChanState (double time, int index) const
void	save (ostream &os, int binary, bool compiled) const
bool	load (UT_IStream &is)
void	saveCommand (ostream &os, int values=0, int index=-1) const
int	loadCommand (int argc, char *argv[], int theindex, int vonly, PRM_KeySetType set_type)
float	findNextKey (double theoldtime, int theindex=-1)
float	findPrevKey (double theoldtime, int theindex=-1)
int	findString (const char *str, bool fullword, bool usewildcards) const
int	changeString (const char from, const char to, bool fullword)
int	getInterestDirtyFlag ()
void	setInterestDirtyFlag ()
void	clearInterestDirtyFlag ()
int	getExtraInterestFlag ()
void	setExtraInterestFlag ()
void	clearExtraInterestFlag ()
bool	getUndoSavedFlag ()
void	setUndoSavedFlag (bool f)
bool	getAutoTakeUndoSavedFlag ()
void	setAutoTakeUndoSavedFlag (bool f)
bool	getLockedFlag (int vec_idx) const
bool	areAllComponentsLocked () const
void	setLockedFlag (int vec_idx, bool f)
unsigned int	getLockedField () const
bool	getAutoScopedFlag (int vec_idx) const
void	setAutoScopedFlag (int vec_idx, bool f)
unsigned int	getAutoScopedField () const
bool	getMagicString (UT_TokenString &string, double t, int parm_group_mask, bool add_if_default, bool ignore_group, int thread)
void	destroyChildParms ()
PRM_ParmList *	getOwner () const
void	setMostRecentCallbackValue (int value)
int	getMostRecentCallbackValue () const
PRM_ParmOwner *	getParmOwner () const
void	clearParmOwner ()
bool	isCompatible (const PRM_Parm &other_parm) const
bool	isOfBasicType (PRM_Type check_type) const
bool	isParmValueEqual (PRM_Parm &other_parm, int vec_index, double time, int thread) const
bool	isParmValueEqual (int vec_index, PRM_Parm &other_parm, int other_index, double time, int thread) const
bool	hasChannelName (const char *channame, int vec_index) const
void	getAllChannelAliases (UT_String &aliasstring, char sep='/') const
bool	isActive (const int index) const
void	setActive (const int index, const bool active)
int64	getMemUsage (UT_Bool onlythis) const
bool	isSpareParm () const
void	setSpareParm (bool sp) const
const PRM_Instance *	getMultiParmOwner () const
void	setMultiParmOwner (const PRM_Multi *multiparmowner)
int	getMultiInstanceIndex (UT_IntArray &indices, bool instance_index=true) const
void	rebuildParmDependency ()
bool	isRotationParm () const
void	setChannelReference (double thetime, int theindex, const char path, const char ch_name=NULL, bool evaluate=true, bool rmchannel=false)
void	constructChannelReference (UT_String &reference, CH_ExprLanguage language, const char path, const char ch_name=NULL)
Static Public Member Functions
static bool	getDestructiveRevertToDefaultFlag ()
static void	setDestructiveRevertToDefaultFlag (bool v)
static bool	getRevertInvisibleToDefaultsFlag ()
static void	setRevertInvisibleToDefaultsFlag (bool v)
static bool	getMakeSpareParmsForUnknownChannelsFlag ()
static void	setMakeSpareParmsForUnknownChannelsFlag (bool v)
static bool	isFloatExpression (const char *str)
static bool	isStringExpression (const char str, CH_StringMeaning meaning, PRM_Template tplate=NULL)
static bool	isOrdinalExpression (const char str, const PRM_Template tplate=NULL)
static bool	isOrdinalExpression (const PRM_Default &dflt, const PRM_Template *tplate=NULL)
static void	convertStringToExprLanguage (const char str, UT_String &expr, PRM_Template tplate=NULL)
static void	convertStringFromExprLanguage (const char *str, UT_String &expr)
static bool	getIsAddingOrRemovingMultiParms ()
static bool	replaceMultiNumber (UT_String &str, const char *replace)
static bool	replaceRemainingMultiNumbers (UT_String &str)
static void	instanceMultiString (UT_String &token, const UT_IntArray &indexlist, bool fill_remaining=true)
static void	instanceMultiString (UT_String &token, const int *indexlist, int num, bool fill_remaining=true)
static int	getAlwaysHardenFlag ()
static void	setAlwaysHardenFlag (int o)
static bool	isChanRefString (const char str, bool is_expr, UT_String chref=0)