81 virtual const char *getDataTypeToken()
const = 0;
82 virtual bool saveAscii(std::ostream &os)
const = 0;
83 virtual bool saveBinary(std::ostream &os)
const = 0;
84 virtual int64 getMemoryUsage()
const = 0;
96 virtual const char *getDataTypeToken()
const = 0;
116 virtual const char *getDataType()
const = 0;
117 virtual int64 getMemoryUsage()
const = 0;
124 UT_SMALLOBJECT_CLEANPAGES_DEFAULT,
125 UT_SMALLOBJECT_PAGESIZE_DEFAULT,
126 UT_SMALLOBJECT_THREADSAFE_OFF>
138 void adoptOverrides(
PRM_Parm &srcparm);
141 void revertToDefault(
fpreal time,
int index,
bool propagate=
true);
142 void restoreFactoryDefaults();
143 void restoreFactoryDefault(
int index);
146 {
return myDestructiveRevertToDefaultFlag; }
148 { myDestructiveRevertToDefaultFlag =
v; }
151 {
return myRevertInvisibleToDefaultsFlag; }
153 { myRevertInvisibleToDefaultsFlag =
v; }
156 {
return myMakeSpareParmsForUnknownChannelsFlag; }
158 { myMakeSpareParmsForUnknownChannelsFlag =
v; }
161 static bool isStringThatCanExpand(
const char *str);
162 static bool isOrdinalExpression(
const char *str,
164 static bool isOrdinalExpression(
const PRM_Default &dflt,
169 static void convertStringToExprLanguage(
const char *str,
172 static void convertStringFromExprLanguage(
const char *str,
176 static bool getIsAddingOrRemovingMultiParms();
179 static void instanceMultiString(
UT_String &token,
181 bool fill_remaining=
true);
182 static void instanceMultiString(
UT_String &token,
183 const int *indexlist,
int num,
184 bool fill_remaining=
true);
189 int isDefault()
const;
190 int isDefault(
int index)
const;
191 int isFactoryDefault()
const;
192 int isFactoryDefault(
int index)
const;
198 int isTrueFactoryDefault(
int index)
const;
199 int isTrueFactoryDefault()
const;
204 int isFactoryDefaultUI(
int index)
const;
205 int isFactoryDefaultUI()
const;
207 void overwriteDefaults(
fpreal time);
208 void overwriteDefault(
fpreal time,
int index);
211 void changeOpRef(
const char *new_fullpath,
const char *old_fullpath,
212 const char *old_cwd,
const char *chan_name,
213 const char *old_chan_name,
214 void (*undo_callback)(
void *),
void *undo_data,
224 bool expand,
int thread)
const;
226 bool expand,
int thread)
const;
233 bool expand,
int thread)
const;
239 void getDefaultValue(
fpreal &
value,
int index)
const;
246 int index,
int thread)
const;
251 int index,
int thread)
const;
253 int index,
int thread)
const;
258 int index,
int thread)
const;
262 int index,
bool evaluate =
true,
263 bool rmchannel =
false,
bool propagate =
true);
273 bool kill_expr =
false,
int index = 0,
275 bool propagate =
true);
278 bool kill_expr =
false,
int index = 0,
280 bool propagate =
true);
283 bool kill_expr =
false,
int index = 0,
285 bool propagate =
true);
288 bool kill_expr =
false,
int index = 0,
290 bool propagate =
true);
293 bool kill_expr =
false,
int index = 0,
295 bool propagate =
true);
303 bool kill_expr =
false,
305 bool propagate =
true);
307 bool kill_expr =
false,
309 bool propagate =
true);
311 bool kill_expr =
false,
313 bool propagate =
true);
316 bool kill_expr =
false,
318 bool propagate =
true);
325 bool isMultiParm()
const;
332 void insertMultiParmItem(
int index,
bool propagate = 1);
335 void removeMultiParmItem(
int index,
bool propagate = 1);
338 void revertMultiParmItem(
int index);
342 void revertAllMultiParmItems();
346 void assignMultiParmItem(
int from,
int to);
350 void swapMultiParmItem(
int from,
int to);
355 void moveMultiParmItems(
356 const UT_Array<std::pair<int,int>> &moves);
359 int getMultiParmNumItems()
const;
365 int getMultiParmInstancesPerItem()
const;
369 const char* getMultiParmToken(
int p,
int index)
const;
374 int getMultiParmUIEntries()
const;
377 const PRM_Template *getMultiParmTemplate(
int idx)
const;
382 PRM_Parm *getMultiParm(
int idx)
const;
383 int getMultiParmCount()
const;
391 { privateValueChanged(vec_idx, propagate,
393 void sendValueChanged(
int vec_idx,
bool propagate);
394 void indirectChange(
int vec_idx,
bool expr_changed,
395 bool update_multi =
true);
398 int setOverride(
int index,
int data_idx,
const char *
source,
400 const char *getOverride(
int index)
const;
401 int getOverrideDataIndex(
int index)
const;
403 bool getOverrideTrackName(
int index,
UT_String &trackname)
const;
405 int setOverrideDisable(
int index,
int onoff);
406 int getIsOverrideActive(
int index)
const;
418 void copyValue(
fpreal t,
int dest_vi,
419 const PRM_Parm &src_parm,
int src_vi,
421 bool current_value_only,
422 bool set_value_to_default =
false,
427 void addChannel(
int index,
bool propagate =
true);
428 void addChannel(
int index,
const char *theexpr,
430 int addChannel(
const char *
name);
431 int addChannel(
const char *
name,
const char *expr,
434 void clearAndDestroyChannels(
bool force =
false);
435 void removeChannel(
int index,
bool propagage =
true);
439 void clearAndDestroyUnrefChannels(
const PRM_Parm &repl_parm);
442 int getChannelCount()
const;
444 void reloadChannelPtrs();
445 int channelPtrModified(
const char *
name);
447 int isTimeDependent()
const;
448 bool isTimeDependent(
int subindex)
const;
449 int isDataDependent(
fpreal gtime)
const;
450 bool isDataDependent(
fpreal gtime,
int subindex)
const;
451 void forceTimeDependent(
int subindex);
453 bool hasContextOptionDeps(
int subindex)
const;
455 void forceContextOptionDep(
int subindex,
461 fpreal getMultiSize()
const;
462 int getMultiStartOffset()
const;
464 bool isRampType()
const;
465 bool isRampTypeColor()
const;
468 {
return getTemplatePtr()->getVectorSize(); }
469 void getChannelToken(
UT_String &thestrref,
int index = 0)
const;
470 void getChannelLabel(
UT_String &thestrref,
int index = 0)
const;
471 void getToken(
UT_String &thestrref)
const;
472 void getLabel(
UT_String &thestrref)
const;
473 void getHelpText(
UT_String &helptext)
const;
474 void getHelpUrl(
UT_String &helptext)
const;
475 void getHelpTitle(
UT_String &helptext)
const;
477 const char *getToken()
const;
478 const char *getLabel()
const;
482 {
return getTemplatePtr()->getTokenRef(); }
486 {
return getTemplatePtr()->getChannelToken(vi); }
490 {
return getTemplatePtr()->getDecodedChannelToken(vi); }
492 void getChannelLabelForUI(
UT_String &thestrref,
int vec_idx)
const;
496 unsigned getTokenHash()
const;
498 bool hasChannelAlias(
int subindex)
const ;
499 void getChannelAlias(
UT_String &stringref,
int subindex)
const;
501 getChannelAlias(
int subindex)
const;
509 bool setChannelAlias(
const char *token_alias,
int subindex);
517 void createInputNotifyValue();
520 bool hasMicroNodes()
const;
523 int isDirty(
int vector_idx=0)
const;
524 int areAllFlagsClean()
const;
525 void clearAllDirtyFlags();
529 bool isSendExtra(
int vi)
const;
530 bool hasAnySendExtraFlags()
const;
532 int findSubIndex(
const char *thechannelname,
bool allow_alias)
const;
542 unsigned getEnableState(
int comp = -1)
const;
543 unsigned getInstanceEnableState(
int comp = -1)
const;
544 int setEnableState(
int thestate,
int comp = -1);
546 bool getActiveTakeFlag()
const;
547 bool getAlwaysTakeFlag()
const;
548 void setActiveTakeFlag(
int onoff);
549 bool getBypassFlag()
const;
550 void setBypassFlag(
bool v);
552 bool getVisibleState(
int comp = -1)
const;
553 bool setVisibleState(
bool f,
int comp = -1);
555 int getExpressionState();
556 void setExpressionState(
int state);
558 void setValueState(
int state);
563 bool isValueEditableByUI(
fpreal time,
int index)
const;
568 bool isExpressionEditableByUI(
fpreal time,
int index)
const;
571 void hardenChanges(
fpreal time,
bool forceflag = 0,
572 const char *patt = 0,
574 void hardenChanges(
fpreal time,
int index,
bool forceflag = 0,
575 const char *patt = 0,
578 void setKey(
fpreal time,
int index);
579 void setKey(
fpreal time,
int index,
const char *
exp,
584 bool accel_ratios =
true);
596 bool isLanguageOldExprOrLiteral(
fpreal time,
int index);
598 int changePending(
int index);
602 void save(std::ostream &os,
int binary,
bool compiled)
const;
608 void saveCommand(std::ostream &os,
int values=0,
int index=-1)
const;
609 int loadCommand(
int argc,
const char *
const argv[],
int index,
615 int findString(
const char *str,
bool fullword,
616 bool usewildcards)
const;
617 int changeString(
const char *from,
const char *to,
bool fullword);
619 bool notifyVarChange(
const char *varname);
621 bool getUndoSavedFlag();
625 void setUndoSavedFlag(
bool f);
627 bool getAutoTakeUndoSavedFlag();
631 void setAutoTakeUndoSavedFlag(
bool f);
633 bool getLockedFlag(
int vec_idx)
const;
634 bool areAllComponentsLocked()
const;
635 void setLockedFlag(
int vec_idx,
bool f);
636 unsigned int getLockedField()
const;
637 bool getAutoScopedFlag(
int vec_idx)
const;
638 void setAutoScopedFlag(
int vec_idx,
bool f);
639 unsigned int getAutoScopedField()
const;
643 int parm_group_mask ,
644 bool add_if_default ,
648 void destroyChildParms();
658 bool isCompatible(
const PRM_Parm &other_parm)
const;
662 bool isOfBasicType(
PRM_Type check_type)
const;
667 bool isParmValueEqual(
PRM_Parm &other_parm,
int vec_index,
669 bool isParmValueEqual(
int vec_index,
PRM_Parm &other_parm,
670 int other_index,
fpreal time,
678 int vec_index)
const;
682 void getAllChannelAliases(
UT_String &aliasstring,
683 char sep =
'/')
const;
686 bool isActive(
const int index)
const;
687 void setActive(
const int index,
const bool active);
689 int64 getMemoryUsage(
bool inclusive)
const;
691 bool isSpareParm()
const;
692 void setSpareParm(
bool sp)
const;
695 void setMultiParmOwner(
const PRM_Multi *multiparmowner);
713 bool instance_index=
true)
const;
715 void rebuildParmDependency();
717 bool isRotationParm()
const;
721 void setChannelReference(
fpreal time,
724 const char *ch_name=
nullptr,
726 bool rmchannel=
false);
733 void constructChannelReference(
UT_String &reference,
736 const char *ch_name=
nullptr);
738 static bool isChanRefString(
const char *str,
bool is_expr,
741 bool getHaveCompiledExpressions()
const;
746 void setSaveLabelFlag(
bool f);
749 bool hasChannelCustomColor(
int index)
const;
750 const UT_Color &getChannelCustomColor(
int index)
const;
751 void setChannelCustomColor(
int index,
const UT_Color &c);
752 void resetChannelCustomColor(
int index);
754 bool getAutoSelectFlag(
int vec_idx)
const;
755 void setAutoSelectFlag(
int vec_idx,
bool f);
756 unsigned int getAutoSelectField()
const;
758 void setTimeDependentMicroNode(
int subindex,
bool timedep)
const;
760 void privateValueChanged(
765 template <
typename DstT,
typename SrcT>
779 static bool myAlwaysHardenFlag;
780 static bool myDestructiveRevertToDefaultFlag;
781 static bool myRevertInvisibleToDefaultsFlag;
782 static bool myMakeSpareParmsForUnknownChannelsFlag;
GLsizei GLenum const void * indices
UT_JSONValueMap stores a map/dictionary of UT_JSONValue objects.
const UT_StringRef & getTokenRef() const
static bool getDestructiveRevertToDefaultFlag()
GT_API const UT_StringHolder time
static bool getMakeSpareParmsForUnknownChannelsFlag()
PRM_API size_t format(char *buffer, size_t buffer_size, const PRM_Parm &v)
UT_SharedPtr< PRM_UndoData > PRM_UndoDataHandle
int getVectorSize() const
const GLuint GLenum const void * binary
UT_ConcurrentSet< UT_StringHolder > DEP_ContextOptionDeps
UT_Array< std::pair< UT_StringHolder, PRM_UndoDataHandle > > PRM_UndoDataList
GLsizei const GLchar *const * path
static void setMakeSpareParmsForUnknownChannelsFlag(bool v)
virtual UT_JSONValueMap * getKeyValueDict() const
static bool getRevertInvisibleToDefaultsFlag()
const UT_StringHolder & getDecodedChannelToken(int vi=0) const
std::shared_ptr< T > UT_SharedPtr
Wrapper around std::shared_ptr.
static void setAlwaysHardenFlag(bool o)
GLsizei GLsizei GLchar * source
void valueChanged(int vec_idx, bool propagate)
PRM_Callback getCallback()
GLuint const GLchar * name
const UT_StringHolder & getChannelToken(int vi=0) const
static void setRevertInvisibleToDefaultsFlag(bool v)
static bool getAlwaysHardenFlag()
**Note that the tasks the is the thread number *for the or if it s being executed by a non pool thread(this *can happen in cases where the whole pool is occupied and the calling *thread contributes to running the work load).**Thread pool.Have fun
SIM_API const UT_StringHolder force
GLenum GLsizei GLsizei GLint * values
PRM_ParmList * getOwner() const
virtual ~PRM_DataFactory()
static void setDestructiveRevertToDefaultFlag(bool v)
UT_SharedPtr< const PRM_DataItem > PRM_DataItemHandle
PRM_MultiType
This type enum defines the different types of multi (dynamic) parameters.