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

#include <PRM_Instance.h>

+ Inheritance diagram for PRM_Instance:

Public Member Functions

 PRM_Instance (PRM_Template *thetemplateptr, PRM_Parm *parm)
 
 PRM_Instance (PRM_Instance *thesrcptr, PRM_Parm *parm)
 
virtual ~PRM_Instance ()
 
virtual void adopt (PRM_Instance &thesrcinstance)
 
virtual void adoptOverrides (PRM_Instance &thesrcinstance)
 
virtual PRM_InstanceduplicateSelf (PRM_Parm *node)=0
 
virtual void setValueToDefault (fpreal time, int index, PRM_AddKeyType add_key)=0
 
virtual void revertToDefault (int index)=0
 
virtual void revertToDefaults (bool clear_channels=true)=0
 
virtual void restoreFactoryDefault (int index)=0
 
virtual void overwriteDefault (fpreal time, int index)=0
 
virtual void overwriteDefaults (fpreal time)=0
 
virtual int isDefault (int index, enum PRM_DefaultType deftype, bool basiccheck=true) const
 
bool isAllDefault (enum PRM_DefaultType deftype) const
 
virtual void save (std::ostream &os, int binary, bool compiled) const =0
 
virtual bool load (UT_IStream &is)=0
 
virtual void saveUndoData (PRM_UndoDataHandle &data) const
 
virtual bool loadUndoData (const PRM_UndoDataHandle &data)
 
virtual void saveCommand (std::ostream &os, int values=0, int index=-1) const =0
 
virtual int loadCommand (int argc, const char *const argv[], int index, bool values_only, PRM_AddKeyType add_key, PRM_KeySetType set_type)=0
 
virtual void getValue (PRM_ParmList *parm_list, fpreal time, int32 &value, int index, int thread) const =0
 
virtual void getValue (PRM_ParmList *parm_list, fpreal time, int64 &value, int index, int thread) const =0
 
virtual void getValue (PRM_ParmList *parm_list, fpreal time, fpreal &value, int index, int thread) const =0
 
virtual void getValue (PRM_ParmList *parm_list, fpreal time, UT_String &value, int index, bool expand, int thread) const =0
 
virtual void getValue (PRM_ParmList *parm_list, fpreal time, PRM_DataItemHandle &value, int index, int thread) const =0
 
virtual void getValue (PRM_ParmList *parm_list, fpreal time, UT_JSONValueMap &value, int index, bool expand, int thread) const =0
 
virtual void getValues (PRM_ParmList *parm_list, fpreal time, fpreal32 *value, int thread) const
 
virtual void getValues (PRM_ParmList *parm_list, fpreal time, fpreal64 *value, int thread) const
 
virtual void getValues (PRM_ParmList *parm_list, fpreal time, int32 *theints, int thread) const
 
virtual void getValues (PRM_ParmList *parm_list, fpreal time, int64 *theints, int thread) const
 
virtual void getDefaultValue (fpreal &value, int index) const
 
virtual void getDefaultValue (int32 &value, int index) const
 
virtual void getDefaultValue (int64 &value, int index) const
 
virtual void getDefaultValue (UT_String &value, int index) const
 
virtual void getExpressionStringForUI (fpreal time, UT_String &value, int index, int thread) const =0
 
virtual void getExpression (fpreal time, UT_String &value, int index, bool allow_value, int thread) const =0
 
virtual void setExpression (fpreal time, const char *value, CH_ExprLanguage language, int index, bool evaluate=true, bool rmchannel=false)
 
CH_StringMeaning getStringMeaning (fpreal time, int index) const
 
CH_ExprLanguage getExprLanguageIfMadeAnExpression (fpreal time, int index) const
 
bool languageIsNodesLanguage (fpreal time, int index) const
 
virtual void setValue (fpreal time, const char *value, CH_StringMeaning meaning, bool kill_expr=false, int index=0, PRM_AddKeyType add_key=PRM_AK_MARK_PENDING, PRM_KeySetType setkey=PRM_USE_PREFERENCES)
 
virtual void setValue (fpreal time, fpreal value, bool kill_expr=false, const int index=0, PRM_AddKeyType add_key=PRM_AK_MARK_PENDING, PRM_KeySetType setkey=PRM_USE_PREFERENCES)
 
virtual void setValue (fpreal time, int32 value, bool kill_expr=false, const int index=0, PRM_AddKeyType add_key=PRM_AK_MARK_PENDING, PRM_KeySetType setkey=PRM_USE_PREFERENCES)
 
virtual void setValue (fpreal time, int64 value, bool kill_expr=false, const int index=0, PRM_AddKeyType add_key=PRM_AK_MARK_PENDING, PRM_KeySetType setkey=PRM_USE_PREFERENCES)
 
virtual void setValue (fpreal time, const PRM_DataItemHandle &value, bool kill_expr=false, const int index=0, PRM_AddKeyType add_key=PRM_AK_MARK_PENDING, PRM_KeySetType setkey=PRM_USE_PREFERENCES)
 
virtual void setValues (fpreal time, const fpreal *values, bool kill_expr=false, PRM_AddKeyType add_key=PRM_AK_MARK_PENDING, PRM_KeySetType setkey=PRM_USE_PREFERENCES)
 
virtual void setValues (fpreal time, const int32 *values, bool kill_expr=false, PRM_AddKeyType add_key=PRM_AK_MARK_PENDING, PRM_KeySetType setkey=PRM_USE_PREFERENCES)
 
virtual void setValues (fpreal time, const int64 *values, bool kill_expr=false, PRM_AddKeyType add_key=PRM_AK_MARK_PENDING, PRM_KeySetType setkey=PRM_USE_PREFERENCES)
 
virtual void setDefaultChannelValue (CH_Channel *channelptr, int index=0)=0
 
virtual bool isMultiParm () const
 
virtual int getMultiParmNumItems () const
 
virtual int getMultiParmInstancesPerItem () const
 
virtual const char * getMultiParmToken (int p, int index) const
 
virtual void insertMultiParmItem (int index)
 
virtual void removeMultiParmItem (int index)
 
virtual void buildOpDependencies (const PRM_RefId &ref, int thread)
 
virtual void changeOpRef (const char *new_fullpath, const char *old_fullpath, const char *old_cwd, const char *chan_name, const char *old_chan_name, void(*undo_callback)(void *), void *undo_data, int thread)
 
fpreal findNextKey (fpreal theoldtime, int index=-1)
 
fpreal findPrevKey (fpreal theoldtime, int index=-1)
 
virtual int findString (const char *str, bool fullword, bool usewildcards) const
 
virtual int changeString (const char *from, const char *to, bool fullword)
 
virtual bool notifyVarChange (int subindex, const char *varname)
 
virtual bool getMagicString (UT_TokenString &magic, PRM_ParmList *list, int size, fpreal t, bool add_if_default, int thread)=0
 
unsigned getEnableState (int comp=-1) const
 
bool setEnableState (bool f, int comp=-1)
 
int getExpressionState () const
 
void setExpressionState (int state)
 
int getValueState () const
 
void setValueState (int state)
 
virtual bool isEditable (PRM_ParmList *thelist, fpreal time, int index) const
 
virtual bool isEditableByUI (PRM_ParmList *thelist, fpreal time, int index) const
 
CH_CollectiongetChannelGroupPtr () const
 
fpreal getEvalTime (int thread) const
 
fpreal getGlobalStartTime () const
 
CH_ChannelgetChannel (int subindex) const
 
void setChannel (int subindex, CH_Channel *chp)
 
void reloadChannelPtrs ()
 
int channelPtrModified (const UT_StringRef &name)
 
void internalAddChannel (int index, const char *theexpr, CH_ExprLanguage language, bool add_seg=true)
 
void addChannel (int index)
 
int addChannel (const UT_StringRef &name)
 
void addChannel (int index, const char *theexpr, CH_ExprLanguage language)
 
int addChannel (const UT_StringRef &name, const char *expr, CH_ExprLanguage language)
 
bool removeChannel (int index)
 
int getChannelCount () const
 
virtual bool isTimeDependent (int subindex) const
 
virtual bool isDataDependent (fpreal gtime, int subindex) const
 
virtual void setTimeDependent (int subindex, bool timedep)
 
void setTimeDependentForEval (int vi, bool timedep) const
 
bool hasContextOptionDeps (int subindex) const
 
const DEP_ContextOptionDepsgetContextOptionDeps (int subindex) const
 
void addContextOptionDep (int subindex, const UT_StringHolder &opt)
 
int changePending (int index)
 
virtual PRM_ChanState getChanState (fpreal time, int index) const
 
virtual PRM_ChanState getChanState (fpreal time) const
 
virtual void hardenChanges (fpreal time, int index, bool theforceflag, const char *patt=0, CH_ChannelRefList *list=0)=0
 
void setKey (fpreal time, int index)
 
void setKey (fpreal time, int index, const char *expr, CH_ExprLanguage language, const char *patt=0, CH_ChannelRefList *list=0)
 
void setFullKey (fpreal gtime, int index, CH_FullKey const &key, bool accel_ratios=true)
 
unsigned int getSaveFlags () const
 
void setSaveFlags (unsigned int f)
 
bool getActiveTakeFlag () const
 
bool getAlwaysTakeFlag () const
 
void setActiveTakeFlag (int onoff)
 
bool getBypassFlag () const
 
void setBypassFlag (bool onoff)
 
bool getVisibleState (int comp=-1) const
 
void setVisibleState (bool f, int comp=-1)
 
bool getUndoSavedFlag ()
 
void setUndoSavedFlag (bool f)
 
bool getAutoTakeUndoSavedFlag ()
 
void setAutoTakeUndoSavedFlag (bool f)
 
bool getSaveAutoScopeFlag () const
 
bool getSaveAutoSelectFlag () const
 
void setSaveLabelFlag (bool f)
 
bool getSaveLabelFlag () const
 
bool getLockedFlag (int vec_idx) const
 
bool areAllComponentsLocked () const
 
void setLockedFlag (int vec_idx, bool f)
 
bool getAutoScopedFlag (int vec_idx) const
 
void setAutoScopedFlag (int vec_idx, bool f)
 
bool getDefaultsInitFlag () const
 
void setDefaultsInitFlag (bool f)
 
unsigned int getLockField () const
 
unsigned int getAutoScopeField () const
 
virtual int setOverride (int index, int data_idx, const char *source, PRM_OverrideType type)
 
virtual int setOverrideDisable (int index, int onoff)
 
virtual const char * getOverride (int index) const
 
virtual bool getOverrideType (int index, PRM_OverrideType &type) const
 
virtual int getOverrideDataIndex (int index) const
 
virtual int getIsOverrideActive (int index) const
 
virtual void destroyChildParms ()
 
bool isDirty (int vec_idx) const
 
bool areAllFlagsClean () const
 
void clearAllDirtyFlags ()
 
void setDirtyFlags (int vec_idx)
 
bool isSendExtra (int vi) const
 
bool hasAnySendExtraFlags () const
 
void setSendExtra (int vi)
 
void createInputNotifyValue ()
 
PRM_ValueinputNotifyValue ()
 
const PRM_ValueinputNotifyValue () const
 
const PRM_TypegetType () const
 
PRM_TypeExtended getTypeExtended () const
 
PRM_MultiType getMultiType () const
 
fpreal getMultiSize () const
 
int getMultiStartOffset () const
 
const PRM_TemplategetMultiParmTemplate () const
 
PRM_TemplategetMultiParmTemplate ()
 
const char * getToken () const
 
const char * getLabel () const
 
PRM_Callback getCallback () const
 
int getVectorSize () const
 
const PRM_RangegetRangePtr () const
 
void getChannelToken (UT_String &chname, int i) const
 
const UT_StringHoldergetChannelToken (int i) const
 
const PRM_ChoiceListgetChoiceListPtr () const
 
const PRM_TemplategetTemplatePtr () const
 
PRM_TemplategetTemplatePtr ()
 
bool hasChannelAlias (int index) const
 
void getChannelAlias (UT_String &strref, int index) const
 
const UT_StringHoldergetChannelAlias (int index) const
 
bool setChannelAlias (const UT_StringHolder &token_alias, int index)
 
int findSubIndex (const UT_StringRef &thechannelname, bool allow_alias) const
 
PRM_ParmOwnergetParmOwner () const
 
PRM_ParmListgetParmList () const
 
PRM_ParmgetParm () const
 
bool hasChannelName (const UT_StringRef &s, int vi) const
 
bool isActive (const int index) const
 
void setActive (const int index, const bool active)
 
bool isSpareParm () const
 
void setSpareParm (bool spare)
 
const PRM_InstancegetMultiParmOwner () const
 
void setMultiParmOwner (const PRM_Multi *multiparmowner)
 
int getMultiInstanceIndex (UT_IntArray &indices, bool instance_index=true) const
 
bool validIndex (int index) const
 
virtual int64 getMemoryUsage (bool inclusive) const
 
virtual bool isRotationParm () const
 
void validateChannelNames (PRM_ParmList &list)
 
DEP_MicroNodemicroNode (int vi)
 Thread-safe access to get or create a micronode. More...
 
void getMicroNodes (DEP_MicroNodeList &micronodes) const
 Thread-safe access to get micronodes. More...
 
bool hasMicroNodes () const
 Return true if this parameter has micronodes, NOT thread-safe. More...
 
void clearMicroNodeInputs ()
 
void getMicroNodeInputList (DEP_MicroNodeList &inputs) const
 
int getMicroNodeNumInputs () const
 
void getMicroNodeOutputList (DEP_MicroNodeList &outputs) const
 
void propagateDirty (DEP_MicroNode::Visitor client_visit, DEP_MicroNode *parmlist_micronode, bool force, bool *dirtied_data=nullptr)
 
void dumpMicroNodes (std::ostream &os, bool as_DOT, int indent_level) const
 
int64 getMicroNodesMemoryUsage () const
 
bool hasChannelCustomColor (int index) const
 Custom Channel Color. More...
 
const UT_ColorgetChannelCustomColor (int index) const
 
void setChannelCustomColor (int index, const UT_Color &c)
 
void resetChannelCustomColor (int index)
 
bool getAutoSelectFlag (int vec_idx) const
 
void setAutoSelectFlag (int vec_idx, bool f)
 
unsigned int getAutoSelectField () const
 

Static Public Member Functions

static bool isChanRefString (const char *str, bool is_expr, UT_String *chref=0)
 
static bool isObsoleteDirectChanRefString (const char *str, UT_String *chref=0)
 
- Static Public Member Functions inherited from UT_SmallObject< PRM_Instance, UT_SMALLOBJECT_CLEANPAGES_DEFAULT, UT_SMALLOBJECT_PAGESIZE_DEFAULT, UT_SMALLOBJECT_THREADSAFE_OFF >
static voidoperator new (size_t size)
 Regular new/delete operators. More...
 
static void operator delete (void *p, size_t size)
 Regular new/delete operators. More...
 
static voidoperator new (size_t, void *p)
 
static void operator delete (void *, void *)
 

Protected Types

enum  PRM_ParmIOToken {
  PRM_IO_TOKEN_DELIMITER, PRM_IO_TOKEN_BRACKET_SPACE, PRM_IO_TOKEN_OPTS_OPEN, PRM_IO_TOKEN_OPTS_CLOSE,
  PRM_IO_TOKEN_OPTS_LOCKS, PRM_IO_TOKEN_OPTS_AUTOSCOPE, PRM_IO_TOKEN_OPTS_BYPASS, PRM_IO_TOKEN_OPTS_LABEL,
  PRM_IO_TOKEN_OPTS_COLOR, PRM_IO_TOKEN_OPTS_AUTOSELECT, PRM_IO_TOKEN_NUM
}
 

Protected Member Functions

void clearAndDestroyChannels ()
 
void addParmWarning (PRM_ErrorCode code) const
 
void indexError (int index)
 
void setLockField (unsigned int locks)
 
void setAutoScopeField (unsigned int field)
 
void setAutoSelectField (unsigned int field)
 
SYS_FORCE_INLINE void checkForExpressionErrors (const PRM_ParmList *thelist, int vector_index, int thread) const
 
bool validateAccess ()
 
void loadTokenAsChannelNameOrExpression (const UT_String &token, int index)
 
bool loadAsciiOptions (UT_IStream &is, uint &pending_mask)
 
bool loadBinaryOption (UT_IStream &is, short packet_id)
 
void saveAsciiOptions (std::ostream &os) const
 
bool saveBinaryOptions (int class_packet_id, UT_Packet &packet, std::ostream &os) const
 
CH_ExprLanguage stringMeaningToExprLanguage (CH_StringMeaning meaning) const
 

Static Protected Member Functions

static const char * getPacketIOToken (PRM_ParmIOToken token)
 
static int getPacketIOTokenLen (PRM_ParmIOToken token)
 
static int getPacketIOBinaryId (PRM_ParmIOToken token)
 
static bool comparePacketIOToken (PRM_ParmIOToken token, const char *text, int textlen)
 

Detailed Description

Definition at line 71 of file PRM_Instance.h.

Member Enumeration Documentation

Enumerator
PRM_IO_TOKEN_DELIMITER 
PRM_IO_TOKEN_BRACKET_SPACE 
PRM_IO_TOKEN_OPTS_OPEN 
PRM_IO_TOKEN_OPTS_CLOSE 
PRM_IO_TOKEN_OPTS_LOCKS 
PRM_IO_TOKEN_OPTS_AUTOSCOPE 
PRM_IO_TOKEN_OPTS_BYPASS 
PRM_IO_TOKEN_OPTS_LABEL 
PRM_IO_TOKEN_OPTS_COLOR 
PRM_IO_TOKEN_OPTS_AUTOSELECT 
PRM_IO_TOKEN_NUM 

Definition at line 713 of file PRM_Instance.h.

Constructor & Destructor Documentation

PRM_Instance::PRM_Instance ( PRM_Template thetemplateptr,
PRM_Parm parm 
)
PRM_Instance::PRM_Instance ( PRM_Instance thesrcptr,
PRM_Parm parm 
)
virtual PRM_Instance::~PRM_Instance ( )
virtual

Member Function Documentation

void PRM_Instance::addChannel ( int  index)
int PRM_Instance::addChannel ( const UT_StringRef name)
void PRM_Instance::addChannel ( int  index,
const char *  theexpr,
CH_ExprLanguage  language 
)
int PRM_Instance::addChannel ( const UT_StringRef name,
const char *  expr,
CH_ExprLanguage  language 
)
void PRM_Instance::addContextOptionDep ( int  subindex,
const UT_StringHolder opt 
)
void PRM_Instance::addParmWarning ( PRM_ErrorCode  code) const
protected
virtual void PRM_Instance::adopt ( PRM_Instance thesrcinstance)
virtual

Reimplemented in PRM_Data.

virtual void PRM_Instance::adoptOverrides ( PRM_Instance thesrcinstance)
virtual
bool PRM_Instance::areAllComponentsLocked ( ) const
bool PRM_Instance::areAllFlagsClean ( ) const
inline

Definition at line 474 of file PRM_Instance.h.

virtual void PRM_Instance::buildOpDependencies ( const PRM_RefId ref,
int  thread 
)
virtual
virtual void PRM_Instance::changeOpRef ( const char *  new_fullpath,
const char *  old_fullpath,
const char *  old_cwd,
const char *  chan_name,
const char *  old_chan_name,
void(*)(void *)  undo_callback,
void undo_data,
int  thread 
)
virtual
int PRM_Instance::changePending ( int  index)
virtual int PRM_Instance::changeString ( const char *  from,
const char *  to,
bool  fullword 
)
virtual
int PRM_Instance::channelPtrModified ( const UT_StringRef name)
SYS_FORCE_INLINE void PRM_Instance::checkForExpressionErrors ( const PRM_ParmList thelist,
int  vector_index,
int  thread 
) const
inlineprotected

Definition at line 672 of file PRM_Instance.h.

void PRM_Instance::clearAllDirtyFlags ( )
inline

Definition at line 476 of file PRM_Instance.h.

void PRM_Instance::clearAndDestroyChannels ( )
protected
void PRM_Instance::clearMicroNodeInputs ( )
static bool PRM_Instance::comparePacketIOToken ( PRM_ParmIOToken  token,
const char *  text,
int  textlen 
)
staticprotected
void PRM_Instance::createInputNotifyValue ( )
virtual void PRM_Instance::destroyChildParms ( )
inlinevirtual

Definition at line 469 of file PRM_Instance.h.

void PRM_Instance::dumpMicroNodes ( std::ostream &  os,
bool  as_DOT,
int  indent_level 
) const
virtual PRM_Instance* PRM_Instance::duplicateSelf ( PRM_Parm node)
pure virtual

Implemented in PRM_Data.

fpreal PRM_Instance::findNextKey ( fpreal  theoldtime,
int  index = -1 
)
fpreal PRM_Instance::findPrevKey ( fpreal  theoldtime,
int  index = -1 
)
virtual int PRM_Instance::findString ( const char *  str,
bool  fullword,
bool  usewildcards 
) const
virtual
int PRM_Instance::findSubIndex ( const UT_StringRef thechannelname,
bool  allow_alias 
) const
inline

Definition at line 846 of file PRM_Instance.h.

bool PRM_Instance::getActiveTakeFlag ( ) const
inline

Definition at line 389 of file PRM_Instance.h.

bool PRM_Instance::getAlwaysTakeFlag ( ) const
inline

Definition at line 391 of file PRM_Instance.h.

bool PRM_Instance::getAutoScopedFlag ( int  vec_idx) const
unsigned int PRM_Instance::getAutoScopeField ( ) const
inline

Definition at line 453 of file PRM_Instance.h.

unsigned int PRM_Instance::getAutoSelectField ( ) const
inline

Definition at line 648 of file PRM_Instance.h.

bool PRM_Instance::getAutoSelectFlag ( int  vec_idx) const
bool PRM_Instance::getAutoTakeUndoSavedFlag ( )
inline

Definition at line 423 of file PRM_Instance.h.

bool PRM_Instance::getBypassFlag ( ) const
inline

Definition at line 404 of file PRM_Instance.h.

PRM_Callback PRM_Instance::getCallback ( ) const
inline

Definition at line 527 of file PRM_Instance.h.

CH_Channel* PRM_Instance::getChannel ( int  subindex) const
inline

Definition at line 321 of file PRM_Instance.h.

void PRM_Instance::getChannelAlias ( UT_String strref,
int  index 
) const
const UT_StringHolder& PRM_Instance::getChannelAlias ( int  index) const
int PRM_Instance::getChannelCount ( ) const
const UT_Color& PRM_Instance::getChannelCustomColor ( int  index) const
CH_Collection* PRM_Instance::getChannelGroupPtr ( ) const
inline

Definition at line 299 of file PRM_Instance.h.

void PRM_Instance::getChannelToken ( UT_String chname,
int  i 
) const
inline

Definition at line 533 of file PRM_Instance.h.

const UT_StringHolder& PRM_Instance::getChannelToken ( int  i) const
inline

Definition at line 535 of file PRM_Instance.h.

virtual PRM_ChanState PRM_Instance::getChanState ( fpreal  time,
int  index 
) const
virtual
virtual PRM_ChanState PRM_Instance::getChanState ( fpreal  time) const
virtual
const PRM_ChoiceList* PRM_Instance::getChoiceListPtr ( ) const
inline

Definition at line 537 of file PRM_Instance.h.

const DEP_ContextOptionDeps& PRM_Instance::getContextOptionDeps ( int  subindex) const
bool PRM_Instance::getDefaultsInitFlag ( ) const
inline

Definition at line 445 of file PRM_Instance.h.

virtual void PRM_Instance::getDefaultValue ( fpreal value,
int  index 
) const
virtual
virtual void PRM_Instance::getDefaultValue ( int32 value,
int  index 
) const
virtual
virtual void PRM_Instance::getDefaultValue ( int64 value,
int  index 
) const
virtual
virtual void PRM_Instance::getDefaultValue ( UT_String value,
int  index 
) const
virtual
unsigned PRM_Instance::getEnableState ( int  comp = -1) const
inline

Definition at line 872 of file PRM_Instance.h.

fpreal PRM_Instance::getEvalTime ( int  thread) const
inline

Definition at line 305 of file PRM_Instance.h.

virtual void PRM_Instance::getExpression ( fpreal  time,
UT_String value,
int  index,
bool  allow_value,
int  thread 
) const
pure virtual

Implemented in PRM_Data.

int PRM_Instance::getExpressionState ( ) const
inline

Definition at line 271 of file PRM_Instance.h.

virtual void PRM_Instance::getExpressionStringForUI ( fpreal  time,
UT_String value,
int  index,
int  thread 
) const
pure virtual

Implemented in PRM_Data.

CH_ExprLanguage PRM_Instance::getExprLanguageIfMadeAnExpression ( fpreal  time,
int  index 
) const
fpreal PRM_Instance::getGlobalStartTime ( ) const
inline

Definition at line 313 of file PRM_Instance.h.

virtual int PRM_Instance::getIsOverrideActive ( int  index) const
virtual

Sometimes we may want to make an existing and enabled override temporarily inactive, so that we can "shut off" the override without losing any dependencies between the parm and the source of its exported override values. (e.g. might want to temporarily change the parm's display colour)

const char* PRM_Instance::getLabel ( ) const
inline

Definition at line 525 of file PRM_Instance.h.

bool PRM_Instance::getLockedFlag ( int  vec_idx) const
unsigned int PRM_Instance::getLockField ( ) const
inline

Definition at line 451 of file PRM_Instance.h.

virtual bool PRM_Instance::getMagicString ( UT_TokenString magic,
PRM_ParmList list,
int  size,
fpreal  t,
bool  add_if_default,
int  thread 
)
pure virtual

Implemented in PRM_Data.

virtual int64 PRM_Instance::getMemoryUsage ( bool  inclusive) const
virtual

Reimplemented in PRM_Data.

void PRM_Instance::getMicroNodeInputList ( DEP_MicroNodeList inputs) const
int PRM_Instance::getMicroNodeNumInputs ( ) const
void PRM_Instance::getMicroNodeOutputList ( DEP_MicroNodeList outputs) const
void PRM_Instance::getMicroNodes ( DEP_MicroNodeList micronodes) const

Thread-safe access to get micronodes.

int64 PRM_Instance::getMicroNodesMemoryUsage ( ) const
int PRM_Instance::getMultiInstanceIndex ( UT_IntArray indices,
bool  instance_index = true 
) const

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

Parameters
indicesThe list of index instances.
instance_indexEach multi-parm can have multiple parameters in each instance. If instance_index is true, the instance number will be returned. Otherwise the raw offset into the multi-parm will be extracted.
virtual int PRM_Instance::getMultiParmInstancesPerItem ( ) const
virtual
virtual int PRM_Instance::getMultiParmNumItems ( ) const
virtual
const PRM_Instance* PRM_Instance::getMultiParmOwner ( ) const
const PRM_Template* PRM_Instance::getMultiParmTemplate ( ) const
inline

Definition at line 519 of file PRM_Instance.h.

PRM_Template* PRM_Instance::getMultiParmTemplate ( )
inline

Definition at line 521 of file PRM_Instance.h.

virtual const char* PRM_Instance::getMultiParmToken ( int  p,
int  index 
) const
virtual
fpreal PRM_Instance::getMultiSize ( ) const
inline

Definition at line 515 of file PRM_Instance.h.

int PRM_Instance::getMultiStartOffset ( ) const
inline

Definition at line 517 of file PRM_Instance.h.

PRM_MultiType PRM_Instance::getMultiType ( ) const
inline

Definition at line 513 of file PRM_Instance.h.

virtual const char* PRM_Instance::getOverride ( int  index) const
virtual
virtual int PRM_Instance::getOverrideDataIndex ( int  index) const
virtual
virtual bool PRM_Instance::getOverrideType ( int  index,
PRM_OverrideType type 
) const
virtual
static int PRM_Instance::getPacketIOBinaryId ( PRM_ParmIOToken  token)
staticprotected
static const char* PRM_Instance::getPacketIOToken ( PRM_ParmIOToken  token)
staticprotected
static int PRM_Instance::getPacketIOTokenLen ( PRM_ParmIOToken  token)
staticprotected
PRM_Parm* PRM_Instance::getParm ( ) const
inline

Definition at line 563 of file PRM_Instance.h.

PRM_ParmList* PRM_Instance::getParmList ( ) const
inline

Definition at line 561 of file PRM_Instance.h.

PRM_ParmOwner* PRM_Instance::getParmOwner ( ) const
inline

Definition at line 559 of file PRM_Instance.h.

const PRM_Range* PRM_Instance::getRangePtr ( ) const
inline

Definition at line 531 of file PRM_Instance.h.

bool PRM_Instance::getSaveAutoScopeFlag ( ) const
inline

Definition at line 429 of file PRM_Instance.h.

bool PRM_Instance::getSaveAutoSelectFlag ( ) const
inline

Definition at line 432 of file PRM_Instance.h.

unsigned int PRM_Instance::getSaveFlags ( ) const
inline

Definition at line 384 of file PRM_Instance.h.

bool PRM_Instance::getSaveLabelFlag ( ) const
inline

Definition at line 436 of file PRM_Instance.h.

CH_StringMeaning PRM_Instance::getStringMeaning ( fpreal  time,
int  index 
) const
const PRM_Template* PRM_Instance::getTemplatePtr ( ) const
inline

Definition at line 540 of file PRM_Instance.h.

PRM_Template* PRM_Instance::getTemplatePtr ( )
inline

Definition at line 541 of file PRM_Instance.h.

const char* PRM_Instance::getToken ( ) const
inline

Definition at line 523 of file PRM_Instance.h.

const PRM_Type& PRM_Instance::getType ( void  ) const
inline

Definition at line 509 of file PRM_Instance.h.

PRM_TypeExtended PRM_Instance::getTypeExtended ( ) const
inline

Definition at line 511 of file PRM_Instance.h.

bool PRM_Instance::getUndoSavedFlag ( )
inline

Definition at line 418 of file PRM_Instance.h.

virtual void PRM_Instance::getValue ( PRM_ParmList parm_list,
fpreal  time,
int32 value,
int  index,
int  thread 
) const
pure virtual

Implemented in PRM_Data.

virtual void PRM_Instance::getValue ( PRM_ParmList parm_list,
fpreal  time,
int64 value,
int  index,
int  thread 
) const
pure virtual

Implemented in PRM_Data.

virtual void PRM_Instance::getValue ( PRM_ParmList parm_list,
fpreal  time,
fpreal value,
int  index,
int  thread 
) const
pure virtual

Implemented in PRM_Data.

virtual void PRM_Instance::getValue ( PRM_ParmList parm_list,
fpreal  time,
UT_String value,
int  index,
bool  expand,
int  thread 
) const
pure virtual

Implemented in PRM_Data.

virtual void PRM_Instance::getValue ( PRM_ParmList parm_list,
fpreal  time,
PRM_DataItemHandle value,
int  index,
int  thread 
) const
pure virtual

Implemented in PRM_Data.

virtual void PRM_Instance::getValue ( PRM_ParmList parm_list,
fpreal  time,
UT_JSONValueMap value,
int  index,
bool  expand,
int  thread 
) const
pure virtual

Implemented in PRM_Data.

virtual void PRM_Instance::getValues ( PRM_ParmList parm_list,
fpreal  time,
fpreal32 value,
int  thread 
) const
virtual
virtual void PRM_Instance::getValues ( PRM_ParmList parm_list,
fpreal  time,
fpreal64 value,
int  thread 
) const
virtual
virtual void PRM_Instance::getValues ( PRM_ParmList parm_list,
fpreal  time,
int32 theints,
int  thread 
) const
virtual
virtual void PRM_Instance::getValues ( PRM_ParmList parm_list,
fpreal  time,
int64 theints,
int  thread 
) const
virtual
int PRM_Instance::getValueState ( ) const
inline

Definition at line 282 of file PRM_Instance.h.

int PRM_Instance::getVectorSize ( ) const
inline

Definition at line 529 of file PRM_Instance.h.

bool PRM_Instance::getVisibleState ( int  comp = -1) const
inline

Definition at line 881 of file PRM_Instance.h.

virtual void PRM_Instance::hardenChanges ( fpreal  time,
int  index,
bool  theforceflag,
const char *  patt = 0,
CH_ChannelRefList list = 0 
)
pure virtual

Implemented in PRM_Data.

bool PRM_Instance::hasAnySendExtraFlags ( ) const
inline

Definition at line 488 of file PRM_Instance.h.

bool PRM_Instance::hasChannelAlias ( int  index) const
bool PRM_Instance::hasChannelCustomColor ( int  index) const

Custom Channel Color.

bool PRM_Instance::hasChannelName ( const UT_StringRef s,
int  vi 
) const
bool PRM_Instance::hasContextOptionDeps ( int  subindex) const
bool PRM_Instance::hasMicroNodes ( ) const
inline

Return true if this parameter has micronodes, NOT thread-safe.

Definition at line 621 of file PRM_Instance.h.

void PRM_Instance::indexError ( int  index)
protected
PRM_Value* PRM_Instance::inputNotifyValue ( )
inline

Definition at line 506 of file PRM_Instance.h.

const PRM_Value* PRM_Instance::inputNotifyValue ( ) const
inline

Definition at line 507 of file PRM_Instance.h.

virtual void PRM_Instance::insertMultiParmItem ( int  index)
virtual
void PRM_Instance::internalAddChannel ( int  index,
const char *  theexpr,
CH_ExprLanguage  language,
bool  add_seg = true 
)
bool PRM_Instance::isActive ( const int  index) const
bool PRM_Instance::isAllDefault ( enum PRM_DefaultType  deftype) const
static bool PRM_Instance::isChanRefString ( const char *  str,
bool  is_expr,
UT_String chref = 0 
)
static
virtual bool PRM_Instance::isDataDependent ( fpreal  gtime,
int  subindex 
) const
virtual
virtual int PRM_Instance::isDefault ( int  index,
enum PRM_DefaultType  deftype,
bool  basiccheck = true 
) const
virtual

Reimplemented in PRM_Data.

bool PRM_Instance::isDirty ( int  vec_idx) const
inline

Definition at line 472 of file PRM_Instance.h.

virtual bool PRM_Instance::isEditable ( PRM_ParmList thelist,
fpreal  time,
int  index 
) const
inlinevirtual

Definition at line 294 of file PRM_Instance.h.

virtual bool PRM_Instance::isEditableByUI ( PRM_ParmList thelist,
fpreal  time,
int  index 
) const
inlinevirtual

Definition at line 296 of file PRM_Instance.h.

virtual bool PRM_Instance::isMultiParm ( ) const
virtual
static bool PRM_Instance::isObsoleteDirectChanRefString ( const char *  str,
UT_String chref = 0 
)
static
virtual bool PRM_Instance::isRotationParm ( ) const
inlinevirtual

Definition at line 607 of file PRM_Instance.h.

bool PRM_Instance::isSendExtra ( int  vi) const
inline

Definition at line 486 of file PRM_Instance.h.

bool PRM_Instance::isSpareParm ( ) const
virtual bool PRM_Instance::isTimeDependent ( int  subindex) const
virtual
bool PRM_Instance::languageIsNodesLanguage ( fpreal  time,
int  index 
) const
virtual bool PRM_Instance::load ( UT_IStream is)
pure virtual

Implemented in PRM_Data.

bool PRM_Instance::loadAsciiOptions ( UT_IStream is,
uint pending_mask 
)
protected
bool PRM_Instance::loadBinaryOption ( UT_IStream is,
short  packet_id 
)
protected
virtual int PRM_Instance::loadCommand ( int  argc,
const char *const  argv[],
int  index,
bool  values_only,
PRM_AddKeyType  add_key,
PRM_KeySetType  set_type 
)
pure virtual

Implemented in PRM_Data.

void PRM_Instance::loadTokenAsChannelNameOrExpression ( const UT_String token,
int  index 
)
protected
virtual bool PRM_Instance::loadUndoData ( const PRM_UndoDataHandle data)
virtual

Reimplemented in PRM_Data.

DEP_MicroNode& PRM_Instance::microNode ( int  vi)

Thread-safe access to get or create a micronode.

virtual bool PRM_Instance::notifyVarChange ( int  subindex,
const char *  varname 
)
virtual
virtual void PRM_Instance::overwriteDefault ( fpreal  time,
int  index 
)
pure virtual

Implemented in PRM_Data.

virtual void PRM_Instance::overwriteDefaults ( fpreal  time)
pure virtual

Implemented in PRM_Data.

void PRM_Instance::propagateDirty ( DEP_MicroNode::Visitor  client_visit,
DEP_MicroNode parmlist_micronode,
bool  force,
bool *  dirtied_data = nullptr 
)
void PRM_Instance::reloadChannelPtrs ( )
bool PRM_Instance::removeChannel ( int  index)
virtual void PRM_Instance::removeMultiParmItem ( int  index)
virtual
void PRM_Instance::resetChannelCustomColor ( int  index)
virtual void PRM_Instance::restoreFactoryDefault ( int  index)
pure virtual

Implemented in PRM_Data.

virtual void PRM_Instance::revertToDefault ( int  index)
pure virtual

Implemented in PRM_Data.

virtual void PRM_Instance::revertToDefaults ( bool  clear_channels = true)
pure virtual

Implemented in PRM_Data.

virtual void PRM_Instance::save ( std::ostream &  os,
int  binary,
bool  compiled 
) const
pure virtual

Implemented in PRM_Data.

void PRM_Instance::saveAsciiOptions ( std::ostream &  os) const
protected
bool PRM_Instance::saveBinaryOptions ( int  class_packet_id,
UT_Packet packet,
std::ostream &  os 
) const
protected
virtual void PRM_Instance::saveCommand ( std::ostream &  os,
int  values = 0,
int  index = -1 
) const
pure virtual

Implemented in PRM_Data.

virtual void PRM_Instance::saveUndoData ( PRM_UndoDataHandle data) const
virtual

Reimplemented in PRM_Data.

void PRM_Instance::setActive ( const int  index,
const bool  active 
)
void PRM_Instance::setActiveTakeFlag ( int  onoff)
inline

Definition at line 393 of file PRM_Instance.h.

void PRM_Instance::setAutoScopedFlag ( int  vec_idx,
bool  f 
)
void PRM_Instance::setAutoScopeField ( unsigned int  field)
inlineprotected

Definition at line 659 of file PRM_Instance.h.

void PRM_Instance::setAutoSelectField ( unsigned int  field)
inlineprotected

Definition at line 665 of file PRM_Instance.h.

void PRM_Instance::setAutoSelectFlag ( int  vec_idx,
bool  f 
)
void PRM_Instance::setAutoTakeUndoSavedFlag ( bool  f)
inline

Definition at line 425 of file PRM_Instance.h.

void PRM_Instance::setBypassFlag ( bool  onoff)
inline

Definition at line 406 of file PRM_Instance.h.

void PRM_Instance::setChannel ( int  subindex,
CH_Channel chp 
)
inline

Definition at line 327 of file PRM_Instance.h.

bool PRM_Instance::setChannelAlias ( const UT_StringHolder token_alias,
int  index 
)
void PRM_Instance::setChannelCustomColor ( int  index,
const UT_Color c 
)
virtual void PRM_Instance::setDefaultChannelValue ( CH_Channel channelptr,
int  index = 0 
)
pure virtual

Implemented in PRM_Data.

void PRM_Instance::setDefaultsInitFlag ( bool  f)
inline

Definition at line 447 of file PRM_Instance.h.

void PRM_Instance::setDirtyFlags ( int  vec_idx)
inline

Definition at line 478 of file PRM_Instance.h.

bool PRM_Instance::setEnableState ( bool  f,
int  comp = -1 
)
virtual void PRM_Instance::setExpression ( fpreal  time,
const char *  value,
CH_ExprLanguage  language,
int  index,
bool  evaluate = true,
bool  rmchannel = false 
)
virtual

Reimplemented in PRM_Data.

void PRM_Instance::setExpressionState ( int  state)
inline

Definition at line 275 of file PRM_Instance.h.

void PRM_Instance::setFullKey ( fpreal  gtime,
int  index,
CH_FullKey const key,
bool  accel_ratios = true 
)
void PRM_Instance::setKey ( fpreal  time,
int  index 
)
void PRM_Instance::setKey ( fpreal  time,
int  index,
const char *  expr,
CH_ExprLanguage  language,
const char *  patt = 0,
CH_ChannelRefList list = 0 
)
void PRM_Instance::setLockedFlag ( int  vec_idx,
bool  f 
)
void PRM_Instance::setLockField ( unsigned int  locks)
inlineprotected

Definition at line 657 of file PRM_Instance.h.

void PRM_Instance::setMultiParmOwner ( const PRM_Multi *  multiparmowner)
virtual int PRM_Instance::setOverride ( int  index,
int  data_idx,
const char *  source,
PRM_OverrideType  type 
)
virtual
virtual int PRM_Instance::setOverrideDisable ( int  index,
int  onoff 
)
virtual
void PRM_Instance::setSaveFlags ( unsigned int  f)
inline

Definition at line 386 of file PRM_Instance.h.

void PRM_Instance::setSaveLabelFlag ( bool  f)
void PRM_Instance::setSendExtra ( int  vi)
inline

Definition at line 490 of file PRM_Instance.h.

void PRM_Instance::setSpareParm ( bool  spare)
virtual void PRM_Instance::setTimeDependent ( int  subindex,
bool  timedep 
)
virtual
void PRM_Instance::setTimeDependentForEval ( int  vi,
bool  timedep 
) const
inline

Definition at line 354 of file PRM_Instance.h.

void PRM_Instance::setUndoSavedFlag ( bool  f)
inline

Definition at line 420 of file PRM_Instance.h.

virtual void PRM_Instance::setValue ( fpreal  time,
const char *  value,
CH_StringMeaning  meaning,
bool  kill_expr = false,
int  index = 0,
PRM_AddKeyType  add_key = PRM_AK_MARK_PENDING,
PRM_KeySetType  setkey = PRM_USE_PREFERENCES 
)
virtual

Reimplemented in PRM_Data.

virtual void PRM_Instance::setValue ( fpreal  time,
fpreal  value,
bool  kill_expr = false,
const int  index = 0,
PRM_AddKeyType  add_key = PRM_AK_MARK_PENDING,
PRM_KeySetType  setkey = PRM_USE_PREFERENCES 
)
virtual

Reimplemented in PRM_Data.

virtual void PRM_Instance::setValue ( fpreal  time,
int32  value,
bool  kill_expr = false,
const int  index = 0,
PRM_AddKeyType  add_key = PRM_AK_MARK_PENDING,
PRM_KeySetType  setkey = PRM_USE_PREFERENCES 
)
virtual

Reimplemented in PRM_Data.

virtual void PRM_Instance::setValue ( fpreal  time,
int64  value,
bool  kill_expr = false,
const int  index = 0,
PRM_AddKeyType  add_key = PRM_AK_MARK_PENDING,
PRM_KeySetType  setkey = PRM_USE_PREFERENCES 
)
virtual

Reimplemented in PRM_Data.

virtual void PRM_Instance::setValue ( fpreal  time,
const PRM_DataItemHandle value,
bool  kill_expr = false,
const int  index = 0,
PRM_AddKeyType  add_key = PRM_AK_MARK_PENDING,
PRM_KeySetType  setkey = PRM_USE_PREFERENCES 
)
virtual

Reimplemented in PRM_Data.

virtual void PRM_Instance::setValues ( fpreal  time,
const fpreal values,
bool  kill_expr = false,
PRM_AddKeyType  add_key = PRM_AK_MARK_PENDING,
PRM_KeySetType  setkey = PRM_USE_PREFERENCES 
)
virtual
virtual void PRM_Instance::setValues ( fpreal  time,
const int32 values,
bool  kill_expr = false,
PRM_AddKeyType  add_key = PRM_AK_MARK_PENDING,
PRM_KeySetType  setkey = PRM_USE_PREFERENCES 
)
virtual
virtual void PRM_Instance::setValues ( fpreal  time,
const int64 values,
bool  kill_expr = false,
PRM_AddKeyType  add_key = PRM_AK_MARK_PENDING,
PRM_KeySetType  setkey = PRM_USE_PREFERENCES 
)
virtual
void PRM_Instance::setValueState ( int  state)
inline

Definition at line 286 of file PRM_Instance.h.

virtual void PRM_Instance::setValueToDefault ( fpreal  time,
int  index,
PRM_AddKeyType  add_key 
)
pure virtual

Implemented in PRM_Data.

void PRM_Instance::setVisibleState ( bool  f,
int  comp = -1 
)
inline

Definition at line 896 of file PRM_Instance.h.

CH_ExprLanguage PRM_Instance::stringMeaningToExprLanguage ( CH_StringMeaning  meaning) const
protected
bool PRM_Instance::validateAccess ( )
protected
void PRM_Instance::validateChannelNames ( PRM_ParmList list)

During loading we need to validate that the channels tied to the parameter indices are correclty mapped.

bool PRM_Instance::validIndex ( int  index) const

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