OP_Parameters Class Reference

#include <OP_Parameters.h>

Inheritance diagram for OP_Parameters:

List of all members.

Public Member Functions

const UT_String & getName () const

OP_Operator * getOperator () const

virtual void getFullPath (UT_String &str) const

unsigned disableParmsAndSpareParms ()

unsigned checkDisableForParm (PRM_Parm &parm, const UT_StringArray *skipparms)

virtual unsigned disableParms ()

virtual unsigned referenceAllParameters (OP_Parameters *from)

void animate (unsigned idx)

void animate (const char *name)

void deAnimate (unsigned idx)

void deAnimate (const char *name)

CH_Channel * addChannel (const char *name)

CH_Channel * getChannel (const char *name)

const CH_Channel * getChannel (const char *name) const

int destroyChannel (const char *name)

bool isObsoleteChannel (const char *name) const

void takeActivateParm (uint idx, bool enable=true)

void takeActivateParm (const char *name, bool enable=true)

void takeActivateParm (PRM_Parm *parm, bool enable=true)

void takeDeactivateParm (uint idx)

void takeDeactivateParm (const char *name)

void takeDeactivateParm (PRM_Parm *parm)

bool takeIsActiveParm (uint idx)

bool takeIsActiveParm (const char *name)

bool takeIsActiveParm (const PRM_Parm *parm)

virtual void takeAutoActivateParm (PRM_Parm *)

float findKey (double t, int direction) const

PRM_ChanState getChanState (double t, bool scoped_only) const

PRM_ChanState isAtKey (double t) const

void updatePending (double t)

bool isPending (double t)

OP_Channels * getChannels (void) const

virtual void getVariableString (int index, UT_String &value, int thread)

virtual float getVariableValue (int index, int thread)

PRM_Parm & getParm (int i)

const PRM_Parm & getParm (int i) const

PRM_Parm & getParm (const char *name)

const PRM_Parm & getParm (const char *name) const

bool hasParm (const char *name) const

PRM_Parm * getParmPtrInst (const char *name, const int *inst, int nestlevel=1)

const PRM_Parm * getParmPtrInst (const char *name, const int *inst, int nestlevel=1) const

virtual PRM_ParmList * getParmList ()

virtual const PRM_ParmList * getParmList () const

virtual bool changeSpareParms (UT_IStream &ds, UT_String &errors)

bool getIsChangingSpareParms () const

virtual PRM_ParmList * createObsoleteParmList ()

virtual void resolveAndDeleteObsoleteParmList (PRM_ParmList *&obsolete_parms)

virtual void resolveObsoleteParms (PRM_ParmList *)

virtual bool getParameterOrProperty (const char *name, fpreal now, OP_Node *&op, PRM_Parm *&parm, bool create_missing_multiparms, PRM_ParmList *obsolete=0)

virtual bool getParameterOrPropertyByChannel (const char *chname, fpreal now, OP_Node *&op, PRM_Parm *&parm, int &vector_index, PRM_ParmList *obsolete=0)

bool getParameterOrPropertyOnNode (const char *name, fpreal now, OP_Node *&op, PRM_Parm *&parm, bool create_missing_multiparms, PRM_ParmList *obsolete)

bool getParameterOrPropertyOnNodeByChannel (const char *chname, fpreal now, OP_Node *&op, PRM_Parm *&parm, int &vector_index, PRM_ParmList *obsolete=0)

virtual int findParametersOrProperties (fpreal now, OP_PropertyLookupList &list)

const OP_Stat & getStat () const

OP_Stat & getStat ()

int enableParm (int pi, int state, int v=-1)

int enableParm (const char *pn, int state, int v=-1)

int enableParmInst (const char *name, const int *inst, int state, int nestlevel=1, int v=-1)

unsigned getEnableState (int pi, int v=-1)

unsigned getEnableState (const char *pn, int v=-1)

unsigned getEnableStateInst (const char *name, const int *inst, int nestlevel=1, int v=-1)

CH_StringMeaning getStringMeaning (int pi, int vi, double t)

CH_StringMeaning getStringMeaning (const char *pn, int vi, double t)

CH_StringMeaning getStringMeaningInst (const char *name, const int *inst, int vi, double t, int nest_level=1)

CH_ExprLanguage getExprLanguage () const

void setExprLanguage (CH_ExprLanguage language)

void insertMultiParmItem (const char *pn, int i)

void removeMultiParmItem (const char *pn, int i)

void updateMultiParmFromRamp (double t, const UT_Ramp &ramp, PRM_Parm &m, bool add_wrap, int harden=0)

void updateRampFromMultiParm (double t, const PRM_Parm &m, UT_Ramp &ramp, bool *time_dep=NULL)

bool convertObsAnimatedToStringExpression (PRM_ParmList *obsolete_parms, const char *pn, int vi, double t, UT_String &result, bool reset_obs)

bool expandString (UT_String &val, double t, int thread, const char *channel_name=0)

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

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

bool isParmDirty (int idx, double t)

bool isParmDirty (const char *n, double t)

bool isParmDirtyInst (const char *name, const int *inst, double t, int nestlevel=1)

void cacheParmValues (const OP_Context &context)

void clearParmCache ()

int getErrorMessages (UT_String &messages, UT_ErrorSeverity severity=UT_ERROR_NONE)

int findError (const char *type, int code) const

int removeError (int idx)

void clearDuplicateErrors ()

void opMessage (int code, const char *m=0) const

void opWarning (int code, const char *m=0) const

void opError (int code, const char *m=0) const

void opFatal (int code, const char *m=0) const

void opLocalError (int code, const char *m=0)

void opLocalWarning (int code, const char *m=0)

void opLocalDeadlockError ()

void appendError (const char *type, int code, const char *m, UT_ErrorSeverity sev)

void clearErrors ()

virtual OP_ERROR getErrorSeverity ()

bool hasDeadlockError () const

virtual OP_ERROR error ()

void stealErrors (UT_ErrorManager &src, bool borrow_only=false)

void addChannelError (const char *type, int code, const char *msg=0)

void chChanged (CH_Channel *ch, CH_CHANGE_TYPE reason)

virtual void saveParmsForUndo (bool scopedOnly=false, CH_Collection *collection=NULL)

void saveSingleParmForUndo (PRM_Parm *parm)

void saveParmForUndo (PRM_Parm *)

virtual void saveKeyFrameForUndo (CH_Channel *chp, float gtime)

virtual void clearUndoFlags ()

virtual void setAnyUndoFlag ()

int getAnyUndoPending () const

int canAccess (unsigned mask) const

bool canAccess (unsigned mask, const PRM_Parm *parm) const

bool canAccessChannel (uint mask, const CH_Channel *chp) const

void updateUserMask ()

bool canModifyFromUI (const PRM_Parm *parm, int vi) const

virtual int reloadNewFiles (float time_now)

void parmChanged (int parm_index)

void parmExprChanged (int parm_index)

void operatorDeleted ()

void saveParmCommand (ostream &os, int values=0, int defaultstoo=1, bool spareparms=true) const

int loadParmCommand (int argc, char *argv[], int docallbacks, void *data, float now, bool followchrefs, CMD_Args *args)

void commandParmCallback (void *data, float now, int argc, char *argv[], CMD_Args *args)

void saveMultiParmInstanceCommand (ostream &os, const char *opname, bool spareparms) const

virtual bool triggerParmCallback (PRM_Parm *parmptr, float now, int value, void *data)=0

virtual int64 getMemUsage (UT_Bool onlythis) const

void bumpTakeReference (int dir)

int getTakeReferences () const

void createChannelGroupsFromFolders (CH_Group &parent_group, bool only_channels, bool leaf_channels_only=false)

void getAutoScopedChannels (CH_ChannelRefList &chlist)

void getChopScopeChannels (UT_WorkBuffer &chopscope_cmd)

bool getParmIsVisible (const char *parmname)

const PRM_Template * getInterfaceParmTemplates () const

const PRM_Template * getSpareParmTemplates () const

const PRM_ScriptImports * getSpareParmTemplateImports () const

const PRM_Template * getSpareParmLayoutTemplates () const

int getSpareParmTemplatesId () const

bool hasMultiparmInfo () const

OP_MultiparmInfo & getMultiparmInfo ()

int buildVexCommand (UT_String &result, const PRM_Template *templatelist, float now, int start_parm=0, int end_parm=10000)

virtual void initMultiparmInstance (UT_PtrArray< PRM_Parm * > &parms)

virtual void addOrRemoveMultiparmInstance ()

virtual bool savePresetContents (ostream &os)

virtual bool loadPresetContents (const char *tok, UT_IStream &is)

virtual bool allowReservingParm (PRM_Parm *parm)

Parameter evaluation

int pi
Parameter index
const char *pn
Parameter name token
int *pi
Parameter index passed by reference, looked up using 'pn'
PRM_Parm *parm
Parameter by reference
int vi
Component index of a parameter
double t
Evaluation time
int thread
Thread id (ie. return value from UTgetSTID())

int evalInt (int pi, int vi, double t) const

int evalIntT (int pi, int vi, double t, int thread) const

int evalInt (const char *pn, int vi, double t) const

int evalIntT (const char *pn, int vi, double t, int thread) const

int evalInt (const char *pn, int *pi, int vi, double t) const

int evalIntT (const char *pn, int *pi, int vi, double t, int thread) const

int evalInt (PRM_Parm *parm, int vi, double t) const

int evalIntT (PRM_Parm *parm, int vi, double t, int thread) const

float evalFloat (int pi, int vi, double t) const

float evalFloatT (int pi, int vi, double t, int thread) const

float evalFloat (const char *pn, int vi, double t) const

float evalFloatT (const char *pn, int vi, double t, int thread) const

float evalFloat (const char *pn, int *pi, int vi, double t) const

float evalFloatT (const char *pn, int *pi, int vi, double t, int thread) const

float evalFloat (PRM_Parm *parm, int vi, double t) const

float evalFloatT (PRM_Parm *parm, int vi, double t, int thread) const

void evalFloats (int pi, float *v, double t) const

void evalFloatsT (int pi, float *v, double t, int thread) const

void evalFloats (const char *pn, float *v, double t) const

void evalFloatsT (const char *pn, float *v, double t, int thread) const

void evalFloats (const char *pn, int *pi, float *v, double t) const

void evalFloatsT (const char *pn, int *pi, float *v, double t, int thread) const

void evalFloats (PRM_Parm *parm, float *v, double t) const

void evalFloatsT (PRM_Parm *parm, float *v, double t, int thread) const

void evalString (UT_String &val, int pi, int vi, double t) const

void evalStringT (UT_String &val, int pi, int vi, double t, int thread) const

void evalString (UT_String &val, const char *pn, int vi, double t) const

void evalStringT (UT_String &val, const char *pn, int vi, double t, int thread) const

void evalString (UT_String &val, const char *pn, int *pi, int vi, double t) const

void evalStringT (UT_String &val, const char *pn, int *pi, int vi, double t, int thread) const

void evalString (UT_String &val, PRM_Parm *parm, int vi, double t) const

void evalStringT (UT_String &val, PRM_Parm *parm, int vi, double t, int thread) const

void evalStringRaw (UT_String &val, int pi, int vi, double t) const

void evalStringRawT (UT_String &val, int pi, int vi, double t, int thread) const

void evalStringRaw (UT_String &val, const char *pn, int vi, double t) const

void evalStringRawT (UT_String &val, const char *pn, int vi, double t, int thread) const

void evalStringRaw (UT_String &val, const char *pn, int *pi, int vi, double t) const

void evalStringRawT (UT_String &val, const char *pn, int *pi, int vi, double t, int thread) const

void evalStringRaw (UT_String &val, PRM_Parm *parm, int vi, double t) const

void evalStringRawT (UT_String &val, PRM_Parm *parm, int vi, double t, int thread) const

Multi-Parameter evaluation

name
Parameter name token
inst
Array of instance indices to evaluate at
vi
Component index of a parameter
t
Evaluation time
nestlevel
Number of entries in 'inst'
thread
Thread id (ie. return value from UTgetSTID())

int evalIntInst (const char *name, const int *inst, int vi, double t, int nestlevel=1) const

int evalIntInstT (const char *name, const int *inst, int vi, double t, int thread, int nestlevel=1) const

float evalFloatInst (const char *name, const int *inst, int vi, double t, int nestlevel=1) const

float evalFloatInstT (const char *name, const int *inst, int vi, double t, int thread, int nestlevel=1) const

void evalFloatsInst (const char *name, const int *inst, float *v, double t, int nestlevel=1) const

void evalFloatsInstT (const char *name, const int *inst, float *v, double t, int thread, int nestlevel=1) const

void evalStringInst (const char *name, const int *inst, UT_String &val, int vi, double t, int nestlevel=1) const

void evalStringInstT (const char *name, const int *inst, UT_String &val, int vi, double t, int thread, int nestlevel=1) const

void evalStringInstRaw (const char *name, const int *inst, UT_String &val, int vi, double t, int nestlevel=1) const

void evalStringInstRawT (const char *name, const int *inst, UT_String &val, int vi, double t, int thread, int nestlevel=1) const

Property evaluation

Properties will be evaluated if the parameter is not found.

parm_name
Parameter name token
vec_index
Component index of a parameter
now
Evaluation time
thread
Thread id (ie. return value from UTgetSTID())

bool evalParameterOrProperty (const char *parm_name, int vec_index, double now, int &value)

bool evalParameterOrPropertyT (const char *parm_name, int vec_index, double now, int &value, int thread)

bool evalParameterOrProperty (const char *parm_name, int vec_index, double now, float &values)

bool evalParameterOrPropertyT (const char *parm_name, int vec_index, double now, float &values, int thread)

bool evalParameterOrProperty (const char *parm_name, int vec_index, double now, UT_String &value)

bool evalParameterOrPropertyT (const char *parm_name, int vec_index, double now, UT_String &value, int thread)

bool evalParameterOrPropertyRaw (const char *parm_name, int vec_index, double now, UT_String &value)

bool evalParameterOrPropertyRawT (const char *parm_name, int vec_index, double now, UT_String &value, int thread)

bool evalParameterOrPropertyExpr (const char *parm_name, int vec_index, double now, UT_String &value)

bool evalParameterOrPropertyExprT (const char *parm_name, int vec_index, double now, UT_String &value, int thread)

bool evalVectorProperty (const char *parm_name, double now, int *values, int vec_size)

bool evalVectorPropertyT (const char *parm_name, double now, int *values, int vec_size, int thread)

bool evalVectorProperty (const char *parm_name, double now, float *values, int vec_size)

bool evalVectorPropertyT (const char *parm_name, double now, float *values, int vec_size, int thread)

Setting parameter values

pi
Parameter index
pn
Parameter name string
vi
Component index of a parameter
t
Evaluation time
val
Value to set
h
If true, it will set a keyframe if the parameter has a channel. If false, then the value will need to committed first.

void setInt (int pi, int vi, double t, int val)

void setInt (const char *pn, int vi, double t, int val)

void setInt (const char *pn, int &pi, int vi, double t, int val)

void setFloat (int pi, int vi, double t, float val, int h=0)

void setFloat (const char *pn, int vi, double t, float val, int h=0)

void setFloat (const char *pn, int &pi, int vi, double t, float val, int h=0)

void setString (const UT_String &val, CH_StringMeaning meaning, int pi, int vi, double t)

void setString (const UT_String &val, CH_StringMeaning meaning, const char *pn, int vi, double t)

void setString (const UT_String &val, CH_StringMeaning meaning, const char *pn, int &pi, int vi, double t)

Setting parameter values, following channel references

These functions will follow simple channel references first, and then set the value on the destination parameter.

pi
Parameter index
pn
Parameter name string
vi
Component index of a parameter
t
Time at which to set the value
val
Value to set
harden
If true, it will set a keyframe if the parameter has a channel. If false, then the value will need to committed first.
propagate
If true, it notify observers
thread
Thread id (ie. return value from UTgetSTID())

void setChRefInt (int pi, int vi, double t, int val, int harden=0, int propagate=1)

void setChRefInt (const char *pn, int vi, double t, int val, int harden=0, int propagate=1)

void setChRefFloat (int pi, int vi, double t, float val, int harden=0, int propagate=1)

void setChRefFloat (const char *pn, int vi, double t, float val, int harden=0, int propagate=1)

void setChRefString (const UT_String &val, CH_StringMeaning meaning, int pi, int vi, double t, int harden=0, int propagate=1)

void setChRefString (int pi, int vi, double t, const UT_String &val, CH_StringMeaning meaning, int harden=0, int propagate=1)

void setChRefString (const UT_String &val, CH_StringMeaning meaning, const char *pn, int vi, double t, int harden=0, int propagate=1)

void setChRefString (const char *pn, int vi, double t, const UT_String &val, CH_StringMeaning meaning, int harden=0, int propagate=1)

Setting property values

The setParameterOrProperty methods will track down, not only channel references, but also property parameter references. The bool result indicates whether the parameter was actually set. Some possible causes of failure are:

Parameter or property not found
Permissions error
Locked parameter
Out of bounds vector index

Parameters:

parm_name
Parameter name string
vec_index
Component index of a parameter
now
Time at which to set the value
val
Value to set
harden
If true, it will set a keyframe if the parameter has a channel. If false, then the value will need to committed first.
propagate
If true, it notify observers

bool setParameterOrProperty (const char *parm_name, int vec_index, double now, int value, bool harden=false, bool propagate=true)

bool setParameterOrProperty (const char *parm_name, int vec_index, double now, float value, bool harden=false, bool propagate=true)

bool setParameterOrProperty (const char *parm_name, int vec_index, double now, const char *value, CH_StringMeaning meaning, bool harden=false, bool propagate=true)

Multi-Parameter evaluation

name
Parameter name token
inst
Array of instance indices to evaluate at
vi
Component index of a parameter
t
Evaluation time
nestlevel
Number of entries in 'inst'
val
Value to set

void setIntInst (int val, const char *name, const int *inst, int vi, double t, int nestlevel=1)

void setFloatInst (float val, const char *name, const int *inst, int vi, double t, int nestlevel=1)

void setStringInst (const UT_String &val, CH_StringMeaning meaning, const char *name, const int *inst, int vi, double t, int nestlevel=1)

Setting parameter values silently

These methods do not trigger additional events to notify observers

int pi
Parameter index
const char *pn
Parameter name string
int &pi
Parameter index, returned from 'pn' lookup
int vi
Component index of a parameter
double t
Time at which to set the value
val
Value to set

void setSilentInt (int pi, int vi, double t, int val)

void setSilentInt (const char *pn, int vi, double t, int val)

void setSilentInt (const char *pn, int &pi, int vi, double t, int val)

void setSilentFloat (int pi, int vi, double t, float val, int h=0)

void setSilentFloat (const char *pn, int vi, double t, float val, int h=0)

void setSilentFloat (const char *pn, int &pi, int vi, double t, float val, int h=0)

void setSilentString (const UT_String &val, CH_StringMeaning meaning, int pi, int vi, double t)

void setSilentString (const UT_String &val, CH_StringMeaning meaning, const char *pn, int vi, double t)

void setSilentString (const UT_String &val, CH_StringMeaning meaning, const char *pn, int &pi, int vi, double t)

void setSilentIntInst (int val, const char *name, const int *inst, int vi, double t, int nestlevel=1)

void setSilentFloatInst (float val, const char *name, const int *inst, int vi, double t, int nestlevel=1)

void setSilentStringInst (const UT_String &val, CH_StringMeaning meaning, const char *name, const int *inst, int vi, double t, int nestlevel=1)

Static Public Member Functions

static bool followChannelReferencesOneStep (double t, OP_Node *&newop, PRM_Parm *&newparm, int &newvecidx)

static bool followChannelReferencesOneStepT (double t, OP_Node *&newop, PRM_Parm *&newparm, int &newvecidx, int thread)

static void followChannelReferences (double t, OP_Node *&newop, PRM_Parm *&newparm, int &newvecidx)

static void followChannelReferencesT (double t, OP_Node *&newop, PRM_Parm *&newparm, int &newvecidx, int thread)

static void followChannelReferences (double t, CH_ChannelRef &ref)

static void followChannelReferencesT (double t, CH_ChannelRef &ref, int thread)

static void getValueAsProcessedNodePaths (double t, UT_WorkBuffer &resultbuf, PRM_Parm *parm, int index, OP_Node *srcnode)

static void setBatchParms (PRM_BatchList &list, double now, bool create_key=false, bool create_channels=false)

static bool canSetBatchParms (PRM_BatchList &list, double now)

static void buildMParmInst (const PRM_Template *templates, UT_StringArray &mparm_inst, UT_IntArray &mparm_lvl, int level)

static bool isMParmInstance (const char *chname, const UT_StringArray &mparm_inst, const UT_IntArray &mparm_lvl)

Protected Member Functions

void saveMultiParmForUndo (int index)

void stealGlobalErrors ()

void stealErrors (OP_Parameters &src)

UT_LockedRawPtr
< UT_ErrorManager, OP_Lock > getLockedErrorManager ()

virtual void permissionError (const char *chname=0)

SYS_FORCE_INLINE bool checkExpressionError (const PRM_Parm *parm, int thread) const

void resetParmEventHandler ()

int * allocIndirect (int size=64)

OP_Parameters (const char *name, OP_Operator *entry)

OP_Parameters (const OP_Parameters &source, const char *name)

virtual ~OP_Parameters ()

void initializeParms (OP_Channels *channels)

virtual void buildOpDependencies ()

virtual void checkChannelDependencies (CH_Channel *, CH_CHANGE_TYPE)

int rename (const char *newname)

virtual bool createSpareParameterFromChannel (const char *chname)

virtual bool createSpareParametersFromChannels (UT_BitArray &selection, const CH_ChannelList &channels)

CH_LocalVariable * getVariable (int i) const

CH_LocalVariable * getVariable (const char *name) const

OP_ERROR saveChannels (ostream &os, int binary, bool compiled, int selected)

OP_ERROR saveParmChannels (int parm_index, ostream &os, int binary, bool compiled)

OP_ERROR saveParameters (ostream &os, int binary, bool compiled)

OP_ERROR saveChannelAliases (ostream &os, int binary)

bool loadChannels (UT_IStream &is, const char *path, CH_Collection *obsolete_channels)

bool loadParameters (UT_IStream &is, const char *path, PRM_ParmList *obsolete_parms)

bool loadChannelAliases (UT_IStream &is, const char *path=0)

bool loadOldSpareParms (UT_IStream &is)

virtual void opChanged (OP_EventType type, void *dataptr=0)=0

virtual void traverseScope (const char *pattern, OP_ScopeOp scope_op, const OP_ScopeOptions &scope_options)

virtual int getHasTakeData () const

Protected Attributes

PRM_ParmList * myParmList

OP_Channels * myChannels

OP_Stat myStats

Friends

class OP_TakeParm

class OP_UndoParm

class OP_UndoSpareParm

Detailed Description

Definition at line 96 of file OP_Parameters.h.

Constructor & Destructor Documentation

OP_Parameters::OP_Parameters	(	const char *	name,
		OP_Operator *	entry
	)			`[protected]`

OP_Parameters::OP_Parameters	(	const OP_Parameters &	source,
		const char *	name
	)			`[protected]`

virtual OP_Parameters::~OP_Parameters ( ) [protected, virtual]

Member Function Documentation

CH_Channel* OP_Parameters::addChannel ( const char * name )

void OP_Parameters::addChannelError	(	const char *	type,
		int	code,
		const char *	msg = `0`
	)

virtual void OP_Parameters::addOrRemoveMultiparmInstance ( ) [virtual]

Implements PRM_ParmOwner.

int* OP_Parameters::allocIndirect ( int size = 64 ) [protected]

virtual bool OP_Parameters::allowReservingParm ( PRM_Parm * parm ) [inline, virtual]

Currently overriden in VOPs. If this function returns false, the given parameter's name will never be placed in a list of reserved parms. Otherwise, it will if it is not a spare parm in PI_EditScriptedParms::initializeReserveNames().

Reimplemented in VOP_Node.

Definition at line 1103 of file OP_Parameters.h.

void OP_Parameters::animate ( const char * name )

void OP_Parameters::animate ( unsigned idx )

void OP_Parameters::appendError	(	const char *	type,
		int	code,
		const char *	m,
		UT_ErrorSeverity	sev
	)			`[inline]`

appendError() adds a generic error *directly* to this node's error manager.

Definition at line 927 of file OP_Parameters.h.

static void OP_Parameters::buildMParmInst	(	const PRM_Template *	templates,
		UT_StringArray &	mparm_inst,
		UT_IntArray &	mparm_lvl,
		int	level
	)			`[static]`

virtual void OP_Parameters::buildOpDependencies ( ) [inline, protected, virtual]

Reimplemented in CHOP_Node, OP_Network, OP_Node, SOP_CaptureEdit, SOP_CaptureLayerPaint, and SOP_CaptureOverride.

Definition at line 1150 of file OP_Parameters.h.

int OP_Parameters::buildVexCommand	(	UT_String &	result,
		const PRM_Template *	templatelist,
		float	now,
		int	start_parm = `0`,
		int	end_parm = `10000`
	)

Examples:: SOP/SOP_PrimVOP.C.

void OP_Parameters::bumpTakeReference ( int dir ) [inline]

Definition at line 1033 of file OP_Parameters.h.

void OP_Parameters::cacheParmValues ( const OP_Context & context )

bool OP_Parameters::canAccess	(	unsigned	mask,
		const PRM_Parm *	parm
	)			const

int OP_Parameters::canAccess ( unsigned mask ) const

Examples:: HOM/ObjNode_setSelectable.C.

bool OP_Parameters::canAccessChannel	(	uint	mask,
		const CH_Channel *	chp
	)			const

bool OP_Parameters::canModifyFromUI	(	const PRM_Parm *	parm,
		int	vi
	)			const

static bool OP_Parameters::canSetBatchParms	(	PRM_BatchList &	list,
		double	now
	)			`[static]`

virtual bool OP_Parameters::changeSpareParms	(	UT_IStream &	ds,
		UT_String &	errors
	)			`[virtual]`

Reimplemented in OP_Director, and OP_Node.

virtual int OP_Parameters::changeString	(	const char *	from,
		const char *	to,
		bool	fullword
	)			`[virtual]`

Reimplemented in OP_Node, and SOP_CaptureBase.

void OP_Parameters::chChanged	(	CH_Channel *	ch,
		CH_CHANGE_TYPE	reason
	)

virtual void OP_Parameters::checkChannelDependencies	(	CH_Channel *	,
		CH_CHANGE_TYPE
	)			`[inline, protected, virtual]`

Reimplemented in OBJ_Muscle, OP_Node, and SOP_Muscle.

Definition at line 1152 of file OP_Parameters.h.

unsigned OP_Parameters::checkDisableForParm	(	PRM_Parm &	parm,
		const UT_StringArray *	skipparms
	)

SYS_FORCE_INLINE bool OP_Parameters::checkExpressionError	(	const PRM_Parm *	parm,
		int	thread
	)			const `[inline, protected]`

Definition at line 1125 of file OP_Parameters.h.

void OP_Parameters::clearDuplicateErrors ( ) [inline]

Definition at line 894 of file OP_Parameters.h.

void OP_Parameters::clearErrors ( ) [inline]

Examples:: SOP/SOP_BlindData.C.

Definition at line 938 of file OP_Parameters.h.

void OP_Parameters::clearParmCache ( )

virtual void OP_Parameters::clearUndoFlags ( ) [virtual]

Reimplemented in OBJ_Node, OP_Network, and OP_Node.

void OP_Parameters::commandParmCallback	(	void *	data,
		float	now,
		int	argc,
		char *	argv[],
		CMD_Args *	args
	)

bool OP_Parameters::convertObsAnimatedToStringExpression	(	PRM_ParmList *	obsolete_parms,
		const char *	pn,
		int	vi,
		double	t,
		UT_String &	result,
		bool	reset_obs
	)

void OP_Parameters::createChannelGroupsFromFolders	(	CH_Group &	parent_group,
		bool	only_channels,
		bool	leaf_channels_only = `false`
	)

This method will create channel groups and populate them with channels from this operator. The channel groups created will correspond to the folders in this operator's parameters. Unless only_channels is specified, all auto-scoped parms will get included.

virtual PRM_ParmList* OP_Parameters::createObsoleteParmList ( ) [virtual]

Implements PRM_ParmOwner.

Reimplemented in OP_Node.

virtual bool OP_Parameters::createSpareParameterFromChannel ( const char * chname ) [protected, virtual]

virtual bool OP_Parameters::createSpareParametersFromChannels	(	UT_BitArray &	selection,
		const CH_ChannelList &	channels
	)			`[protected, virtual]`

Reimplemented in OBJ_DopNet, OBJ_Node, and SHOP_Node.

void OP_Parameters::deAnimate ( const char * name )

void OP_Parameters::deAnimate ( unsigned idx )

int OP_Parameters::destroyChannel ( const char * name )

virtual unsigned OP_Parameters::disableParms ( ) [virtual]

Reimplemented in CHOP_Channel, CHOP_Node, COP2_ChromaKey, COP2_ColorCurve, COP2_Generator, COP2_LumaKey, COP2_MaskOp, COP2_Node, COP2_PixelBase, COP2_PixelOp, COP2_Ramp, COP2_RotoShape, DOP_AutoRelType, DOP_AutoSolver, OBJ_Blend, OBJ_Camera, OBJ_DopNet, OBJ_Fetch, OBJ_Geometry, OBJ_Handle, OBJ_Light, OBJ_Microphone, OBJ_Muscle, OBJ_Node, OBJ_Null, OBJ_Rivet, OBJ_SopNet, OBJ_Sound, ROP_IFD, ROP_IFDBase, ROP_Node, SOP_AttribComp, SOP_BlendShapes, SOP_Capture, SOP_CaptureEdit, SOP_CaptureLayerPaint, SOP_CaptureOverride, SOP_Circle, SOP_Comb, SOP_Curve, SOP_Each, SOP_Edit, SOP_ForEach, SOP_Lattice, SOP_MDD, SOP_Muscle, SOP_Paint, SOP_Pelt, SOP_PolyKnit, SOP_PolySplit, SOP_Reverse, SOP_SlideModifierPaint, SOP_UVBrush, SOP_UVEdit, SOP_UVFuse, SOP_UVTransform, VOP_OutputVar, VOP_Parameter, VOP_Properties, VOP_ScriptNode, HDK_Sample::CHOP_Blend, HDK_Sample::CHOP_Spring, HDK_Sample::CHOP_Stair, HDK_Sample::POP_CircleForce, HDK_Sample::POP_LocalForce, HDK_Sample::POP_RadialBirth, HDK_Sample::SOP_BrushHairLen, HDK_Sample::SOP_CopRaster, HDK_Sample::SOP_DetailAttrib, HDK_Sample::SOP_Flatten, HDK_Sample::SOP_GroupRename, HDK_Sample::SOP_HDKObject, HDK_Sample::SOP_NURBS, HDK_Sample::SOP_PrimVOP, HDK_Sample::SOP_SParticle, HDK_Sample::SOP_Star, HDK_Sample::SOP_Surface, and HDK_Sample::VOP_Switch.

unsigned OP_Parameters::disableParmsAndSpareParms ( )

int OP_Parameters::enableParm	(	const char *	pn,
		int	state,
		int	v = `-1`
	)

int OP_Parameters::enableParm	(	int	pi,
		int	state,
		int	v = `-1`
	)

Examples:: CHOP/CHOP_Blend.C, CHOP/CHOP_Spring.C, CHOP/CHOP_Stair.C, POP/POP_CircleForce.C, POP/POP_LocalForce.C, SOP/SOP_CopRaster.C, SOP/SOP_Flatten.C, and VOP/VOP_Switch.C.

int OP_Parameters::enableParmInst	(	const char *	name,
		const int *	inst,
		int	state,
		int	nestlevel = `1`,
		int	v = `-1`
	)

Examples:: SOP/SOP_HDKObject.C.

virtual OP_ERROR OP_Parameters::error ( ) [inline, virtual]

float OP_Parameters::evalFloat	(	PRM_Parm *	parm,
		int	vi,
		double	t
	)			const `[inline]`

Definition at line 339 of file OP_Parameters.h.

float OP_Parameters::evalFloat	(	const char *	pn,
		int *	pi,
		int	vi,
		double	t
	)			const `[inline]`

Definition at line 334 of file OP_Parameters.h.

float OP_Parameters::evalFloat	(	const char *	pn,
		int	vi,
		double	t
	)			const `[inline]`

Definition at line 330 of file OP_Parameters.h.

float OP_Parameters::evalFloat	(	int	pi,
		int	vi,
		double	t
	)			const `[inline]`

float OP_Parameters::evalFloatInst	(	const char *	name,
		const int *	inst,
		int	vi,
		double	t,
		int	nestlevel = `1`
	)			const `[inline]`

Definition at line 445 of file OP_Parameters.h.

float OP_Parameters::evalFloatInstT	(	const char *	name,
		const int *	inst,
		int	vi,
		double	t,
		int	thread,
		int	nestlevel = `1`
	)			const

void OP_Parameters::evalFloats	(	PRM_Parm *	parm,
		float *	v,
		double	t
	)			const `[inline]`

Definition at line 358 of file OP_Parameters.h.

void OP_Parameters::evalFloats	(	const char *	pn,
		int *	pi,
		float *	v,
		double	t
	)			const `[inline]`

Definition at line 353 of file OP_Parameters.h.

void OP_Parameters::evalFloats	(	const char *	pn,
		float *	v,
		double	t
	)			const `[inline]`

Definition at line 349 of file OP_Parameters.h.

void OP_Parameters::evalFloats	(	int	pi,
		float *	v,
		double	t
	)			const `[inline]`

Examples:: SOP/SOP_IKSample.h.

Definition at line 345 of file OP_Parameters.h.

void OP_Parameters::evalFloatsInst	(	const char *	name,
		const int *	inst,
		float *	v,
		double	t,
		int	nestlevel = `1`
	)			const `[inline]`

Definition at line 454 of file OP_Parameters.h.

void OP_Parameters::evalFloatsInstT	(	const char *	name,
		const int *	inst,
		float *	v,
		double	t,
		int	thread,
		int	nestlevel = `1`
	)			const

void OP_Parameters::evalFloatsT	(	PRM_Parm *	parm,
		float *	v,
		double	t,
		int	thread
	)			const

void OP_Parameters::evalFloatsT	(	const char *	pn,
		int *	pi,
		float *	v,
		double	t,
		int	thread
	)			const

void OP_Parameters::evalFloatsT	(	const char *	pn,
		float *	v,
		double	t,
		int	thread
	)			const

void OP_Parameters::evalFloatsT	(	int	pi,
		float *	v,
		double	t,
		int	thread
	)			const

float OP_Parameters::evalFloatT	(	PRM_Parm *	parm,
		int	vi,
		double	t,
		int	thread
	)			const

float OP_Parameters::evalFloatT	(	const char *	pn,
		int *	pi,
		int	vi,
		double	t,
		int	thread
	)			const

float OP_Parameters::evalFloatT	(	const char *	pn,
		int	vi,
		double	t,
		int	thread
	)			const

float OP_Parameters::evalFloatT	(	int	pi,
		int	vi,
		double	t,
		int	thread
	)			const

int OP_Parameters::evalInt	(	PRM_Parm *	parm,
		int	vi,
		double	t
	)			const `[inline]`

Definition at line 322 of file OP_Parameters.h.

int OP_Parameters::evalInt	(	const char *	pn,
		int *	pi,
		int	vi,
		double	t
	)			const `[inline]`

Definition at line 318 of file OP_Parameters.h.

int OP_Parameters::evalInt	(	const char *	pn,
		int	vi,
		double	t
	)			const `[inline]`

Definition at line 314 of file OP_Parameters.h.

int OP_Parameters::evalInt	(	int	pi,
		int	vi,
		double	t
	)			const `[inline]`

Examples:: CHOP/CHOP_Blend.h, CHOP/CHOP_Spring.h, CHOP/CHOP_Stair.h, COP2/COP2_MultiInputWipe.C, COP2/COP2_SampleGenerator.h, DOP/DOP_GroupAndApply.C, SOP/SOP_BrushHairLen.C, SOP/SOP_CopRaster.h, SOP/SOP_CustomBrush.h, SOP/SOP_Flatten.h, SOP/SOP_HDKObject.h, SOP/SOP_IKSample.h, SOP/SOP_NURBS.h, SOP/SOP_PrimVOP.h, SOP/SOP_Star.h, VOP/VOP_CustomContext.C, and VOP/VOP_Switch.C.

Definition at line 311 of file OP_Parameters.h.

int OP_Parameters::evalIntInst	(	const char *	name,
		const int *	inst,
		int	vi,
		double	t,
		int	nestlevel = `1`
	)			const `[inline]`

Examples:: SOP/SOP_HDKObject.h.

Definition at line 436 of file OP_Parameters.h.

int OP_Parameters::evalIntInstT	(	const char *	name,
		const int *	inst,
		int	vi,
		double	t,
		int	thread,
		int	nestlevel = `1`
	)			const

int OP_Parameters::evalIntT	(	PRM_Parm *	parm,
		int	vi,
		double	t,
		int	thread
	)			const

int OP_Parameters::evalIntT	(	const char *	pn,
		int *	pi,
		int	vi,
		double	t,
		int	thread
	)			const

int OP_Parameters::evalIntT	(	const char *	pn,
		int	vi,
		double	t,
		int	thread
	)			const

int OP_Parameters::evalIntT	(	int	pi,
		int	vi,
		double	t,
		int	thread
	)			const

bool OP_Parameters::evalParameterOrProperty	(	const char *	parm_name,
		int	vec_index,
		double	now,
		UT_String &	value
	)			`[inline]`

Definition at line 521 of file OP_Parameters.h.

bool OP_Parameters::evalParameterOrProperty	(	const char *	parm_name,
		int	vec_index,
		double	now,
		float &	values
	)			`[inline]`

Definition at line 509 of file OP_Parameters.h.

bool OP_Parameters::evalParameterOrProperty	(	const char *	parm_name,
		int	vec_index,
		double	now,
		int &	value
	)			`[inline]`

Definition at line 496 of file OP_Parameters.h.

bool OP_Parameters::evalParameterOrPropertyExpr	(	const char *	parm_name,
		int	vec_index,
		double	now,
		UT_String &	value
	)			`[inline]`

Definition at line 547 of file OP_Parameters.h.

bool OP_Parameters::evalParameterOrPropertyExprT	(	const char *	parm_name,
		int	vec_index,
		double	now,
		UT_String &	value,
		int	thread
	)

bool OP_Parameters::evalParameterOrPropertyRaw	(	const char *	parm_name,
		int	vec_index,
		double	now,
		UT_String &	value
	)			`[inline]`

Definition at line 534 of file OP_Parameters.h.

bool OP_Parameters::evalParameterOrPropertyRawT	(	const char *	parm_name,
		int	vec_index,
		double	now,
		UT_String &	value,
		int	thread
	)

bool OP_Parameters::evalParameterOrPropertyT	(	const char *	parm_name,
		int	vec_index,
		double	now,
		UT_String &	value,
		int	thread
	)

bool OP_Parameters::evalParameterOrPropertyT	(	const char *	parm_name,
		int	vec_index,
		double	now,
		float &	values,
		int	thread
	)

bool OP_Parameters::evalParameterOrPropertyT	(	const char *	parm_name,
		int	vec_index,
		double	now,
		int &	value,
		int	thread
	)

void OP_Parameters::evalString	(	UT_String &	val,
		PRM_Parm *	parm,
		int	vi,
		double	t
	)			const `[inline]`

Definition at line 383 of file OP_Parameters.h.

void OP_Parameters::evalString	(	UT_String &	val,
		const char *	pn,
		int *	pi,
		int	vi,
		double	t
	)			const `[inline]`

Definition at line 375 of file OP_Parameters.h.

void OP_Parameters::evalString	(	UT_String &	val,
		const char *	pn,
		int	vi,
		double	t
	)			const `[inline]`

Definition at line 370 of file OP_Parameters.h.

void OP_Parameters::evalString	(	UT_String &	val,
		int	pi,
		int	vi,
		double	t
	)			const `[inline]`

Examples:: CHOP/CHOP_Stair.h, DOP/DOP_GroupAndApply.C, SOP/SOP_CopRaster.h, SOP/SOP_DetailAttrib.h, SOP/SOP_Flatten.h, SOP/SOP_GroupRename.h, SOP/SOP_HDKObject.h, SOP/SOP_PointWave.h, SOP/SOP_PrimVOP.h, and SOP/SOP_TimeCompare.h.

Definition at line 365 of file OP_Parameters.h.

void OP_Parameters::evalStringInst	(	const char *	name,
		const int *	inst,
		UT_String &	val,
		int	vi,
		double	t,
		int	nestlevel = `1`
	)			const `[inline]`

Examples:: SOP/SOP_HDKObject.h, and VOP/VOP_CustomContext.C.

Definition at line 464 of file OP_Parameters.h.

void OP_Parameters::evalStringInstRaw	(	const char *	name,
		const int *	inst,
		UT_String &	val,
		int	vi,
		double	t,
		int	nestlevel = `1`
	)			const `[inline]`

Definition at line 474 of file OP_Parameters.h.

void OP_Parameters::evalStringInstRawT	(	const char *	name,
		const int *	inst,
		UT_String &	val,
		int	vi,
		double	t,
		int	thread,
		int	nestlevel = `1`
	)			const

void OP_Parameters::evalStringInstT	(	const char *	name,
		const int *	inst,
		UT_String &	val,
		int	vi,
		double	t,
		int	thread,
		int	nestlevel = `1`
	)			const

void OP_Parameters::evalStringRaw	(	UT_String &	val,
		PRM_Parm *	parm,
		int	vi,
		double	t
	)			const `[inline]`

Definition at line 417 of file OP_Parameters.h.

void OP_Parameters::evalStringRaw	(	UT_String &	val,
		const char *	pn,
		int *	pi,
		int	vi,
		double	t
	)			const `[inline]`

Definition at line 409 of file OP_Parameters.h.

void OP_Parameters::evalStringRaw	(	UT_String &	val,
		const char *	pn,
		int	vi,
		double	t
	)			const `[inline]`

Definition at line 401 of file OP_Parameters.h.

void OP_Parameters::evalStringRaw	(	UT_String &	val,
		int	pi,
		int	vi,
		double	t
	)			const `[inline]`

Definition at line 393 of file OP_Parameters.h.

void OP_Parameters::evalStringRawT	(	UT_String &	val,
		PRM_Parm *	parm,
		int	vi,
		double	t,
		int	thread
	)			const

void OP_Parameters::evalStringRawT	(	UT_String &	val,
		const char *	pn,
		int *	pi,
		int	vi,
		double	t,
		int	thread
	)			const

void OP_Parameters::evalStringRawT	(	UT_String &	val,
		const char *	pn,
		int	vi,
		double	t,
		int	thread
	)			const

void OP_Parameters::evalStringRawT	(	UT_String &	val,
		int	pi,
		int	vi,
		double	t,
		int	thread
	)			const

void OP_Parameters::evalStringT	(	UT_String &	val,
		PRM_Parm *	parm,
		int	vi,
		double	t,
		int	thread
	)			const

void OP_Parameters::evalStringT	(	UT_String &	val,
		const char *	pn,
		int *	pi,
		int	vi,
		double	t,
		int	thread
	)			const

void OP_Parameters::evalStringT	(	UT_String &	val,
		const char *	pn,
		int	vi,
		double	t,
		int	thread
	)			const

void OP_Parameters::evalStringT	(	UT_String &	val,
		int	pi,
		int	vi,
		double	t,
		int	thread
	)			const

bool OP_Parameters::evalVectorProperty	(	const char *	parm_name,
		double	now,
		float *	values,
		int	vec_size
	)			`[inline]`

Definition at line 574 of file OP_Parameters.h.

bool OP_Parameters::evalVectorProperty	(	const char *	parm_name,
		double	now,
		int *	values,
		int	vec_size
	)			`[inline]`

Definition at line 561 of file OP_Parameters.h.

bool OP_Parameters::evalVectorPropertyT	(	const char *	parm_name,
		double	now,
		float *	values,
		int	vec_size,
		int	thread
	)

bool OP_Parameters::evalVectorPropertyT	(	const char *	parm_name,
		double	now,
		int *	values,
		int	vec_size,
		int	thread
	)

bool OP_Parameters::expandString	(	UT_String &	val,
		double	t,
		int	thread,
		const char *	channel_name = `0`
	)

Expand expressions within string value.

This method will expand backtick expressions and local/global variables by modifying the input string. Always use this method instead of calling CH_Manager::expandString() directly within node evaluation code paths in order to establish proper node dependencies.

Parameters:

channel_name

Channel name of the parameter from where val was obtained from. This is important for establishing data and time dependencies.

int OP_Parameters::findError	(	const char *	type,
		int	code
	)			const `[inline]`

Definition at line 882 of file OP_Parameters.h.

float OP_Parameters::findKey	(	double	t,
		int	direction
	)			const

virtual int OP_Parameters::findParametersOrProperties	(	fpreal	now,
		OP_PropertyLookupList &	list
	)			`[virtual]`

Fill out the property lookup list with parameters. Returns the total of found and resolved parameters in the list (whether they were resolved by previous calls or this particular call, ie, NOT the total of nodes found in this call)

Reimplemented in OBJ_Node.

virtual int OP_Parameters::findString	(	const char *	str,
		bool	fullword,
		bool	usewildcards
	)			const `[virtual]`

Reimplemented in OP_Node.

static void OP_Parameters::followChannelReferences	(	double	t,
		CH_ChannelRef &	ref
	)			`[inline, static]`

Definition at line 270 of file OP_Parameters.h.

static void OP_Parameters::followChannelReferences	(	double	t,
		OP_Node *&	newop,
		PRM_Parm *&	newparm,
		int &	newvecidx
	)			`[inline, static]`

Definition at line 258 of file OP_Parameters.h.

static bool OP_Parameters::followChannelReferencesOneStep	(	double	t,
		OP_Node *&	newop,
		PRM_Parm *&	newparm,
		int &	newvecidx
	)			`[inline, static]`

Definition at line 244 of file OP_Parameters.h.

static bool OP_Parameters::followChannelReferencesOneStepT	(	double	t,
		OP_Node *&	newop,
		PRM_Parm *&	newparm,
		int &	newvecidx,
		int	thread
	)			`[static]`

static void OP_Parameters::followChannelReferencesT	(	double	t,
		CH_ChannelRef &	ref,
		int	thread
	)			`[static]`

static void OP_Parameters::followChannelReferencesT	(	double	t,
		OP_Node *&	newop,
		PRM_Parm *&	newparm,
		int &	newvecidx,
		int	thread
	)			`[static]`

int OP_Parameters::getAnyUndoPending ( ) const [inline]

Definition at line 988 of file OP_Parameters.h.

void OP_Parameters::getAutoScopedChannels ( CH_ChannelRefList & chlist )

const CH_Channel* OP_Parameters::getChannel ( const char * name ) const

CH_Channel* OP_Parameters::getChannel ( const char * name )

OP_Channels* OP_Parameters::getChannels ( void ) const [inline]

Examples:: expr/functions.C, and SOP/SOP_PrimVOP.C.

Definition at line 160 of file OP_Parameters.h.

PRM_ChanState OP_Parameters::getChanState	(	double	t,
		bool	scoped_only
	)			const

void OP_Parameters::getChopScopeChannels ( UT_WorkBuffer & chopscope_cmd )

unsigned OP_Parameters::getEnableState	(	const char *	pn,
		int	v = `-1`
	)

unsigned OP_Parameters::getEnableState	(	int	pi,
		int	v = `-1`
	)

unsigned OP_Parameters::getEnableStateInst	(	const char *	name,
		const int *	inst,
		int	nestlevel = `1`,
		int	v = `-1`
	)

int OP_Parameters::getErrorMessages	(	UT_String &	messages,
		UT_ErrorSeverity	severity = `UT_ERROR_NONE`
	)			`[inline]`

Definition at line 872 of file OP_Parameters.h.

virtual OP_ERROR OP_Parameters::getErrorSeverity ( ) [inline, virtual]

Reimplemented in COP2_Node.

Definition at line 944 of file OP_Parameters.h.

CH_ExprLanguage OP_Parameters::getExprLanguage ( ) const [virtual]

Implements PRM_ParmOwner.

virtual void OP_Parameters::getFullPath ( UT_String & str ) const [virtual]

Implements PRM_ParmOwner.

Reimplemented in OP_Node.

virtual int OP_Parameters::getHasTakeData ( ) const [inline, protected, virtual]

Reimplemented in OP_Node.

Definition at line 1194 of file OP_Parameters.h.

const PRM_Template* OP_Parameters::getInterfaceParmTemplates ( ) const

bool OP_Parameters::getIsChangingSpareParms ( ) const [inline]

Definition at line 195 of file OP_Parameters.h.

UT_LockedRawPtr<UT_ErrorManager,OP_Lock> OP_Parameters::getLockedErrorManager ( ) [inline, protected]

Definition at line 1114 of file OP_Parameters.h.

virtual int64 OP_Parameters::getMemUsage ( UT_Bool onlythis ) const [virtual]

Reimplemented in OP_Node.

OP_MultiparmInfo& OP_Parameters::getMultiparmInfo ( )

const UT_String& OP_Parameters::getName ( void ) const [inline]

Examples:: ROP/ROP_Dumper.C, SOP/SOP_BlindData.C, SOP/SOP_CustomBrush.C, and standalone/traverse.C.

Definition at line 99 of file OP_Parameters.h.

OP_Operator* OP_Parameters::getOperator ( ) const [inline]

Examples:: expr/functions.C, and VOP/VOP_CustomContext.C.

Definition at line 100 of file OP_Parameters.h.

virtual bool OP_Parameters::getParameterOrProperty	(	const char *	name,
		fpreal	now,
		OP_Node *&	op,
		PRM_Parm *&	parm,
		bool	create_missing_multiparms,
		PRM_ParmList *	obsolete = `0`
	)			`[virtual]`

Reimplemented in OBJ_Node.

virtual bool OP_Parameters::getParameterOrPropertyByChannel	(	const char *	chname,
		fpreal	now,
		OP_Node *&	op,
		PRM_Parm *&	parm,
		int &	vector_index,
		PRM_ParmList *	obsolete = `0`
	)			`[virtual]`

Reimplemented in OBJ_Node.

bool OP_Parameters::getParameterOrPropertyOnNode	(	const char *	name,
		fpreal	now,
		OP_Node *&	op,
		PRM_Parm *&	parm,
		bool	create_missing_multiparms,
		PRM_ParmList *	obsolete
	)

bool OP_Parameters::getParameterOrPropertyOnNodeByChannel	(	const char *	chname,
		fpreal	now,
		OP_Node *&	op,
		PRM_Parm *&	parm,
		int &	vector_index,
		PRM_ParmList *	obsolete = `0`
	)

const PRM_Parm& OP_Parameters::getParm ( const char * name ) const [inline]

Definition at line 174 of file OP_Parameters.h.

PRM_Parm& OP_Parameters::getParm ( const char * name ) [inline]

Definition at line 172 of file OP_Parameters.h.

const PRM_Parm& OP_Parameters::getParm ( int i ) const [inline]

Definition at line 170 of file OP_Parameters.h.

PRM_Parm& OP_Parameters::getParm ( int i ) [inline]

Definition at line 168 of file OP_Parameters.h.

bool OP_Parameters::getParmIsVisible ( const char * parmname )

virtual const PRM_ParmList* OP_Parameters::getParmList ( ) const [inline, virtual]

Implements PRM_ParmOwner.

Definition at line 185 of file OP_Parameters.h.

virtual PRM_ParmList* OP_Parameters::getParmList ( ) [inline, virtual]

Implements PRM_ParmOwner.

Examples:: SOP/MSS_CustomBrushState.C.

Definition at line 183 of file OP_Parameters.h.

const PRM_Parm* OP_Parameters::getParmPtrInst	(	const char *	name,
		const int *	inst,
		int	nestlevel = `1`
	)			const

PRM_Parm* OP_Parameters::getParmPtrInst	(	const char *	name,
		const int *	inst,
		int	nestlevel = `1`
	)

const PRM_Template* OP_Parameters::getSpareParmLayoutTemplates ( ) const

const PRM_ScriptImports* OP_Parameters::getSpareParmTemplateImports ( ) const

const PRM_Template* OP_Parameters::getSpareParmTemplates ( ) const

Examples:: SOP/SOP_PrimVOP.C.

int OP_Parameters::getSpareParmTemplatesId ( ) const

OP_Stat& OP_Parameters::getStat ( ) [inline]

Definition at line 283 of file OP_Parameters.h.

const OP_Stat& OP_Parameters::getStat ( ) const [inline]

Definition at line 282 of file OP_Parameters.h.

CH_StringMeaning OP_Parameters::getStringMeaning	(	const char *	pn,
		int	vi,
		double	t
	)

CH_StringMeaning OP_Parameters::getStringMeaning	(	int	pi,
		int	vi,
		double	t
	)

CH_StringMeaning OP_Parameters::getStringMeaningInst	(	const char *	name,
		const int *	inst,
		int	vi,
		double	t,
		int	nest_level = `1`
	)

int OP_Parameters::getTakeReferences ( ) const [inline]

Definition at line 1035 of file OP_Parameters.h.

static void OP_Parameters::getValueAsProcessedNodePaths	(	double	t,
		UT_WorkBuffer &	resultbuf,
		PRM_Parm *	parm,
		int	index,
		OP_Node *	srcnode
	)			`[static]`

CH_LocalVariable* OP_Parameters::getVariable ( const char * name ) const [protected]

CH_LocalVariable* OP_Parameters::getVariable ( int i ) const [protected]

virtual void OP_Parameters::getVariableString	(	int	index,
		UT_String &	value,
		int	thread
	)			`[virtual]`

Reimplemented in DOP_Auto, DOP_Node, DOP_SubNet, OBJ_DopNet, SHOP_Node, SOP_Node, VOPNET_Node, and HDK_Sample::SOP_PrimVOP.

virtual float OP_Parameters::getVariableValue	(	int	index,
		int	thread
	)			`[virtual]`

Reimplemented in CHOP_Channel, COP2_Node, DOP_Auto, DOP_Node, DOP_SubNet, OBJ_Node, POP_GenVar, POP_LocalVar, ROP_Node, SOP_Node, SOP_UVTransform, HDK_Sample::CHOP_Spring, HDK_Sample::CHOP_Stair, and HDK_Sample::SOP_Star.

bool OP_Parameters::hasDeadlockError ( ) const [inline]

Definition at line 949 of file OP_Parameters.h.

bool OP_Parameters::hasMultiparmInfo ( ) const

bool OP_Parameters::hasParm ( const char * name ) const [inline]

Definition at line 176 of file OP_Parameters.h.

void OP_Parameters::initializeParms ( OP_Channels * channels ) [protected]

virtual void OP_Parameters::initMultiparmInstance ( UT_PtrArray< PRM_Parm * > & parms ) [virtual]

Implements PRM_ParmOwner.

void OP_Parameters::insertMultiParmItem	(	const char *	pn,
		int	i
	)

PRM_ChanState OP_Parameters::isAtKey ( double t ) const [inline]

Definition at line 155 of file OP_Parameters.h.

static bool OP_Parameters::isMParmInstance	(	const char *	chname,
		const UT_StringArray &	mparm_inst,
		const UT_IntArray &	mparm_lvl
	)			`[static]`

bool OP_Parameters::isObsoleteChannel ( const char * name ) const

bool OP_Parameters::isParmDirty	(	const char *	n,
		double	t
	)

bool OP_Parameters::isParmDirty	(	int	idx,
		double	t
	)

Examples:: SOP/SOP_BrushHairLen.C.

bool OP_Parameters::isParmDirtyInst	(	const char *	name,
		const int *	inst,
		double	t,
		int	nestlevel = `1`
	)

bool OP_Parameters::isPending ( double t )

bool OP_Parameters::loadChannelAliases	(	UT_IStream &	is,
		const char *	path = `0`
	)			`[protected]`

bool OP_Parameters::loadChannels	(	UT_IStream &	is,
		const char *	path,
		CH_Collection *	obsolete_channels
	)			`[protected]`

bool OP_Parameters::loadOldSpareParms ( UT_IStream & is ) [protected]

bool OP_Parameters::loadParameters	(	UT_IStream &	is,
		const char *	path,
		PRM_ParmList *	obsolete_parms
	)			`[protected]`

int OP_Parameters::loadParmCommand	(	int	argc,
		char *	argv[],
		int	docallbacks,
		void *	data,
		float	now,
		bool	followchrefs,
		CMD_Args *	args
	)

virtual bool OP_Parameters::loadPresetContents	(	const char *	tok,
		UT_IStream &	is
	)			`[virtual]`

Implements PRM_ParmOwner.

virtual void OP_Parameters::opChanged	(	OP_EventType	type,
		void *	dataptr = `0`
	)			`[protected, pure virtual]`

Implemented in CHOP_Node, COP2_Node, DOP_Node, OBJ_DopNet, OBJ_Node, OBJ_SubNet, OP_Node, POPNET_Node, SHOP_VariableInput, SOP_Node, VOP_Node, VOP_ParmGenerator, VOP_Properties, VOPNET_Node, and HDK_Sample::SOP_PrimVOP.

void OP_Parameters::operatorDeleted ( )

void OP_Parameters::opError	(	int	code,
		const char *	m = `0`
	)			const `[inline]`

Definition at line 904 of file OP_Parameters.h.

void OP_Parameters::opFatal	(	int	code,
		const char *	m = `0`
	)			const `[inline]`

Definition at line 906 of file OP_Parameters.h.

void OP_Parameters::opLocalDeadlockError ( ) [inline]

Definition at line 919 of file OP_Parameters.h.

void OP_Parameters::opLocalError	(	int	code,
		const char *	m = `0`
	)			`[inline]`

Definition at line 909 of file OP_Parameters.h.

void OP_Parameters::opLocalWarning	(	int	code,
		const char *	m = `0`
	)			`[inline]`

Definition at line 914 of file OP_Parameters.h.

void OP_Parameters::opMessage	(	int	code,
		const char *	m = `0`
	)			const `[inline]`

Definition at line 900 of file OP_Parameters.h.

void OP_Parameters::opWarning	(	int	code,
		const char *	m = `0`
	)			const `[inline]`

Definition at line 902 of file OP_Parameters.h.

void OP_Parameters::parmChanged ( int parm_index )

void OP_Parameters::parmExprChanged ( int parm_index )

virtual void OP_Parameters::permissionError ( const char * chname = 0 ) [protected, virtual]

Reimplemented in OP_Node.

virtual unsigned OP_Parameters::referenceAllParameters ( OP_Parameters * from ) [virtual]

Reimplemented in COP2_Node.

virtual int OP_Parameters::reloadNewFiles ( float time_now ) [virtual]

Reimplemented in SOP_MDD.

int OP_Parameters::removeError ( int idx ) [inline]

Definition at line 888 of file OP_Parameters.h.

void OP_Parameters::removeMultiParmItem	(	const char *	pn,
		int	i
	)

int OP_Parameters::rename ( const char * newname ) [protected]

void OP_Parameters::resetParmEventHandler ( ) [protected]

virtual void OP_Parameters::resolveAndDeleteObsoleteParmList ( PRM_ParmList *& obsolete_parms ) [virtual]

Implements PRM_ParmOwner.

Reimplemented in OP_Node.

virtual void OP_Parameters::resolveObsoleteParms ( PRM_ParmList * ) [inline, virtual]

Reimplemented in OBJ_Blend, OBJ_Fetch, OBJ_Geometry, OBJ_Handle, OBJ_Light, OBJ_Microphone, OBJ_Node, OBJ_Sound, POPNET_Node, SOP_BlendShapes, SOP_CaptureBase, SOP_CaptureRegion, SOP_Edit, SOP_UVTransform, and VOPNET_Node.

Definition at line 206 of file OP_Parameters.h.

OP_ERROR OP_Parameters::saveChannelAliases	(	ostream &	os,
		int	binary
	)			`[protected]`

OP_ERROR OP_Parameters::saveChannels	(	ostream &	os,
		int	binary,
		bool	compiled,
		int	selected
	)			`[protected]`

virtual void OP_Parameters::saveKeyFrameForUndo	(	CH_Channel *	chp,
		float	gtime
	)			`[virtual]`

void OP_Parameters::saveMultiParmForUndo ( int index ) [protected]

void OP_Parameters::saveMultiParmInstanceCommand	(	ostream &	os,
		const char *	opname,
		bool	spareparms
	)			const

OP_ERROR OP_Parameters::saveParameters	(	ostream &	os,
		int	binary,
		bool	compiled
	)			`[protected]`

OP_ERROR OP_Parameters::saveParmChannels	(	int	parm_index,
		ostream &	os,
		int	binary,
		bool	compiled
	)			`[protected]`

void OP_Parameters::saveParmCommand	(	ostream &	os,
		int	values = `0`,
		int	defaultstoo = `1`,
		bool	spareparms = `true`
	)			const

void OP_Parameters::saveParmForUndo ( PRM_Parm * )

virtual void OP_Parameters::saveParmsForUndo	(	bool	scopedOnly = `false`,
		CH_Collection *	collection = `NULL`
	)			`[virtual]`

virtual bool OP_Parameters::savePresetContents ( ostream & os ) [virtual]

Implements PRM_ParmOwner.

void OP_Parameters::saveSingleParmForUndo ( PRM_Parm * parm )

virtual void OP_Parameters::setAnyUndoFlag ( ) [virtual]

Reimplemented in OP_Node.

static void OP_Parameters::setBatchParms	(	PRM_BatchList &	list,
		double	now,
		bool	create_key = `false`,
		bool	create_channels = `false`
	)			`[static]`

void OP_Parameters::setChRefFloat	(	const char *	pn,
		int	vi,
		double	t,
		float	val,
		int	harden = `0`,
		int	propagate = `1`
	)

void OP_Parameters::setChRefFloat	(	int	pi,
		int	vi,
		double	t,
		float	val,
		int	harden = `0`,
		int	propagate = `1`
	)

void OP_Parameters::setChRefInt	(	const char *	pn,
		int	vi,
		double	t,
		int	val,
		int	harden = `0`,
		int	propagate = `1`
	)

void OP_Parameters::setChRefInt	(	int	pi,
		int	vi,
		double	t,
		int	val,
		int	harden = `0`,
		int	propagate = `1`
	)

void OP_Parameters::setChRefString	(	const char *	pn,
		int	vi,
		double	t,
		const UT_String &	val,
		CH_StringMeaning	meaning,
		int	harden = `0`,
		int	propagate = `1`
	)			`[inline]`

Definition at line 667 of file OP_Parameters.h.

void OP_Parameters::setChRefString	(	const UT_String &	val,
		CH_StringMeaning	meaning,
		const char *	pn,
		int	vi,
		double	t,
		int	harden = `0`,
		int	propagate = `1`
	)

void OP_Parameters::setChRefString	(	int	pi,
		int	vi,
		double	t,
		const UT_String &	val,
		CH_StringMeaning	meaning,
		int	harden = `0`,
		int	propagate = `1`
	)			`[inline]`

Definition at line 653 of file OP_Parameters.h.

void OP_Parameters::setChRefString	(	const UT_String &	val,
		CH_StringMeaning	meaning,
		int	pi,
		int	vi,
		double	t,
		int	harden = `0`,
		int	propagate = `1`
	)

void OP_Parameters::setExprLanguage ( CH_ExprLanguage language )

void OP_Parameters::setFloat	(	const char *	pn,
		int &	pi,
		int	vi,
		double	t,
		float	val,
		int	h = `0`
	)

void OP_Parameters::setFloat	(	const char *	pn,
		int	vi,
		double	t,
		float	val,
		int	h = `0`
	)

void OP_Parameters::setFloat	(	int	pi,
		int	vi,
		double	t,
		float	val,
		int	h = `0`
	)

Examples:: CHOP/CHOP_Spring.h, CHOP/CHOP_Stair.h, and SOP/SOP_BrushHairLen.h.

void OP_Parameters::setFloatInst	(	float	val,
		const char *	name,
		const int *	inst,
		int	vi,
		double	t,
		int	nestlevel = `1`
	)

void OP_Parameters::setInt	(	const char *	pn,
		int &	pi,
		int	vi,
		double	t,
		int	val
	)

void OP_Parameters::setInt	(	const char *	pn,
		int	vi,
		double	t,
		int	val
	)

void OP_Parameters::setInt	(	int	pi,
		int	vi,
		double	t,
		int	val
	)

Examples:: CHOP/CHOP_Stair.h, SOP/SOP_BrushHairLen.C, SOP/SOP_HDKObject.h, and VOP/VOP_CustomContext.C.

void OP_Parameters::setIntInst	(	int	val,
		const char *	name,
		const int *	inst,
		int	vi,
		double	t,
		int	nestlevel = `1`
	)

Examples:: SOP/SOP_HDKObject.h.

bool OP_Parameters::setParameterOrProperty	(	const char *	parm_name,
		int	vec_index,
		double	now,
		const char *	value,
		CH_StringMeaning	meaning,
		bool	harden = `false`,
		bool	propagate = `true`
	)

bool OP_Parameters::setParameterOrProperty	(	const char *	parm_name,
		int	vec_index,
		double	now,
		float	value,
		bool	harden = `false`,
		bool	propagate = `true`
	)

bool OP_Parameters::setParameterOrProperty	(	const char *	parm_name,
		int	vec_index,
		double	now,
		int	value,
		bool	harden = `false`,
		bool	propagate = `true`
	)

void OP_Parameters::setSilentFloat	(	const char *	pn,
		int &	pi,
		int	vi,
		double	t,
		float	val,
		int	h = `0`
	)

void OP_Parameters::setSilentFloat	(	const char *	pn,
		int	vi,
		double	t,
		float	val,
		int	h = `0`
	)

void OP_Parameters::setSilentFloat	(	int	pi,
		int	vi,
		double	t,
		float	val,
		int	h = `0`
	)

void OP_Parameters::setSilentFloatInst	(	float	val,
		const char *	name,
		const int *	inst,
		int	vi,
		double	t,
		int	nestlevel = `1`
	)

void OP_Parameters::setSilentInt	(	const char *	pn,
		int &	pi,
		int	vi,
		double	t,
		int	val
	)

void OP_Parameters::setSilentInt	(	const char *	pn,
		int	vi,
		double	t,
		int	val
	)

void OP_Parameters::setSilentInt	(	int	pi,
		int	vi,
		double	t,
		int	val
	)

void OP_Parameters::setSilentIntInst	(	int	val,
		const char *	name,
		const int *	inst,
		int	vi,
		double	t,
		int	nestlevel = `1`
	)

void OP_Parameters::setSilentString	(	const UT_String &	val,
		CH_StringMeaning	meaning,
		const char *	pn,
		int &	pi,
		int	vi,
		double	t
	)

void OP_Parameters::setSilentString	(	const UT_String &	val,
		CH_StringMeaning	meaning,
		const char *	pn,
		int	vi,
		double	t
	)

void OP_Parameters::setSilentString	(	const UT_String &	val,
		CH_StringMeaning	meaning,
		int	pi,
		int	vi,
		double	t
	)

void OP_Parameters::setSilentStringInst	(	const UT_String &	val,
		CH_StringMeaning	meaning,
		const char *	name,
		const int *	inst,
		int	vi,
		double	t,
		int	nestlevel = `1`
	)

void OP_Parameters::setString	(	const UT_String &	val,
		CH_StringMeaning	meaning,
		const char *	pn,
		int &	pi,
		int	vi,
		double	t
	)

void OP_Parameters::setString	(	const UT_String &	val,
		CH_StringMeaning	meaning,
		const char *	pn,
		int	vi,
		double	t
	)

void OP_Parameters::setString	(	const UT_String &	val,
		CH_StringMeaning	meaning,
		int	pi,
		int	vi,
		double	t
	)

void OP_Parameters::setStringInst	(	const UT_String &	val,
		CH_StringMeaning	meaning,
		const char *	name,
		const int *	inst,
		int	vi,
		double	t,
		int	nestlevel = `1`
	)

Examples:: SOP/SOP_HDKObject.h, and VOP/VOP_CustomContext.C.

void OP_Parameters::stealErrors ( OP_Parameters & src ) [protected]

void OP_Parameters::stealErrors	(	UT_ErrorManager &	src,
		bool	borrow_only = `false`
	)

void OP_Parameters::stealGlobalErrors ( ) [protected]

void OP_Parameters::takeActivateParm	(	PRM_Parm *	parm,
		bool	enable = `true`
	)

void OP_Parameters::takeActivateParm	(	const char *	name,
		bool	enable = `true`
	)

void OP_Parameters::takeActivateParm	(	uint	idx,
		bool	enable = `true`
	)

virtual void OP_Parameters::takeAutoActivateParm ( PRM_Parm * ) [virtual]

Implements PRM_ParmOwner.

void OP_Parameters::takeDeactivateParm ( PRM_Parm * parm ) [inline]

Definition at line 141 of file OP_Parameters.h.

void OP_Parameters::takeDeactivateParm ( const char * name ) [inline]

Definition at line 139 of file OP_Parameters.h.

void OP_Parameters::takeDeactivateParm ( uint idx ) [inline]

Definition at line 137 of file OP_Parameters.h.

bool OP_Parameters::takeIsActiveParm ( const PRM_Parm * parm )

bool OP_Parameters::takeIsActiveParm ( const char * name )

bool OP_Parameters::takeIsActiveParm ( uint idx )

virtual void OP_Parameters::traverseScope	(	const char *	pattern,
		OP_ScopeOp	scope_op,
		const OP_ScopeOptions &	scope_options
	)			`[protected, virtual]`

This is a helper method to the setChannelScope method. It traverses the node's parameters and sets the scope on them according to the given pattern.

Reimplemented in OP_Network.

virtual bool OP_Parameters::triggerParmCallback	(	PRM_Parm *	parmptr,
		float	now,
		int	value,
		void *	data
	)			`[pure virtual]`

Implemented in OP_Node.

void OP_Parameters::updateMultiParmFromRamp	(	double	t,
		const UT_Ramp &	ramp,
		PRM_Parm &	m,
		bool	add_wrap,
		int	harden = `0`
	)

updateMultiParmFromRamp() will follow simple channel references as necessary

void OP_Parameters::updatePending ( double t )

void OP_Parameters::updateRampFromMultiParm	(	double	t,
		const PRM_Parm &	m,
		UT_Ramp &	ramp,
		bool *	time_dep = `NULL`
	)

void OP_Parameters::updateUserMask ( )

Friends And Related Function Documentation

friend class OP_TakeParm [friend]

Definition at line 1282 of file OP_Parameters.h.

friend class OP_UndoParm [friend]

Definition at line 1283 of file OP_Parameters.h.

friend class OP_UndoSpareParm [friend]

Reimplemented in OP_Node.

Definition at line 1284 of file OP_Parameters.h.

Member Data Documentation

OP_Channels* OP_Parameters::myChannels [protected]

Examples:: CHOP/CHOP_Stair.C.

Definition at line 1197 of file OP_Parameters.h.

PRM_ParmList* OP_Parameters::myParmList [protected]

Definition at line 1196 of file OP_Parameters.h.

OP_Stat OP_Parameters::myStats [protected]

Definition at line 1198 of file OP_Parameters.h.

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

OP/OP_Parameters.h