HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
OP_Parameters Class Referenceabstract

#include <OP_Parameters.h>

+ Inheritance diagram for OP_Parameters:

Public Member Functions

const UT_StringgetName () const
 
OP_OperatorgetOperator () const
 
bool updateParmsAndSpareParmsFlags ()
 
virtual unsigned referenceAllParameters (OP_Parameters *from, bool relative_references=true)
 
virtual bool referenceSingleParameter (OP_Parameters *from, int parm_idx, const char *relative_path=NULL)
 
void animate (unsigned idx)
 
void animate (const char *name)
 
void deAnimate (unsigned idx)
 
void deAnimate (const char *name)
 
CH_ChanneladdChannel (const char *name)
 
CH_ChannelgetChannel (const char *name)
 
const CH_ChannelgetChannel (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)
 
void takeAutoActivateParm (PRM_Parm *) override
 
fpreal findKey (fpreal t, int direction) const
 
PRM_ChanState getChanState (fpreal t, bool scoped_only) const
 
PRM_ChanState isAtKey (fpreal t) const
 
void updatePending (fpreal t)
 
bool isPending (fpreal t)
 
OP_ChannelsgetChannels (void) const
 
virtual bool evalVariableValue (UT_String &val, int index, int thread)
 
virtual bool evalVariableValue (fpreal &val, int index, int thread)
 
virtual void getVariableString (int index, UT_String &value, int thread)
 
virtual float getVariableValue (int index, int thread)
 
int getNumParms () const
 
int getParmIndex (const char *name) const
 
PRM_ParmgetParm (int i)
 
const PRM_ParmgetParm (int i) const
 
PRM_ParmgetParm (const char *name)
 
const PRM_ParmgetParm (const char *name) const
 
bool hasParm (const char *name) const
 
PRM_ParmgetParmPtr (const UT_StringRef &name)
 
const PRM_ParmgetParmPtr (const UT_StringRef &name) const
 
PRM_ParmgetParmPtrInst (const char *name, const int *inst, int nestlevel=1)
 
const PRM_ParmgetParmPtrInst (const char *name, const int *inst, int nestlevel=1) const
 
virtual bool changeSpareParms (UT_IStream &ds, UT_String &errors)
 
bool getIsChangingSpareParms () const
 
PRM_ParmListcreateObsoleteParmList () override
 
void resolveAndDeleteObsoleteParmList (PRM_ParmList *&obsolete_parms) override
 
virtual void resolveObsoleteParms (PRM_ParmList *)
 
virtual void syncNodeVersion (const char *old_version, const char *current_version, bool *node_deleted)
 
bool getParameterOrPropertyConst (const UT_StringRef &name, fpreal now, OP_Node *&op, PRM_Parm *&parm, PRM_ParmList *obsolete) const
 
virtual int findParametersOrProperties (fpreal now, OP_PropertyLookupList &list)
 
const OP_StatgetStat () const
 
OP_StatgetStat ()
 
bool enableParm (int pi, int state, int v=-1)
 
bool enableParm (const char *pn, int state, int v=-1)
 
bool 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)
 
bool setVisibleState (int pi, bool state, int v=-1)
 
bool setVisibleState (const char *pn, bool state, int v=-1)
 
bool setVisibleStateInst (const char *name, const int *inst, int state, int nestlevel=1, int v=-1)
 
bool getVisibleState (int pi, int v=-1)
 
bool getVisibleState (const char *pn, int v=-1)
 
void evalString (UT_String &val, int pi, int vi, fpreal t) const
 
void evalStringT (UT_String &val, int pi, int vi, fpreal t, int thread) const
 
void evalString (UT_String &val, const UT_StringRef &pn, int vi, fpreal t) const
 
void evalStringT (UT_String &val, const UT_StringRef &pn, int vi, fpreal t, int thread) const
 
void evalString (UT_String &val, const char *pn, int *pi, int vi, fpreal t) const
 
void evalStringT (UT_String &val, const UT_StringRef &pn, int *pi, int vi, fpreal t, int thread) const
 
void evalString (UT_String &val, const PRM_Parm *parm, int vi, fpreal t) const
 
void evalStringT (UT_String &val, const PRM_Parm *parm, int vi, fpreal t, int thread) const
 
void evalStringRaw (UT_String &val, int pi, int vi, fpreal t) const
 
void evalStringRawT (UT_String &val, int pi, int vi, fpreal t, int thread) const
 
void evalStringRaw (UT_String &val, const UT_StringRef &pn, int vi, fpreal t) const
 
void evalStringRawT (UT_String &val, const UT_StringRef &pn, int vi, fpreal t, int thread) const
 
void evalStringRaw (UT_String &val, const UT_StringRef &pn, int *pi, int vi, fpreal t) const
 
void evalStringRawT (UT_String &val, const UT_StringRef &pn, int *pi, int vi, fpreal t, int thread) const
 
void evalStringRaw (UT_String &val, const PRM_Parm *parm, int vi, fpreal t) const
 
void evalStringRawT (UT_String &val, const PRM_Parm *parm, int vi, fpreal t, int thread) const
 
PRM_DataItemHandle evalData (int pi, int vi, fpreal t) const
 
PRM_DataItemHandle evalDataT (int pi, int vi, fpreal t, int thread) const
 
PRM_DataItemHandle evalData (const UT_StringRef &pn, int vi, fpreal t) const
 
PRM_DataItemHandle evalDataT (const UT_StringRef &pn, int vi, fpreal t, int thread) const
 
PRM_DataItemHandle evalData (const UT_StringRef &pn, int *pi, int vi, fpreal t) const
 
PRM_DataItemHandle evalDataT (const UT_StringRef &pn, int *pi, int vi, fpreal t, int thread) const
 
PRM_DataItemHandle evalData (const PRM_Parm *parm, int vi, fpreal t) const
 
PRM_DataItemHandle evalDataT (const PRM_Parm *parm, int vi, fpreal t, int thread) const
 
void evalJSONMap (UT_JSONValueMap &val, int pi, int vi, fpreal t) const
 
void evalJSONMapT (UT_JSONValueMap &val, int pi, int vi, fpreal t, int thread) const
 
void evalJSONMap (UT_JSONValueMap &val, const UT_StringRef &pn, int vi, fpreal t) const
 
void evalJSONMapT (UT_JSONValueMap &val, const UT_StringRef &pn, int vi, fpreal t, int thread) const
 
void evalJSONMap (UT_JSONValueMap &val, const UT_StringRef &pn, int *pi, int vi, fpreal t) const
 
void evalJSONMapT (UT_JSONValueMap &val, const UT_StringRef &pn, int *pi, int vi, fpreal t, int thread) const
 
void evalJSONMap (UT_JSONValueMap &val, const PRM_Parm *parm, int vi, fpreal t) const
 
void evalJSONMapT (UT_JSONValueMap &val, const PRM_Parm *parm, int vi, fpreal t, int thread) const
 
void evalJSONMapRaw (UT_JSONValueMap &val, int pi, int vi, fpreal t) const
 
void evalJSONMapRawT (UT_JSONValueMap &val, int pi, int vi, fpreal t, int thread) const
 
void evalJSONMapRaw (UT_JSONValueMap &val, const UT_StringRef &pn, int vi, fpreal t) const
 
void evalJSONMapRawT (UT_JSONValueMap &val, const UT_StringRef &pn, int vi, fpreal t, int thread) const
 
void evalJSONMapRaw (UT_JSONValueMap &val, const UT_StringRef &pn, int *pi, int vi, fpreal t) const
 
void evalJSONMapRawT (UT_JSONValueMap &val, const UT_StringRef &pn, int *pi, int vi, fpreal t, int thread) const
 
void evalJSONMapRaw (UT_JSONValueMap &val, const PRM_Parm *parm, int vi, fpreal t) const
 
void evalJSONMapRawT (UT_JSONValueMap &val, const PRM_Parm *parm, int vi, fpreal t, int thread) const
 
CH_StringMeaning getStringMeaning (int pi, int vi, fpreal t) const
 
CH_StringMeaning getStringMeaning (const char *pn, int vi, fpreal t) const
 
CH_StringMeaning getStringMeaningInst (const char *name, const int *inst, int vi, fpreal t, int nest_level=1) const
 
CH_ExprLanguage getExprLanguage () const override
 
void setExprLanguage (CH_ExprLanguage language)
 
void insertMultiParmItem (const char *pn, int i)
 
void removeMultiParmItem (const char *pn, int i)
 
void updateMultiParmFromRamp (fpreal t, const UT_Ramp &ramp, PRM_Parm &m, bool add_wrap, PRM_AddKeyType add_key=PRM_AK_MARK_PENDING)
 
void updateRampFromMultiParm (fpreal t, const PRM_Parm &m, UT_Ramp &ramp, bool *time_dep=NULL, DEP_MicroNode *depnode=NULL) const
 
bool convertObsAnimatedToStringExpression (PRM_ParmList *obsolete_parms, const char *pn, int vi, fpreal t, UT_String &result, bool reset_obs)
 
bool expandString (UT_String &val, fpreal 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, fpreal t)
 
bool isParmDirty (const char *n, fpreal t)
 
bool isParmDirtyInst (const char *name, const int *inst, fpreal t, int nestlevel=1)
 
void cacheParmValues (const OP_Context &context)
 
void clearParmCache ()
 
bool isParmTimeDependent (int idx, int comp=-1) const
 
bool isParmTimeDependent (const char *name, int comp=-1) const
 
int getErrorMessages (UT_String &messages, UT_ErrorSeverity severity=UT_ERROR_NONE)
 
virtual void getRawErrors (UT_Array< UT_Error > &errors, bool update)
 
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 ()
 
void clearErrors (OP_Context &context)
 
virtual OP_ERROR getErrorSeverity ()
 
bool hasDeadlockError () const
 
virtual OP_ERROR error (OP_Context &context)
 
virtual OP_ERROR error ()
 
void stealErrors (UT_ErrorManager &src, bool borrow_only=false)
 
OP_ERROR getSaveError ()
 
bool isGettingSaveError () const
 
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, fpreal 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 (fpreal time_now)
 
void triggerOPChanged (OP_EventType reason, int index)
 
void parmChanged (int parm_index)
 
void parmExprChanged (int parm_index)
 
void operatorDeleted ()
 
void saveParmCommand (std::ostream &os, int values=0, int defaultstoo=1, bool spareparms=true) const
 
int loadParmCommand (int argc, const char *const argv[], int docallbacks, void *data, fpreal now, bool followchrefs, CMD_Args *args)
 
void commandParmCallback (void *data, fpreal now, int argc, char *argv[], CMD_Args *args)
 
void saveMultiParmInstanceCommand (std::ostream &os, const char *opname, bool spareparms) const
 
virtual bool triggerParmCallback (PRM_Parm *parmptr, fpreal now, int value, void *data, const UT_Options *options=0)=0
 
int64 getMemoryUsage (bool inclusive) const override
 
void bumpTakeReference (int dir)
 
int getTakeReferences () const
 
void createChannelGroupsFromFolders (CH_Group &parent_group, bool only_channels, bool leaf_channels_only=false, bool only_unlocked=true)
 
void getAutoScopedChannels (CH_ChannelRefList &chlist, bool follow_layer_overrides=true, bool include_animated=false, bool follow_channel_refs=true, bool include_autoscope=true)
 
void getChopScopeChannels (UT_WorkBuffer &chopscope_cmd)
 
bool getParmIsVisible (const char *parmname)
 
const PRM_TemplategetInterfaceParmTemplates () const
 
const PRM_TemplategetSpareParmTemplates () const
 
const PRM_ScriptImportsgetSpareParmTemplateImports () const
 
const PRM_TemplategetSpareParmLayoutTemplates () const
 
const PRM_ScriptImportsgetSpareParmLayoutTemplateImports () const
 
int getSpareParmTemplatesId () const
 
int numSpareInputs () const
 
bool hasMultiparmInfo () const
 
OP_MultiparmInfogetMultiparmInfo ()
 
void initMultiparmInstance (UT_ValArray< PRM_Parm * > &parms) override
 
void addOrRemoveMultiparmInstance () override
 
bool savePresetContents (std::ostream &os) override
 
bool loadPresetContents (const char *tok, UT_IStream &is) override
 
virtual bool getParameterOrProperty (const UT_StringRef &name, fpreal now, OP_Node *&op, PRM_Parm *&parm, bool create_missing_multiparms, PRM_ParmList *obsolete=0)
 
virtual bool getParameterOrPropertyByChannel (const UT_StringRef &chname, fpreal now, OP_Node *&op, PRM_Parm *&parm, int &vector_index, PRM_ParmList *obsolete=0)
 
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
  • fpreal t
    Evaluation time
  • int thread
    Thread id (ie. return value from SYSgetSTID())
exint evalInt (int pi, int vi, fpreal t) const
 
exint evalIntT (int pi, int vi, fpreal t, int thread) const
 
exint evalInt (const UT_StringRef &pn, int vi, fpreal t) const
 
exint evalIntT (const UT_StringRef &pn, int vi, fpreal t, int thread) const
 
exint evalInt (const UT_StringRef &pn, int *pi, int vi, fpreal t) const
 
exint evalIntT (const UT_StringRef &pn, int *pi, int vi, fpreal t, int thread) const
 
exint evalInt (const PRM_Parm *parm, int vi, fpreal t) const
 
exint evalIntT (const PRM_Parm *parm, int vi, fpreal t, int thread) const
 
fpreal evalFloat (int pi, int vi, fpreal t) const
 
fpreal evalFloatT (int pi, int vi, fpreal t, int thread) const
 
fpreal evalFloat (const UT_StringRef &pn, int vi, fpreal t) const
 
fpreal evalFloatT (const UT_StringRef &pn, int vi, fpreal t, int thread) const
 
fpreal evalFloat (const UT_StringRef &pn, int *pi, int vi, fpreal t) const
 
fpreal evalFloatT (const UT_StringRef &pn, int *pi, int vi, fpreal t, int thread) const
 
fpreal evalFloat (const PRM_Parm *parm, int vi, fpreal t) const
 
fpreal evalFloatT (const PRM_Parm *parm, int vi, fpreal t, int thread) const
 
void evalFloats (int pi, fpreal64 *v, fpreal t) const
 
void evalFloatsT (int pi, fpreal64 *v, fpreal t, int thread) const
 
void evalFloats (const UT_StringRef &pn, fpreal64 *v, fpreal t) const
 
void evalFloatsT (const UT_StringRef &pn, fpreal64 *v, fpreal t, int thread) const
 
void evalFloats (const UT_StringRef &pn, int *pi, fpreal64 *v, fpreal t) const
 
void evalFloatsT (const UT_StringRef &pn, int *pi, fpreal64 *v, fpreal t, int thread) const
 
void evalFloats (const PRM_Parm *parm, fpreal64 *v, fpreal t) const
 
void evalFloatsT (const PRM_Parm *parm, fpreal64 *v, fpreal t, int thread) const
 
void evalFloatsT (int pi, fpreal32 *v, fpreal t, int thread) const
 
void evalFloats (int pi, fpreal32 *v, fpreal t) const
 
void evalFloatsT (const UT_StringRef &pn, fpreal32 *v, fpreal t, int thread) const
 
void evalFloats (const UT_StringRef &pn, fpreal32 *v, fpreal t) const
 
void evalFloatsT (const UT_StringRef &pn, int *pi, fpreal32 *v, fpreal t, int thread) const
 
void evalFloats (const UT_StringRef &pn, int *pi, fpreal32 *v, fpreal t) const
 
void evalFloatsT (const PRM_Parm *parm, fpreal32 *v, fpreal t, int thread) const
 
void evalFloats (const PRM_Parm *parm, fpreal32 *v, fpreal t) const
 
void evalFloatsInst (const UT_StringRef &name, const int *inst, fpreal32 *v, fpreal t, int nestlevel=1) const
 
Multi-Parameter evaluation
  • name
    Parameter name token
  • inst
    Array of instance indices to evaluate at
  • vectori
    Component index of a parameter
  • t
    Evaluation time
  • nestlevel
    Number of entries in 'inst'
  • value
    Value to set
exint evalIntInst (const UT_StringRef &name, const int *inst, int vi, fpreal t, int nestlevel=1) const
 
exint evalIntInstT (const UT_StringRef &name, const int *inst, int vi, fpreal t, int thread, int nestlevel=1) const
 
fpreal evalFloatInst (const UT_StringRef &name, const int *inst, int vi, fpreal t, int nestlevel=1) const
 
fpreal evalFloatInstT (const UT_StringRef &name, const int *inst, int vi, fpreal t, int thread, int nestlevel=1) const
 
void evalFloatsInst (const UT_StringRef &name, const int *inst, fpreal64 *v, fpreal t, int nestlevel=1) const
 
void evalFloatsInstT (const UT_StringRef &name, const int *inst, fpreal64 *v, fpreal t, int thread, int nestlevel=1) const
 
void evalStringInst (const UT_StringRef &name, const int *inst, UT_String &val, int vi, fpreal t, int nestlevel=1) const
 
void evalStringInstT (const UT_StringRef &name, const int *inst, UT_String &val, int vi, fpreal t, int thread, int nestlevel=1) const
 
void evalStringInstRaw (const UT_StringRef &name, const int *inst, UT_String &val, int vi, fpreal t, int nestlevel=1) const
 
void evalStringInstRawT (const UT_StringRef &name, const int *inst, UT_String &val, int vi, fpreal t, int thread, int nestlevel=1) const
 
PRM_DataItemHandle evalDataInst (const UT_StringRef &name, const int *inst, int vi, fpreal t, int nestlevel=1) const
 
PRM_DataItemHandle evalDataInstT (const UT_StringRef &name, const int *inst, int vi, fpreal t, int thread, int nestlevel=1) const
 
void setIntInst (exint value, const char *parmname, const int *inst, int vectori, fpreal t, int nestlevel=1)
 
void setFloatInst (fpreal value, const char *parmname, const int *inst, int vectori, fpreal t, int nestlevel=1)
 
void setStringInst (const UT_StringRef &value, CH_StringMeaning meaning, const char *parmname, const int *inst, int vectori, fpreal t, int nestlevel=1)
 
void setDataInst (const PRM_DataItemHandle &value, const char *parmname, const int *inst, int vectori, fpreal t, int nestlevel=1)
 
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 SYSgetSTID())
  • parmptr
    optional source parameter return value
bool evalParameterOrProperty (const UT_StringRef &parm_name, int vec_index, fpreal now, int &value, PRM_Parm **parmptr=NULL) const
 
bool evalParameterOrPropertyT (const UT_StringRef &parm_name, int vec_index, fpreal now, int &value, int thread, PRM_Parm **parmptr=NULL) const
 
bool evalParameterOrProperty (const UT_StringRef &parm_name, int vec_index, fpreal now, fpreal &values, PRM_Parm **parmptr=NULL) const
 
bool evalParameterOrPropertyT (const UT_StringRef &parm_name, int vec_index, fpreal now, fpreal &values, int thread, PRM_Parm **parmptr=NULL) const
 
bool evalParameterOrProperty (const UT_StringRef &parm_name, int vec_index, fpreal now, UT_String &value, PRM_Parm **parmptr=NULL) const
 
bool evalParameterOrPropertyT (const UT_StringRef &parm_name, int vec_index, fpreal now, UT_String &value, int thread, PRM_Parm **parmptr=NULL) const
 
bool evalParameterOrPropertyRaw (const UT_StringRef &parm_name, int vec_index, fpreal now, UT_String &value, PRM_Parm **parmptr=NULL) const
 
bool evalParameterOrPropertyRawT (const UT_StringRef &parm_name, int vec_index, fpreal now, UT_String &value, int thread, PRM_Parm **parmptr=NULL) const
 
bool evalParameterOrPropertyExpr (const UT_StringRef &parm_name, int vec_index, fpreal now, UT_String &value, PRM_Parm **parmptr=NULL) const
 
bool evalParameterOrPropertyExprT (const UT_StringRef &parm_name, int vec_index, fpreal now, UT_String &value, int thread, PRM_Parm **parmptr=NULL) const
 
bool evalVectorProperty (const UT_StringRef &parm_name, fpreal now, int *values, int vec_size, PRM_Parm **parmptr=NULL) const
 
bool evalVectorPropertyT (const UT_StringRef &parm_name, fpreal now, int *values, int vec_size, int thread, PRM_Parm **parmptr=NULL) const
 
bool evalVectorProperty (const UT_StringRef &parm_name, fpreal now, fpreal *values, int vec_size, PRM_Parm **parmptr=NULL) const
 
bool evalVectorPropertyT (const UT_StringRef &parm_name, fpreal now, fpreal *values, int vec_size, int thread, PRM_Parm **parmptr=NULL) const
 
Setting parameter values

  • parmi
    Parameter index
  • parmname
    Parameter name string
  • vectori
    Component index of a parameter
  • t
    Evaluation time
  • value
    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 parmi, int vectori, fpreal t, exint value)
 
void setInt (const char *parmname, int vectori, fpreal t, exint value)
 
void setInt (const char *parmname, int &parmi, int vectori, fpreal t, exint value)
 
void setFloat (int parmi, int vectori, fpreal t, fpreal value, PRM_AddKeyType add_key=PRM_AK_MARK_PENDING)
 
void setFloat (const char *parmname, int vectori, fpreal t, fpreal value, PRM_AddKeyType add_key=PRM_AK_MARK_PENDING)
 
void setFloat (const char *parmname, int &parmi, int vectori, fpreal t, fpreal value, PRM_AddKeyType add_key=PRM_AK_MARK_PENDING)
 
void setString (const UT_StringRef &val, CH_StringMeaning meaning, int parmi, int vectori, fpreal t)
 
void setString (const UT_StringRef &val, CH_StringMeaning meaning, const char *parmname, int vectori, fpreal t)
 
void setString (const UT_StringRef &val, CH_StringMeaning meaning, const char *parmname, int &parmi, int vectori, fpreal t)
 
void setData (int parmi, int vectori, fpreal t, const PRM_DataItemHandle &val)
 
void setData (const char *parmname, int vectori, fpreal t, const PRM_DataItemHandle &val)
 
void setData (const char *parmname, int &parmi, int vectori, fpreal t, const PRM_DataItemHandle &val)
 
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
  • add_key
    If PRM_AK_SET_KEY, it will set a keyframe if the parameter has a channel and the current value differs. If PRM_AK_FORCE_KEY, it will set a keyframe if the parameter has a channel regardless of the current value. If PRM_AK_MARK_PENDING, then the value will need to be committed first.
  • propagate
    If true, it notify observers
  • thread
    Thread id (ie. return value from SYSgetSTID())
void setChRefInt (int pi, int vi, fpreal t, exint val, PRM_AddKeyType add_key=PRM_AK_MARK_PENDING, bool propagate=true)
 
void setChRefInt (const char *pn, int vi, fpreal t, exint val, PRM_AddKeyType add_key=PRM_AK_MARK_PENDING, bool propagate=true)
 
void setChRefFloat (int pi, int vi, fpreal t, fpreal val, PRM_AddKeyType add_key=PRM_AK_MARK_PENDING, bool propagate=true)
 
void setChRefFloat (const char *pn, int vi, fpreal t, fpreal val, PRM_AddKeyType add_key=PRM_AK_MARK_PENDING, bool propagate=true)
 
void setChRefString (const UT_StringRef &val, CH_StringMeaning meaning, int pi, int vi, fpreal t, PRM_AddKeyType add_key=PRM_AK_MARK_PENDING, bool propagate=true)
 
void setChRefString (int pi, int vi, fpreal t, const UT_StringRef &val, CH_StringMeaning meaning, PRM_AddKeyType add_key=PRM_AK_MARK_PENDING, bool propagate=true)
 
void setChRefString (const UT_StringRef &val, CH_StringMeaning meaning, const char *pn, int vi, fpreal t, PRM_AddKeyType add_key=PRM_AK_MARK_PENDING, bool propagate=true)
 
void setChRefString (const char *pn, int vi, fpreal t, const UT_StringRef &val, CH_StringMeaning meaning, PRM_AddKeyType add_key=PRM_AK_MARK_PENDING, bool propagate=true)
 
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
  • set_key
    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, fpreal now, int32 value, bool set_key=false, bool propagate=true)
 
bool setParameterOrProperty (const char *parm_name, int vec_index, fpreal now, int64 value, bool set_key=false, bool propagate=true)
 
bool setParameterOrProperty (const char *parm_name, int vec_index, fpreal now, fpreal value, bool set_key=false, bool propagate=true)
 
bool setParameterOrProperty (const char *parm_name, int vec_index, fpreal now, const char *value, CH_StringMeaning meaning, bool set_key=false, bool propagate=true)
 
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
  • fpreal t
    Time at which to set the value
  • value
    Value to set
void setSilentInt (int parmi, int vectori, fpreal t, exint value)
 
void setSilentInt (const char *parmname, int vectori, fpreal t, exint value)
 
void setSilentInt (const char *parmname, int &parmi, int vectori, fpreal t, exint value)
 
void setSilentFloat (int parmi, int vectori, fpreal t, fpreal value, PRM_AddKeyType add_key=PRM_AK_MARK_PENDING)
 
void setSilentFloat (const char *parmname, int vectori, fpreal t, fpreal value, PRM_AddKeyType add_key=PRM_AK_MARK_PENDING)
 
void setSilentFloat (const char *parmname, int &parmi, int vectori, fpreal t, fpreal value, PRM_AddKeyType add_key=PRM_AK_MARK_PENDING)
 
void setSilentString (const UT_StringRef &value, CH_StringMeaning meaning, int parmi, int vectori, fpreal t)
 
void setSilentString (const UT_StringRef &value, CH_StringMeaning meaning, const char *parmname, int vectori, fpreal t)
 
void setSilentString (const UT_StringRef &value, CH_StringMeaning meaning, const char *parmname, int &parmi, int vectori, fpreal t)
 
void setSilentData (int parmi, int vectori, fpreal t, const PRM_DataItemHandle &value)
 
void setSilentData (const char *parmname, int vectori, fpreal t, const PRM_DataItemHandle &value)
 
void setSilentData (const char *parmname, int &parmi, int vectori, fpreal t, const PRM_DataItemHandle &value)
 
void setSilentIntInst (exint value, const char *parmname, const int *inst, int vectori, fpreal t, int nestlevel=1)
 
void setSilentFloatInst (fpreal value, const char *parmname, const int *inst, int vectori, fpreal t, int nestlevel=1)
 
void setSilentStringInst (const UT_StringRef &value, CH_StringMeaning meaning, const char *parmname, const int *inst, int vectori, fpreal t, int nestlevel=1)
 
void setSilentDataInst (const PRM_DataItemHandle &value, const char *parmname, const int *inst, int vectori, fpreal t, int nestlevel=1)
 
- Public Member Functions inherited from PRM_ParmOwner
virtual OP_NodecastToOPNode ()
 
virtual const OP_NodecastToOPNode () const
 
const char * getFullPath (UT_String &str) const
 
const char * getFullPath (UT_WorkBuffer &str) const
 
UT_StringHolder getFullPath () const
 
SYS_FORCE_INLINE PRM_ParmListgetParmList ()
 
SYS_FORCE_INLINE const
PRM_ParmList
getParmList () const
 
virtual bool createSpareParametersForLoad (UT_StringArray &, PRM_ParmNameMap &, UT_String &)
 
virtual void executeCommand (const char *command, std::ostream *out, std::ostream *err) const =0
 
virtual void pushAsPwdAndRunPython (PY_CompiledCode &compiled_code, PY_Result::Type desired_result_type, PY_Result &result, PY_EvaluationContext *context=NULL) const =0
 
bool isPendingOverride () const
 
virtual bool isParmPendingOverride (const char *, int) const
 
const char * getPendingOverrideString () const
 
void setPendingOverrideString (const char *s)
 
virtual UT_ErrorSeverity prmCookOverrides (fpreal, int, const char *, int)
 
virtual void rebuildParmDependency (int parmidx)=0
 
virtual void clearParmDependency (int parmidx)=0
 
virtual void convertOpdefToAbsolutePath (UT_String &str) const =0
 
virtual void spareParmRemoved (const char *parmname)=0
 
virtual PRM_ParmMicroNodecreateParmMicroNodes (PRM_Parm &parm) const
 
virtual UT_StringHolder evaluateDisableExpression (const PRM_Parm &prm, const UT_StringRef &function) const
 
virtual const PRM_ParmtraverseRef (int *sub_idx, fpreal time, int parm_idx, int vec_idx) const =0
 

Static Public Member Functions

static bool followChannelReferencesOneStep (const OP_FollowChanRefsOptions &opt, OP_Node *&newop, PRM_Parm *&newparm, int &newvecidx)
 
static bool followChannelReferencesOneStepT (const OP_FollowChanRefsOptions &opt, OP_Node *&newop, PRM_Parm *&newparm, int &newvecidx, int thread)
 
static void followChannelReferences (const OP_FollowChanRefsOptions &opt, OP_Node *&newop, PRM_Parm *&newparm, int &newvecidx)
 
static void followChannelReferencesT (const OP_FollowChanRefsOptions &opt, OP_Node *&newop, PRM_Parm *&newparm, int &newvecidx, int thread)
 
static void followChannelReferences (const OP_FollowChanRefsOptions &opt, CH_ChannelRef &ref)
 
static void followChannelReferencesT (const OP_FollowChanRefsOptions &opt, CH_ChannelRef &ref, int thread)
 
static void getValueAsProcessedNodePaths (fpreal t, UT_WorkBuffer &resultbuf, PRM_Parm *parm, int index, OP_Node *srcnode)
 
static void setBatchParms (PRM_BatchList &list, fpreal now, bool set_key=false, bool create_channels=false)
 
static bool canSetBatchParms (PRM_BatchList &list, fpreal 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)
 
static void getLayersFromScopedChannels (const CH_ChannelRefList &ori_refs, CH_ChannelRefList &layer_refs)
 

Protected Member Functions

virtual void doGetFullPath (UT_WorkBuffer &str) const override
 Compute the full path of the node. More...
 
bool updateParmDisableConditional (PRM_Parm &parm, bool force, const UT_StringArray *skip=0)
 
bool updateParmHideConditional (PRM_Parm &parm, const UT_StringArray *skip=0)
 
virtual unsigned disableParms ()
 
virtual bool updateParmsFlags ()
 
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 ()
 
intallocIndirect (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)
 
virtual int rename (const char *newname)
 
virtual bool createSpareParameterFromChannel (const char *chname)
 
virtual bool createSpareParametersFromChannels (UT_BitArray &selection, const CH_ChannelList &channels)
 
CH_LocalVariablegetVariable (int i) const
 
CH_LocalVariablegetVariable (const char *name) const
 
OP_ERROR saveChannels (std::ostream &os, int binary, bool compiled, int selected)
 
OP_ERROR saveParmChannels (int parm_index, std::ostream &os, int binary, bool compiled)
 
OP_ERROR saveParameters (std::ostream &os, int binary, bool compiled)
 
OP_ERROR saveChannelAliases (std::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
 
virtual void ensureErrorsAreUpdatedSubclass ()
 
virtual void ensureSpareParmsAreUpdatedSubclass ()
 
- Protected Member Functions inherited from PRM_ParmOwner
 PRM_ParmOwner ()
 
virtual ~PRM_ParmOwner ()
 

Static Protected Member Functions

static bool isReservedOpName (const char *name)
 

Protected Attributes

OP_ChannelsmyChannels
 
OP_Stat myStats
 
- Protected Attributes inherited from PRM_ParmOwner
PRM_ParmListmyParmList
 

Friends

class OP_TakeParm
 
class OP_UndoParm
 
class OP_UndoSpareParm
 

Detailed Description

Definition at line 127 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 ( )
protectedvirtual

Member Function Documentation

CH_Channel* OP_Parameters::addChannel ( const char *  name)
void OP_Parameters::addChannelError ( const char *  type,
int  code,
const char *  msg = 0 
)
void OP_Parameters::addOrRemoveMultiparmInstance ( )
overridevirtual

Implements PRM_ParmOwner.

int* OP_Parameters::allocIndirect ( int  size = 64)
protected
void OP_Parameters::animate ( unsigned  idx)
void OP_Parameters::animate ( const char *  name)
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 1263 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 ( )
inlineprotectedvirtual

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

Definition at line 1549 of file OP_Parameters.h.

void OP_Parameters::bumpTakeReference ( int  dir)
inline

Definition at line 1403 of file OP_Parameters.h.

void OP_Parameters::cacheParmValues ( const OP_Context context)
int OP_Parameters::canAccess ( unsigned  mask) const
bool OP_Parameters::canAccess ( unsigned  mask,
const PRM_Parm parm 
) const
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,
fpreal  now 
)
static
virtual bool OP_Parameters::changeSpareParms ( UT_IStream ds,
UT_String errors 
)
virtual

Reimplemented in OP_Node, and OP_Director.

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   
)
inlineprotectedvirtual

Reimplemented in OP_Node, SOP_Muscle, and OBJ_Muscle.

Definition at line 1551 of file OP_Parameters.h.

SYS_FORCE_INLINE bool OP_Parameters::checkExpressionError ( const PRM_Parm parm,
int  thread 
) const
inlineprotected

Definition at line 1524 of file OP_Parameters.h.

void OP_Parameters::clearDuplicateErrors ( )
inline

Definition at line 1230 of file OP_Parameters.h.

void OP_Parameters::clearErrors ( )
inline
Examples:
SOP/SOP_BlindData.C.

Definition at line 1274 of file OP_Parameters.h.

void OP_Parameters::clearErrors ( OP_Context context)
inline

Definition at line 1281 of file OP_Parameters.h.

void OP_Parameters::clearParmCache ( )
virtual void OP_Parameters::clearUndoFlags ( )
virtual

Reimplemented in OP_Node, OBJ_Node, and OP_Network.

void OP_Parameters::commandParmCallback ( void data,
fpreal  now,
int  argc,
char *  argv[],
CMD_Args args 
)
bool OP_Parameters::convertObsAnimatedToStringExpression ( PRM_ParmList obsolete_parms,
const char *  pn,
int  vi,
fpreal  t,
UT_String result,
bool  reset_obs 
)
void OP_Parameters::createChannelGroupsFromFolders ( CH_Group parent_group,
bool  only_channels,
bool  leaf_channels_only = false,
bool  only_unlocked = true 
)

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.

PRM_ParmList* OP_Parameters::createObsoleteParmList ( )
overridevirtual

Implements PRM_ParmOwner.

virtual bool OP_Parameters::createSpareParameterFromChannel ( const char *  chname)
protectedvirtual
virtual bool OP_Parameters::createSpareParametersFromChannels ( UT_BitArray selection,
const CH_ChannelList channels 
)
protectedvirtual

Reimplemented in OBJ_Node, OBJ_DopNet, and SHOP_Node.

void OP_Parameters::deAnimate ( unsigned  idx)
void OP_Parameters::deAnimate ( const char *  name)
int OP_Parameters::destroyChannel ( const char *  name)
virtual unsigned OP_Parameters::disableParms ( )
protectedvirtual
virtual void OP_Parameters::doGetFullPath ( UT_WorkBuffer buf) const
overrideprotectedvirtual

Compute the full path of the node.

Implements PRM_ParmOwner.

Reimplemented in OP_Node.

bool OP_Parameters::enableParm ( int  pi,
int  state,
int  v = -1 
)
bool OP_Parameters::enableParm ( const char *  pn,
int  state,
int  v = -1 
)
bool OP_Parameters::enableParmInst ( const char *  name,
const int inst,
int  state,
int  nestlevel = 1,
int  v = -1 
)
Examples:
SOP/SOP_HDKObject.C.
virtual void OP_Parameters::ensureErrorsAreUpdatedSubclass ( )
inlineprotectedvirtual

Ensure that the node errors are up-to-date. This method gives our subclass a chance to insert any errors on-demand.

Reimplemented in VOP_Node.

Definition at line 1600 of file OP_Parameters.h.

virtual void OP_Parameters::ensureSpareParmsAreUpdatedSubclass ( )
inlineprotectedvirtual

Ensure that the spare parameter templates are up-to-date. This method gives our subclass a chance to update the spare parameters on-the-fly before returning them.

Reimplemented in VOP_SubnetBase, VOP_SubnetScript, VOPNET_Node, and HDK_Sample::SOP_PrimVOP.

Definition at line 1605 of file OP_Parameters.h.

virtual OP_ERROR OP_Parameters::error ( OP_Context context)
inlinevirtual

Reimplemented in COP2_Node.

Definition at line 1296 of file OP_Parameters.h.

PRM_DataItemHandle OP_Parameters::evalData ( int  pi,
int  vi,
fpreal  t 
) const
inline

Definition at line 548 of file OP_Parameters.h.

PRM_DataItemHandle OP_Parameters::evalData ( const UT_StringRef pn,
int  vi,
fpreal  t 
) const
inline

Definition at line 551 of file OP_Parameters.h.

PRM_DataItemHandle OP_Parameters::evalData ( const UT_StringRef pn,
int pi,
int  vi,
fpreal  t 
) const
inline

Definition at line 556 of file OP_Parameters.h.

PRM_DataItemHandle OP_Parameters::evalData ( const PRM_Parm parm,
int  vi,
fpreal  t 
) const
inline

Definition at line 561 of file OP_Parameters.h.

PRM_DataItemHandle OP_Parameters::evalDataInst ( const UT_StringRef name,
const int inst,
int  vi,
fpreal  t,
int  nestlevel = 1 
) const
inline

Definition at line 714 of file OP_Parameters.h.

PRM_DataItemHandle OP_Parameters::evalDataInstT ( const UT_StringRef name,
const int inst,
int  vi,
fpreal  t,
int  thread,
int  nestlevel = 1 
) const
PRM_DataItemHandle OP_Parameters::evalDataT ( int  pi,
int  vi,
fpreal  t,
int  thread 
) const
PRM_DataItemHandle OP_Parameters::evalDataT ( const UT_StringRef pn,
int  vi,
fpreal  t,
int  thread 
) const
PRM_DataItemHandle OP_Parameters::evalDataT ( const UT_StringRef pn,
int pi,
int  vi,
fpreal  t,
int  thread 
) const
PRM_DataItemHandle OP_Parameters::evalDataT ( const PRM_Parm parm,
int  vi,
fpreal  t,
int  thread 
) const
fpreal OP_Parameters::evalFloat ( const UT_StringRef pn,
int  vi,
fpreal  t 
) const
inline

Definition at line 417 of file OP_Parameters.h.

fpreal OP_Parameters::evalFloat ( const UT_StringRef pn,
int pi,
int  vi,
fpreal  t 
) const
inline

Definition at line 422 of file OP_Parameters.h.

fpreal OP_Parameters::evalFloat ( const PRM_Parm parm,
int  vi,
fpreal  t 
) const
inline

Definition at line 427 of file OP_Parameters.h.

fpreal OP_Parameters::evalFloatInst ( const UT_StringRef name,
const int inst,
int  vi,
fpreal  t,
int  nestlevel = 1 
) const
inline

Definition at line 666 of file OP_Parameters.h.

fpreal OP_Parameters::evalFloatInstT ( const UT_StringRef name,
const int inst,
int  vi,
fpreal  t,
int  thread,
int  nestlevel = 1 
) const
void OP_Parameters::evalFloats ( int  pi,
fpreal64 v,
fpreal  t 
) const
inline
Examples:
SOP/SOP_IKSample.h.

Definition at line 433 of file OP_Parameters.h.

void OP_Parameters::evalFloats ( const UT_StringRef pn,
fpreal64 v,
fpreal  t 
) const
inline

Definition at line 437 of file OP_Parameters.h.

void OP_Parameters::evalFloats ( const UT_StringRef pn,
int pi,
fpreal64 v,
fpreal  t 
) const
inline

Definition at line 442 of file OP_Parameters.h.

void OP_Parameters::evalFloats ( const PRM_Parm parm,
fpreal64 v,
fpreal  t 
) const
inline

Definition at line 447 of file OP_Parameters.h.

void OP_Parameters::evalFloats ( int  pi,
fpreal32 v,
fpreal  t 
) const
inline

Definition at line 456 of file OP_Parameters.h.

void OP_Parameters::evalFloats ( const UT_StringRef pn,
fpreal32 v,
fpreal  t 
) const
inline

Definition at line 460 of file OP_Parameters.h.

void OP_Parameters::evalFloats ( const UT_StringRef pn,
int pi,
fpreal32 v,
fpreal  t 
) const
inline

Definition at line 465 of file OP_Parameters.h.

void OP_Parameters::evalFloats ( const PRM_Parm parm,
fpreal32 v,
fpreal  t 
) const
inline

Definition at line 470 of file OP_Parameters.h.

void OP_Parameters::evalFloatsInst ( const UT_StringRef name,
const int inst,
fpreal32 v,
fpreal  t,
int  nestlevel = 1 
) const
void OP_Parameters::evalFloatsInst ( const UT_StringRef name,
const int inst,
fpreal64 v,
fpreal  t,
int  nestlevel = 1 
) const
inline

Definition at line 677 of file OP_Parameters.h.

void OP_Parameters::evalFloatsInstT ( const UT_StringRef name,
const int inst,
fpreal64 v,
fpreal  t,
int  thread,
int  nestlevel = 1 
) const
void OP_Parameters::evalFloatsT ( int  pi,
fpreal64 v,
fpreal  t,
int  thread 
) const
void OP_Parameters::evalFloatsT ( const UT_StringRef pn,
fpreal64 v,
fpreal  t,
int  thread 
) const
void OP_Parameters::evalFloatsT ( const UT_StringRef pn,
int pi,
fpreal64 v,
fpreal  t,
int  thread 
) const
void OP_Parameters::evalFloatsT ( const PRM_Parm parm,
fpreal64 v,
fpreal  t,
int  thread 
) const
void OP_Parameters::evalFloatsT ( int  pi,
fpreal32 v,
fpreal  t,
int  thread 
) const
void OP_Parameters::evalFloatsT ( const UT_StringRef pn,
fpreal32 v,
fpreal  t,
int  thread 
) const
void OP_Parameters::evalFloatsT ( const UT_StringRef pn,
int pi,
fpreal32 v,
fpreal  t,
int  thread 
) const
void OP_Parameters::evalFloatsT ( const PRM_Parm parm,
fpreal32 v,
fpreal  t,
int  thread 
) const
fpreal OP_Parameters::evalFloatT ( int  pi,
int  vi,
fpreal  t,
int  thread 
) const
fpreal OP_Parameters::evalFloatT ( const UT_StringRef pn,
int  vi,
fpreal  t,
int  thread 
) const
fpreal OP_Parameters::evalFloatT ( const UT_StringRef pn,
int pi,
int  vi,
fpreal  t,
int  thread 
) const
fpreal OP_Parameters::evalFloatT ( const PRM_Parm parm,
int  vi,
fpreal  t,
int  thread 
) const
exint OP_Parameters::evalInt ( const UT_StringRef pn,
int  vi,
fpreal  t 
) const
inline

Definition at line 400 of file OP_Parameters.h.

exint OP_Parameters::evalInt ( const UT_StringRef pn,
int pi,
int  vi,
fpreal  t 
) const
inline

Definition at line 404 of file OP_Parameters.h.

exint OP_Parameters::evalInt ( const PRM_Parm parm,
int  vi,
fpreal  t 
) const
inline

Definition at line 409 of file OP_Parameters.h.

exint OP_Parameters::evalIntInst ( const UT_StringRef name,
const int inst,
int  vi,
fpreal  t,
int  nestlevel = 1 
) const
inline
Examples:
SOP/SOP_HDKObject.h.

Definition at line 655 of file OP_Parameters.h.

exint OP_Parameters::evalIntInstT ( const UT_StringRef name,
const int inst,
int  vi,
fpreal  t,
int  thread,
int  nestlevel = 1 
) const
exint OP_Parameters::evalIntT ( int  pi,
int  vi,
fpreal  t,
int  thread 
) const
exint OP_Parameters::evalIntT ( const UT_StringRef pn,
int  vi,
fpreal  t,
int  thread 
) const
exint OP_Parameters::evalIntT ( const UT_StringRef pn,
int pi,
int  vi,
fpreal  t,
int  thread 
) const
exint OP_Parameters::evalIntT ( const PRM_Parm parm,
int  vi,
fpreal  t,
int  thread 
) const
void OP_Parameters::evalJSONMap ( UT_JSONValueMap val,
int  pi,
int  vi,
fpreal  t 
) const
inline

Definition at line 568 of file OP_Parameters.h.

void OP_Parameters::evalJSONMap ( UT_JSONValueMap val,
const UT_StringRef pn,
int  vi,
fpreal  t 
) const
inline

Definition at line 574 of file OP_Parameters.h.

void OP_Parameters::evalJSONMap ( UT_JSONValueMap val,
const UT_StringRef pn,
int pi,
int  vi,
fpreal  t 
) const
inline

Definition at line 582 of file OP_Parameters.h.

void OP_Parameters::evalJSONMap ( UT_JSONValueMap val,
const PRM_Parm parm,
int  vi,
fpreal  t 
) const
inline

Definition at line 593 of file OP_Parameters.h.

void OP_Parameters::evalJSONMapRaw ( UT_JSONValueMap val,
int  pi,
int  vi,
fpreal  t 
) const
inline

Definition at line 605 of file OP_Parameters.h.

void OP_Parameters::evalJSONMapRaw ( UT_JSONValueMap val,
const UT_StringRef pn,
int  vi,
fpreal  t 
) const
inline

Definition at line 613 of file OP_Parameters.h.

void OP_Parameters::evalJSONMapRaw ( UT_JSONValueMap val,
const UT_StringRef pn,
int pi,
int  vi,
fpreal  t 
) const
inline

Definition at line 623 of file OP_Parameters.h.

void OP_Parameters::evalJSONMapRaw ( UT_JSONValueMap val,
const PRM_Parm parm,
int  vi,
fpreal  t 
) const
inline

Definition at line 634 of file OP_Parameters.h.

void OP_Parameters::evalJSONMapRawT ( UT_JSONValueMap val,
int  pi,
int  vi,
fpreal  t,
int  thread 
) const
void OP_Parameters::evalJSONMapRawT ( UT_JSONValueMap val,
const UT_StringRef pn,
int  vi,
fpreal  t,
int  thread 
) const
void OP_Parameters::evalJSONMapRawT ( UT_JSONValueMap val,
const UT_StringRef pn,
int pi,
int  vi,
fpreal  t,
int  thread 
) const
void OP_Parameters::evalJSONMapRawT ( UT_JSONValueMap val,
const PRM_Parm parm,
int  vi,
fpreal  t,
int  thread 
) const
void OP_Parameters::evalJSONMapT ( UT_JSONValueMap val,
int  pi,
int  vi,
fpreal  t,
int  thread 
) const
void OP_Parameters::evalJSONMapT ( UT_JSONValueMap val,
const UT_StringRef pn,
int  vi,
fpreal  t,
int  thread 
) const
void OP_Parameters::evalJSONMapT ( UT_JSONValueMap val,
const UT_StringRef pn,
int pi,
int  vi,
fpreal  t,
int  thread 
) const
void OP_Parameters::evalJSONMapT ( UT_JSONValueMap val,
const PRM_Parm parm,
int  vi,
fpreal  t,
int  thread 
) const
bool OP_Parameters::evalParameterOrProperty ( const UT_StringRef parm_name,
int  vec_index,
fpreal  now,
int value,
PRM_Parm **  parmptr = NULL 
) const
inline

Definition at line 737 of file OP_Parameters.h.

bool OP_Parameters::evalParameterOrProperty ( const UT_StringRef parm_name,
int  vec_index,
fpreal  now,
fpreal values,
PRM_Parm **  parmptr = NULL 
) const
inline

Definition at line 753 of file OP_Parameters.h.

bool OP_Parameters::evalParameterOrProperty ( const UT_StringRef parm_name,
int  vec_index,
fpreal  now,
UT_String value,
PRM_Parm **  parmptr = NULL 
) const
inline

Definition at line 768 of file OP_Parameters.h.

bool OP_Parameters::evalParameterOrPropertyExpr ( const UT_StringRef parm_name,
int  vec_index,
fpreal  now,
UT_String value,
PRM_Parm **  parmptr = NULL 
) const
inline

Definition at line 802 of file OP_Parameters.h.

bool OP_Parameters::evalParameterOrPropertyExprT ( const UT_StringRef parm_name,
int  vec_index,
fpreal  now,
UT_String value,
int  thread,
PRM_Parm **  parmptr = NULL 
) const
bool OP_Parameters::evalParameterOrPropertyRaw ( const UT_StringRef parm_name,
int  vec_index,
fpreal  now,
UT_String value,
PRM_Parm **  parmptr = NULL 
) const
inline

Definition at line 784 of file OP_Parameters.h.

bool OP_Parameters::evalParameterOrPropertyRawT ( const UT_StringRef parm_name,
int  vec_index,
fpreal  now,
UT_String value,
int  thread,
PRM_Parm **  parmptr = NULL 
) const
bool OP_Parameters::evalParameterOrPropertyT ( const UT_StringRef parm_name,
int  vec_index,
fpreal  now,
int value,
int  thread,
PRM_Parm **  parmptr = NULL 
) const
bool OP_Parameters::evalParameterOrPropertyT ( const UT_StringRef parm_name,
int  vec_index,
fpreal  now,
fpreal values,
int  thread,
PRM_Parm **  parmptr = NULL 
) const
bool OP_Parameters::evalParameterOrPropertyT ( const UT_StringRef parm_name,
int  vec_index,
fpreal  now,
UT_String value,
int  thread,
PRM_Parm **  parmptr = NULL 
) const
void OP_Parameters::evalString ( UT_String val,
const UT_StringRef pn,
int  vi,
fpreal  t 
) const
inline

Definition at line 486 of file OP_Parameters.h.

void OP_Parameters::evalString ( UT_String val,
const char *  pn,
int pi,
int  vi,
fpreal  t 
) const
inline

Definition at line 493 of file OP_Parameters.h.

void OP_Parameters::evalString ( UT_String val,
const PRM_Parm parm,
int  vi,
fpreal  t 
) const
inline

Definition at line 502 of file OP_Parameters.h.

void OP_Parameters::evalStringInst ( const UT_StringRef name,
const int inst,
UT_String val,
int  vi,
fpreal  t,
int  nestlevel = 1 
) const
inline
Examples:
SOP/SOP_HDKObject.h, and VOP/VOP_CustomContext.C.

Definition at line 689 of file OP_Parameters.h.

void OP_Parameters::evalStringInstRaw ( const UT_StringRef name,
const int inst,
UT_String val,
int  vi,
fpreal  t,
int  nestlevel = 1 
) const
inline

Definition at line 701 of file OP_Parameters.h.

void OP_Parameters::evalStringInstRawT ( const UT_StringRef name,
const int inst,
UT_String val,
int  vi,
fpreal  t,
int  thread,
int  nestlevel = 1 
) const
void OP_Parameters::evalStringInstT ( const UT_StringRef name,
const int inst,
UT_String val,
int  vi,
fpreal  t,
int  thread,
int  nestlevel = 1 
) const
void OP_Parameters::evalStringRaw ( UT_String val,
int  pi,
int  vi,
fpreal  t 
) const
inline

Definition at line 512 of file OP_Parameters.h.

void OP_Parameters::evalStringRaw ( UT_String val,
const UT_StringRef pn,
int  vi,
fpreal  t 
) const
inline

Definition at line 520 of file OP_Parameters.h.

void OP_Parameters::evalStringRaw ( UT_String val,
const UT_StringRef pn,
int pi,
int  vi,
fpreal  t 
) const
inline

Definition at line 530 of file OP_Parameters.h.

void OP_Parameters::evalStringRaw ( UT_String val,
const PRM_Parm parm,
int  vi,
fpreal  t 
) const
inline

Definition at line 539 of file OP_Parameters.h.

void OP_Parameters::evalStringRawT ( UT_String val,
int  pi,
int  vi,
fpreal  t,
int  thread 
) const
void OP_Parameters::evalStringRawT ( UT_String val,
const UT_StringRef pn,
int  vi,
fpreal  t,
int  thread 
) const
void OP_Parameters::evalStringRawT ( UT_String val,
const UT_StringRef pn,
int pi,
int  vi,
fpreal  t,
int  thread 
) const
void OP_Parameters::evalStringRawT ( UT_String val,
const PRM_Parm parm,
int  vi,
fpreal  t,
int  thread 
) const
void OP_Parameters::evalStringT ( UT_String val,
int  pi,
int  vi,
fpreal  t,
int  thread 
) const
void OP_Parameters::evalStringT ( UT_String val,
const UT_StringRef pn,
int  vi,
fpreal  t,
int  thread 
) const
void OP_Parameters::evalStringT ( UT_String val,
const UT_StringRef pn,
int pi,
int  vi,
fpreal  t,
int  thread 
) const
void OP_Parameters::evalStringT ( UT_String val,
const PRM_Parm parm,
int  vi,
fpreal  t,
int  thread 
) const
bool OP_Parameters::evalVectorProperty ( const UT_StringRef parm_name,
fpreal  now,
int values,
int  vec_size,
PRM_Parm **  parmptr = NULL 
) const
inline

Definition at line 821 of file OP_Parameters.h.

bool OP_Parameters::evalVectorProperty ( const UT_StringRef parm_name,
fpreal  now,
fpreal values,
int  vec_size,
PRM_Parm **  parmptr = NULL 
) const
inline

Definition at line 837 of file OP_Parameters.h.

bool OP_Parameters::evalVectorPropertyT ( const UT_StringRef parm_name,
fpreal  now,
int values,
int  vec_size,
int  thread,
PRM_Parm **  parmptr = NULL 
) const
bool OP_Parameters::evalVectorPropertyT ( const UT_StringRef parm_name,
fpreal  now,
fpreal values,
int  vec_size,
int  thread,
PRM_Parm **  parmptr = NULL 
) const
bool OP_Parameters::expandString ( UT_String val,
fpreal  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_nameChannel 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 1218 of file OP_Parameters.h.

fpreal OP_Parameters::findKey ( fpreal  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 VOP_Node, and 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 ( const OP_FollowChanRefsOptions opt,
OP_Node *&  newop,
PRM_Parm *&  newparm,
int newvecidx 
)
inlinestatic

Definition at line 332 of file OP_Parameters.h.

static void OP_Parameters::followChannelReferences ( const OP_FollowChanRefsOptions opt,
CH_ChannelRef ref 
)
inlinestatic

Definition at line 346 of file OP_Parameters.h.

static bool OP_Parameters::followChannelReferencesOneStep ( const OP_FollowChanRefsOptions opt,
OP_Node *&  newop,
PRM_Parm *&  newparm,
int newvecidx 
)
inlinestatic

Definition at line 318 of file OP_Parameters.h.

static bool OP_Parameters::followChannelReferencesOneStepT ( const OP_FollowChanRefsOptions opt,
OP_Node *&  newop,
PRM_Parm *&  newparm,
int newvecidx,
int  thread 
)
static
static void OP_Parameters::followChannelReferencesT ( const OP_FollowChanRefsOptions opt,
OP_Node *&  newop,
PRM_Parm *&  newparm,
int newvecidx,
int  thread 
)
static
static void OP_Parameters::followChannelReferencesT ( const OP_FollowChanRefsOptions opt,
CH_ChannelRef ref,
int  thread 
)
static
int OP_Parameters::getAnyUndoPending ( ) const
inline

Definition at line 1355 of file OP_Parameters.h.

void OP_Parameters::getAutoScopedChannels ( CH_ChannelRefList chlist,
bool  follow_layer_overrides = true,
bool  include_animated = false,
bool  follow_channel_refs = true,
bool  include_autoscope = true 
)

Returns a list of the autoscopeable channels for this node. if follow_layer_overrides is true, the channel references are followed but only for animation layers. if include_animated is true, channels without the auto scope flag but with animation will also be returned.

CH_Channel* OP_Parameters::getChannel ( const char *  name)
const CH_Channel* OP_Parameters::getChannel ( const char *  name) const
OP_Channels* OP_Parameters::getChannels ( void  ) const
inline
Examples:
SOP/SOP_PrimVOP.C.

Definition at line 192 of file OP_Parameters.h.

PRM_ChanState OP_Parameters::getChanState ( fpreal  t,
bool  scoped_only 
) const
void OP_Parameters::getChopScopeChannels ( UT_WorkBuffer chopscope_cmd)
unsigned OP_Parameters::getEnableState ( int  pi,
int  v = -1 
)
unsigned OP_Parameters::getEnableState ( const char *  pn,
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 1204 of file OP_Parameters.h.

virtual OP_ERROR OP_Parameters::getErrorSeverity ( )
virtual

Reimplemented in OP_Network, and COP2_Node.

CH_ExprLanguage OP_Parameters::getExprLanguage ( ) const
overridevirtual

Implements PRM_ParmOwner.

virtual int OP_Parameters::getHasTakeData ( ) const
inlineprotectedvirtual

Reimplemented in OP_Node.

Definition at line 1596 of file OP_Parameters.h.

const PRM_Template* OP_Parameters::getInterfaceParmTemplates ( ) const
bool OP_Parameters::getIsChangingSpareParms ( ) const
inline

Definition at line 257 of file OP_Parameters.h.

static void OP_Parameters::getLayersFromScopedChannels ( const CH_ChannelRefList ori_refs,
CH_ChannelRefList layer_refs 
)
static
UT_LockedRawPtr<UT_ErrorManager,OP_Lock> OP_Parameters::getLockedErrorManager ( )
inlineprotected

Definition at line 1513 of file OP_Parameters.h.

int64 OP_Parameters::getMemoryUsage ( bool  inclusive) const
overridevirtual

Reimplemented from PRM_ParmOwner.

Reimplemented in SOP_Node.

OP_MultiparmInfo& OP_Parameters::getMultiparmInfo ( )
const UT_String& OP_Parameters::getName ( void  ) const
inline
int OP_Parameters::getNumParms ( ) const
inline

Definition at line 211 of file OP_Parameters.h.

OP_Operator* OP_Parameters::getOperator ( ) const
inline
Examples:
expr/functions.C, and VOP/VOP_CustomContext.C.

Definition at line 131 of file OP_Parameters.h.

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

Track down the parameter associated with a given property

Reimplemented in VOP_Node, OBJ_Node, and VOP_Collect.

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

Track down the parameter associated with a given property

Reimplemented in VOP_Node, OBJ_Node, and VOP_Collect.

bool OP_Parameters::getParameterOrPropertyConst ( const UT_StringRef name,
fpreal  now,
OP_Node *&  op,
PRM_Parm *&  parm,
PRM_ParmList obsolete 
) const
inline

This just calls getParameterOrProperty() with create_missing_multiparms=false and allows for const correctness.

Definition at line 298 of file OP_Parameters.h.

PRM_Parm& OP_Parameters::getParm ( int  i)
inline

Definition at line 215 of file OP_Parameters.h.

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

Definition at line 221 of file OP_Parameters.h.

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

Definition at line 227 of file OP_Parameters.h.

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

Definition at line 233 of file OP_Parameters.h.

int OP_Parameters::getParmIndex ( const char *  name) const
inline
Examples:
CHOP/CHOP_Blend.C, CHOP/CHOP_Spring.C, and CHOP/CHOP_Stair.C.

Definition at line 213 of file OP_Parameters.h.

bool OP_Parameters::getParmIsVisible ( const char *  parmname)
PRM_Parm* OP_Parameters::getParmPtr ( const UT_StringRef name)
inline

Definition at line 241 of file OP_Parameters.h.

const PRM_Parm* OP_Parameters::getParmPtr ( const UT_StringRef name) const
inline

Definition at line 243 of file OP_Parameters.h.

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
virtual void OP_Parameters::getRawErrors ( UT_Array< UT_Error > &  errors,
bool  update 
)
virtual

Reimplemented in OP_Network.

OP_ERROR OP_Parameters::getSaveError ( )
const PRM_ScriptImports* OP_Parameters::getSpareParmLayoutTemplateImports ( ) const
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
const OP_Stat& OP_Parameters::getStat ( ) const
inline

Definition at line 359 of file OP_Parameters.h.

OP_Stat& OP_Parameters::getStat ( )
inline

Definition at line 360 of file OP_Parameters.h.

CH_StringMeaning OP_Parameters::getStringMeaning ( int  pi,
int  vi,
fpreal  t 
) const
CH_StringMeaning OP_Parameters::getStringMeaning ( const char *  pn,
int  vi,
fpreal  t 
) const
CH_StringMeaning OP_Parameters::getStringMeaningInst ( const char *  name,
const int inst,
int  vi,
fpreal  t,
int  nest_level = 1 
) const
int OP_Parameters::getTakeReferences ( ) const
inline

Definition at line 1405 of file OP_Parameters.h.

static void OP_Parameters::getValueAsProcessedNodePaths ( fpreal  t,
UT_WorkBuffer resultbuf,
PRM_Parm parm,
int  index,
OP_Node srcnode 
)
static
CH_LocalVariable* OP_Parameters::getVariable ( int  i) const
protected
CH_LocalVariable* OP_Parameters::getVariable ( const char *  name) const
protected
virtual void OP_Parameters::getVariableString ( int  index,
UT_String value,
int  thread 
)
virtual
Deprecated:
Please override evalVariableValue() above instead
virtual float OP_Parameters::getVariableValue ( int  index,
int  thread 
)
virtual
Deprecated:
Please override the evalVariableValue() above instead
bool OP_Parameters::getVisibleState ( int  pi,
int  v = -1 
)
bool OP_Parameters::getVisibleState ( const char *  pn,
int  v = -1 
)
bool OP_Parameters::hasDeadlockError ( ) const
inline

Definition at line 1290 of file OP_Parameters.h.

bool OP_Parameters::hasMultiparmInfo ( ) const
bool OP_Parameters::hasParm ( const char *  name) const
inline

Definition at line 239 of file OP_Parameters.h.

void OP_Parameters::initializeParms ( OP_Channels channels)
protected
void OP_Parameters::initMultiparmInstance ( UT_ValArray< PRM_Parm * > &  parms)
overridevirtual

Implements PRM_ParmOwner.

void OP_Parameters::insertMultiParmItem ( const char *  pn,
int  i 
)
PRM_ChanState OP_Parameters::isAtKey ( fpreal  t) const
inline

Definition at line 187 of file OP_Parameters.h.

bool OP_Parameters::isGettingSaveError ( ) const
inline

Definition at line 1337 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 ( int  idx,
fpreal  t 
)
bool OP_Parameters::isParmDirty ( const char *  n,
fpreal  t 
)
bool OP_Parameters::isParmDirtyInst ( const char *  name,
const int inst,
fpreal  t,
int  nestlevel = 1 
)
bool OP_Parameters::isParmTimeDependent ( int  idx,
int  comp = -1 
) const

Query if a parameter is time dependent, by parm index. If comp == -1, any vector component that is time dependent will return true for the parm.

bool OP_Parameters::isParmTimeDependent ( const char *  name,
int  comp = -1 
) const

Query if a parameter is time dependent, by parm name. If comp == -1, any vector component that is time dependent will return true for the parm.

bool OP_Parameters::isPending ( fpreal  t)
static bool OP_Parameters::isReservedOpName ( const char *  name)
staticprotected
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,
const char *const  argv[],
int  docallbacks,
void data,
fpreal  now,
bool  followchrefs,
CMD_Args args 
)
bool OP_Parameters::loadPresetContents ( const char *  tok,
UT_IStream is 
)
overridevirtual

Implements PRM_ParmOwner.

int OP_Parameters::numSpareInputs ( ) const

The number of potential spare inputs created by spare parameters. These are spare_input0 and onwards. There may be holes.

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

Definition at line 1240 of file OP_Parameters.h.

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

Definition at line 1242 of file OP_Parameters.h.

void OP_Parameters::opLocalDeadlockError ( )
inline

Definition at line 1255 of file OP_Parameters.h.

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

Definition at line 1245 of file OP_Parameters.h.

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

Definition at line 1250 of file OP_Parameters.h.

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

Definition at line 1236 of file OP_Parameters.h.

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

Definition at line 1238 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)
protectedvirtual

Reimplemented in OP_Node.

virtual unsigned OP_Parameters::referenceAllParameters ( OP_Parameters from,
bool  relative_references = true 
)
virtual

Reimplemented in OP_Node, and COP2_Node.

virtual bool OP_Parameters::referenceSingleParameter ( OP_Parameters from,
int  parm_idx,
const char *  relative_path = NULL 
)
virtual

Reference a single parameter from the from node. This builds a channel reference for the given parameter index. If the relative_path isn't specified, it will be computed as

from->getFullPath(frompath);
this->getFullPath(thispath);
relative_path.getRelativePath(thispath, frompath);

Reimplemented in ROP_Node.

virtual int OP_Parameters::reloadNewFiles ( fpreal  time_now)
virtual

Reimplemented in SOP_MDD.

int OP_Parameters::removeError ( int  idx)
inline

Definition at line 1224 of file OP_Parameters.h.

void OP_Parameters::removeMultiParmItem ( const char *  pn,
int  i 
)
virtual int OP_Parameters::rename ( const char *  newname)
protectedvirtual
void OP_Parameters::resetParmEventHandler ( )
protected
void OP_Parameters::resolveAndDeleteObsoleteParmList ( PRM_ParmList *&  obsolete_parms)
overridevirtual

Implements PRM_ParmOwner.

virtual void OP_Parameters::resolveObsoleteParms ( PRM_ParmList )
inlinevirtual
OP_ERROR OP_Parameters::saveChannelAliases ( std::ostream &  os,
int  binary 
)
protected
OP_ERROR OP_Parameters::saveChannels ( std::ostream &  os,
int  binary,
bool  compiled,
int  selected 
)
protected
virtual void OP_Parameters::saveKeyFrameForUndo ( CH_Channel chp,
fpreal  gtime 
)
virtual
void OP_Parameters::saveMultiParmForUndo ( int  index)
protected
void OP_Parameters::saveMultiParmInstanceCommand ( std::ostream &  os,
const char *  opname,
bool  spareparms 
) const
OP_ERROR OP_Parameters::saveParameters ( std::ostream &  os,
int  binary,
bool  compiled 
)
protected
OP_ERROR OP_Parameters::saveParmChannels ( int  parm_index,
std::ostream &  os,
int  binary,
bool  compiled 
)
protected
void OP_Parameters::saveParmCommand ( std::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
bool OP_Parameters::savePresetContents ( std::ostream &  os)
overridevirtual

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,
fpreal  now,
bool  set_key = false,
bool  create_channels = false 
)
static
void OP_Parameters::setChRefFloat ( int  pi,
int  vi,
fpreal  t,
fpreal  val,
PRM_AddKeyType  add_key = PRM_AK_MARK_PENDING,
bool  propagate = true 
)
void OP_Parameters::setChRefFloat ( const char *  pn,
int  vi,
fpreal  t,
fpreal  val,
PRM_AddKeyType  add_key = PRM_AK_MARK_PENDING,
bool  propagate = true 
)
void OP_Parameters::setChRefInt ( int  pi,
int  vi,
fpreal  t,
exint  val,
PRM_AddKeyType  add_key = PRM_AK_MARK_PENDING,
bool  propagate = true 
)
void OP_Parameters::setChRefInt ( const char *  pn,
int  vi,
fpreal  t,
exint  val,
PRM_AddKeyType  add_key = PRM_AK_MARK_PENDING,
bool  propagate = true 
)
void OP_Parameters::setChRefString ( const UT_StringRef val,
CH_StringMeaning  meaning,
int  pi,
int  vi,
fpreal  t,
PRM_AddKeyType  add_key = PRM_AK_MARK_PENDING,
bool  propagate = true 
)
void OP_Parameters::setChRefString ( int  pi,
int  vi,
fpreal  t,
const UT_StringRef val,
CH_StringMeaning  meaning,
PRM_AddKeyType  add_key = PRM_AK_MARK_PENDING,
bool  propagate = true 
)
inline

Definition at line 941 of file OP_Parameters.h.

void OP_Parameters::setChRefString ( const UT_StringRef val,
CH_StringMeaning  meaning,
const char *  pn,
int  vi,
fpreal  t,
PRM_AddKeyType  add_key = PRM_AK_MARK_PENDING,
bool  propagate = true 
)
void OP_Parameters::setChRefString ( const char *  pn,
int  vi,
fpreal  t,
const UT_StringRef val,
CH_StringMeaning  meaning,
PRM_AddKeyType  add_key = PRM_AK_MARK_PENDING,
bool  propagate = true 
)
inline

Definition at line 959 of file OP_Parameters.h.

void OP_Parameters::setData ( int  parmi,
int  vectori,
fpreal  t,
const PRM_DataItemHandle val 
)
void OP_Parameters::setData ( const char *  parmname,
int  vectori,
fpreal  t,
const PRM_DataItemHandle val 
)
void OP_Parameters::setData ( const char *  parmname,
int parmi,
int  vectori,
fpreal  t,
const PRM_DataItemHandle val 
)
void OP_Parameters::setDataInst ( const PRM_DataItemHandle value,
const char *  parmname,
const int inst,
int  vectori,
fpreal  t,
int  nestlevel = 1 
)
void OP_Parameters::setExprLanguage ( CH_ExprLanguage  language)
void OP_Parameters::setFloat ( int  parmi,
int  vectori,
fpreal  t,
fpreal  value,
PRM_AddKeyType  add_key = PRM_AK_MARK_PENDING 
)
void OP_Parameters::setFloat ( const char *  parmname,
int  vectori,
fpreal  t,
fpreal  value,
PRM_AddKeyType  add_key = PRM_AK_MARK_PENDING 
)
void OP_Parameters::setFloat ( const char *  parmname,
int parmi,
int  vectori,
fpreal  t,
fpreal  value,
PRM_AddKeyType  add_key = PRM_AK_MARK_PENDING 
)
void OP_Parameters::setFloatInst ( fpreal  value,
const char *  parmname,
const int inst,
int  vectori,
fpreal  t,
int  nestlevel = 1 
)
void OP_Parameters::setInt ( int  parmi,
int  vectori,
fpreal  t,
exint  value 
)
void OP_Parameters::setInt ( const char *  parmname,
int  vectori,
fpreal  t,
exint  value 
)
void OP_Parameters::setInt ( const char *  parmname,
int parmi,
int  vectori,
fpreal  t,
exint  value 
)
void OP_Parameters::setIntInst ( exint  value,
const char *  parmname,
const int inst,
int  vectori,
fpreal  t,
int  nestlevel = 1 
)
Examples:
SOP/SOP_HDKObject.h.
bool OP_Parameters::setParameterOrProperty ( const char *  parm_name,
int  vec_index,
fpreal  now,
int32  value,
bool  set_key = false,
bool  propagate = true 
)
bool OP_Parameters::setParameterOrProperty ( const char *  parm_name,
int  vec_index,
fpreal  now,
int64  value,
bool  set_key = false,
bool  propagate = true 
)
bool OP_Parameters::setParameterOrProperty ( const char *  parm_name,
int  vec_index,
fpreal  now,
fpreal  value,
bool  set_key = false,
bool  propagate = true 
)
bool OP_Parameters::setParameterOrProperty ( const char *  parm_name,
int  vec_index,
fpreal  now,
const char *  value,
CH_StringMeaning  meaning,
bool  set_key = false,
bool  propagate = true 
)
void OP_Parameters::setSilentData ( int  parmi,
int  vectori,
fpreal  t,
const PRM_DataItemHandle value 
)
void OP_Parameters::setSilentData ( const char *  parmname,
int  vectori,
fpreal  t,
const PRM_DataItemHandle value 
)
void OP_Parameters::setSilentData ( const char *  parmname,
int parmi,
int  vectori,
fpreal  t,
const PRM_DataItemHandle value 
)
void OP_Parameters::setSilentDataInst ( const PRM_DataItemHandle value,
const char *  parmname,
const int inst,
int  vectori,
fpreal  t,
int  nestlevel = 1 
)
void OP_Parameters::setSilentFloat ( int  parmi,
int  vectori,
fpreal  t,
fpreal  value,
PRM_AddKeyType  add_key = PRM_AK_MARK_PENDING 
)
void OP_Parameters::setSilentFloat ( const char *  parmname,
int  vectori,
fpreal  t,
fpreal  value,
PRM_AddKeyType  add_key = PRM_AK_MARK_PENDING 
)
void OP_Parameters::setSilentFloat ( const char *  parmname,
int parmi,
int  vectori,
fpreal  t,
fpreal  value,
PRM_AddKeyType  add_key = PRM_AK_MARK_PENDING 
)
void OP_Parameters::setSilentFloatInst ( fpreal  value,
const char *  parmname,
const int inst,
int  vectori,
fpreal  t,
int  nestlevel = 1 
)
void OP_Parameters::setSilentInt ( int  parmi,
int  vectori,
fpreal  t,
exint  value 
)
void OP_Parameters::setSilentInt ( const char *  parmname,
int  vectori,
fpreal  t,
exint  value 
)
void OP_Parameters::setSilentInt ( const char *  parmname,
int parmi,
int  vectori,
fpreal  t,
exint  value 
)
void OP_Parameters::setSilentIntInst ( exint  value,
const char *  parmname,
const int inst,
int  vectori,
fpreal  t,
int  nestlevel = 1 
)
void OP_Parameters::setSilentString ( const UT_StringRef value,
CH_StringMeaning  meaning,
int  parmi,
int  vectori,
fpreal  t 
)
void OP_Parameters::setSilentString ( const UT_StringRef value,
CH_StringMeaning  meaning,
const char *  parmname,
int  vectori,
fpreal  t 
)
void OP_Parameters::setSilentString ( const UT_StringRef value,
CH_StringMeaning  meaning,
const char *  parmname,
int parmi,
int  vectori,
fpreal  t 
)
void OP_Parameters::setSilentStringInst ( const UT_StringRef value,
CH_StringMeaning  meaning,
const char *  parmname,
const int inst,
int  vectori,
fpreal  t,
int  nestlevel = 1 
)
void OP_Parameters::setString ( const UT_StringRef val,
CH_StringMeaning  meaning,
int  parmi,
int  vectori,
fpreal  t 
)
void OP_Parameters::setString ( const UT_StringRef val,
CH_StringMeaning  meaning,
const char *  parmname,
int  vectori,
fpreal  t 
)
void OP_Parameters::setString ( const UT_StringRef val,
CH_StringMeaning  meaning,
const char *  parmname,
int parmi,
int  vectori,
fpreal  t 
)
void OP_Parameters::setStringInst ( const UT_StringRef value,
CH_StringMeaning  meaning,
const char *  parmname,
const int inst,
int  vectori,
fpreal  t,
int  nestlevel = 1 
)
bool OP_Parameters::setVisibleState ( int  pi,
bool  state,
int  v = -1 
)
bool OP_Parameters::setVisibleState ( const char *  pn,
bool  state,
int  v = -1 
)
bool OP_Parameters::setVisibleStateInst ( const char *  name,
const int inst,
int  state,
int  nestlevel = 1,
int  v = -1 
)
void OP_Parameters::stealErrors ( UT_ErrorManager src,
bool  borrow_only = false 
)
void OP_Parameters::stealErrors ( OP_Parameters src)
protected
void OP_Parameters::stealGlobalErrors ( )
protected
virtual void OP_Parameters::syncNodeVersion ( const char *  old_version,
const char *  current_version,
bool *  node_deleted 
)
inlinevirtual

Sync the node assuming that it is currently at old_version to the current_version.

Reimplemented in OP_Node, SOP_Edit, DOP_Auto, OBJ_Null, SOP_UVFlatten, SOP_UVLayout, SOP_Cache, SOP_AttribComp, and SOP_PolyExtrude2.

Definition at line 272 of file OP_Parameters.h.

void OP_Parameters::takeActivateParm ( uint  idx,
bool  enable = true 
)
void OP_Parameters::takeActivateParm ( const char *  name,
bool  enable = true 
)
void OP_Parameters::takeActivateParm ( PRM_Parm parm,
bool  enable = true 
)
void OP_Parameters::takeAutoActivateParm ( PRM_Parm )
overridevirtual

Implements PRM_ParmOwner.

void OP_Parameters::takeDeactivateParm ( uint  idx)
inline

Definition at line 169 of file OP_Parameters.h.

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

Definition at line 171 of file OP_Parameters.h.

void OP_Parameters::takeDeactivateParm ( PRM_Parm parm)
inline

Definition at line 173 of file OP_Parameters.h.

bool OP_Parameters::takeIsActiveParm ( uint  idx)
bool OP_Parameters::takeIsActiveParm ( const char *  name)
bool OP_Parameters::takeIsActiveParm ( const PRM_Parm parm)
virtual void OP_Parameters::traverseScope ( const char *  pattern,
OP_ScopeOp  scope_op,
const OP_ScopeOptions scope_options 
)
protectedvirtual

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.

void OP_Parameters::triggerOPChanged ( OP_EventType  reason,
int  index 
)
virtual bool OP_Parameters::triggerParmCallback ( PRM_Parm parmptr,
fpreal  now,
int  value,
void data,
const UT_Options options = 0 
)
pure virtual

Implemented in OP_Node.

void OP_Parameters::updateMultiParmFromRamp ( fpreal  t,
const UT_Ramp ramp,
PRM_Parm m,
bool  add_wrap,
PRM_AddKeyType  add_key = PRM_AK_MARK_PENDING 
)

updateMultiParmFromRamp() will follow simple channel references as necessary

bool OP_Parameters::updateParmDisableConditional ( PRM_Parm parm,
bool  force,
const UT_StringArray skip = 0 
)
protected
bool OP_Parameters::updateParmHideConditional ( PRM_Parm parm,
const UT_StringArray skip = 0 
)
protected
bool OP_Parameters::updateParmsAndSpareParmsFlags ( )
void OP_Parameters::updatePending ( fpreal  t)
void OP_Parameters::updateRampFromMultiParm ( fpreal  t,
const PRM_Parm m,
UT_Ramp ramp,
bool *  time_dep = NULL,
DEP_MicroNode depnode = NULL 
) const
void OP_Parameters::updateUserMask ( )

Friends And Related Function Documentation

friend class OP_TakeParm
friend

Definition at line 1723 of file OP_Parameters.h.

friend class OP_UndoParm
friend

Definition at line 1724 of file OP_Parameters.h.

friend class OP_UndoSpareParm
friend

Definition at line 1725 of file OP_Parameters.h.

Member Data Documentation

OP_Channels* OP_Parameters::myChannels
protected
Examples:
CHOP/CHOP_Stair.C.

Definition at line 1607 of file OP_Parameters.h.

OP_Stat OP_Parameters::myStats
protected

Definition at line 1608 of file OP_Parameters.h.


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