#include <PRM_Data.h>

Inheritance diagram for PRM_Data:

Public Member Functions
	PRM_Data (PRM_Template thetemplateptr, PRM_Parm parm)

	PRM_Data (PRM_Data thesrcptr, PRM_Parm parm)

	~PRM_Data () override

void	adopt (PRM_Instance &thesrc) override

PRM_Instance *	duplicateSelf (PRM_Parm *parm) override

void	setValueToDefault (fpreal time, int index, PRM_AddKeyType add_key) override

void	revertToDefault (int index) override

void	revertToDefaults (bool clear_channels=true) override

void	restoreFactoryDefault (int index) override

void	overwriteDefault (fpreal time, int index) override

void	overwriteDefaults (fpreal time) override

int	isDefault (int index, enum PRM_DefaultType deftype, bool basiccheck=true) const override

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

bool	load (UT_IStream &is) override

void	saveUndoData (PRM_UndoDataHandle &data) const override

bool	loadUndoData (const PRM_UndoDataHandle &data) override

void	saveCommand (std::ostream &os, int values, int index=-1) const override

int	loadCommand (int argc, const char *const argv[], int index, bool values_only, PRM_AddKeyType add_key, PRM_KeySetType set_type) override

void	getValue (PRM_ParmList *thelist, fpreal thetime, int32 &theintref, int theindex, int thread) const override

void	getValue (PRM_ParmList *thelist, fpreal thetime, int64 &theintref, int theindex, int thread) const override

void	getValue (PRM_ParmList *thelist, fpreal thetime, fpreal &thefloatref, int theindex, int thread) const override

void	getValue (PRM_ParmList *thelist, fpreal thetime, UT_String &thestrref, int theindex, bool expand, int thread) const override

void	getValue (PRM_ParmList *thelist, fpreal thetime, PRM_DataItemHandle &thedataref, int theindex, int thread) const override

void	getValue (PRM_ParmList *thelist, fpreal time, UT_JSONValueMap &themap, int index, bool expand, int thread) const override

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

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

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

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

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

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

void	getExpression (fpreal thetime, UT_String &expr, int theindex, bool allow_value, int thread) const override

void	setExpression (fpreal time, const char *expr, CH_ExprLanguage language, int index, bool evaluate=true, bool rmchannel=false) override

void	setDefaultChannelValue (CH_Channel *channelptr, int theindex=0) override

bool	getMagicString (UT_TokenString &magic, PRM_ParmList *list, int size, fpreal t, bool add_if_default, int thread) override

void	hardenChanges (fpreal thetime, int theindex, bool theforceflag, const char patt=0, CH_ChannelRefList list=0) override

int64	getMemoryUsage (bool inclusive) const override

bool	setData (const PRM_DataItemHandle &b, fpreal time, int index)

PRM_DataItemHandle	getData (fpreal time, int index) const

Public Member Functions inherited from PRM_Instance
	PRM_Instance (PRM_Template thetemplateptr, PRM_Parm parm)

	PRM_Instance (PRM_Instance thesrcptr, PRM_Parm parm)

virtual	~PRM_Instance ()

virtual void	adoptOverrides (PRM_Instance &thesrcinstance)

bool	isAllDefault (enum PRM_DefaultType deftype) const

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

CH_StringMeaning	getStringMeaning (fpreal time, int index) const

CH_ExprLanguage	getExprLanguageIfMadeAnExpression (fpreal time, int index) const

bool	isLanguageOldExprOrLiteral (fpreal time, int index) const

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 int64 *values, bool kill_expr=false, PRM_AddKeyType add_key=PRM_AK_MARK_PENDING, PRM_KeySetType setkey=PRM_USE_PREFERENCES)

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)

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_Collection *	getChannelGroupPtr () const

fpreal	getEvalTime (int thread) const

fpreal	getGlobalStartTime () const

CH_Channel *	getChannel (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_ContextOptionDeps &	getContextOptionDeps (int subindex) const

bool	hasGlobalContextOptionDependency (int subindex, const UT_StringRef &opt) const

void	addContextOptionDep (int subindex, const UT_StringHolder &opt, bool set_dependency_on_global)

int	changePending (int index)

virtual PRM_ChanState	getChanState (fpreal time, int index) const

virtual PRM_ChanState	getChanState (fpreal time) const

void	setKey (fpreal time, int index)

void	setKey (fpreal time, int index, const char expr, CH_ExprLanguage language, const char patt=nullptr, CH_ChannelRefList *list=nullptr)

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_Value *	inputNotifyValue ()

const PRM_Value *	inputNotifyValue () const

const PRM_Type &	getType () const

PRM_TypeExtended	getTypeExtended () const

PRM_MultiType	getMultiType () const

fpreal	getMultiSize () const

int	getMultiStartOffset () const

const PRM_Template *	getMultiParmTemplate () const

PRM_Template *	getMultiParmTemplate ()

const char *	getToken () const

const char *	getLabel () const

PRM_Callback	getCallback () const

int	getVectorSize () const

const PRM_Range *	getRangePtr () const

void	getChannelToken (UT_String &chname, int i) const

const UT_StringHolder &	getChannelToken (int i) const

const PRM_ChoiceList *	getChoiceListPtr () const

const PRM_Template *	getTemplatePtr () const

PRM_Template *	getTemplatePtr ()

bool	hasChannelAlias (int index) const

void	getChannelAlias (UT_String &strref, int index) const

const UT_StringHolder &	getChannelAlias (int index) const

bool	setChannelAlias (const UT_StringHolder &token_alias, int index)

int	findSubIndex (const UT_StringRef &thechannelname, bool allow_alias) const

PRM_ParmOwner *	getParmOwner () const

PRM_ParmList *	getParmList () const

PRM_Parm *	getParm () 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_Instance *	getMultiParmOwner () const

void	setMultiParmOwner (const PRM_Multi *multiparmowner)

const PRM_Template *	findMultiParmTemplate () const

int	getMultiInstanceIndex (UT_Array< int > &indices, bool instance_index=true) const

bool	validIndex (int index) const

virtual bool	isRotationParm () const

void	validateChannelNames (PRM_ParmList &list)

DEP_MicroNode &	microNode (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 (const 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_Color &	getChannelCustomColor (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

void	setTimeDependentMicroNode (int subindex, bool timedep)

DEP_MicroNode &	constMicroNode (int vi)

Additional Inherited Members
Static Public Member Functions inherited from PRM_Instance
static bool	isChanRefString (const char str, bool is_expr, UT_String chref=nullptr)

static bool	isObsoleteDirectChanRefString (const char str, UT_String chref=nullptr)

Static Public Member Functions inherited from UT_SmallObject< PRM_Instance, UT_SMALLOBJECT_CLEANPAGES_DEFAULT, UT_SMALLOBJECT_PAGESIZE_DEFAULT, UT_SMALLOBJECT_THREADSAFE_OFF >
static void *	operator new (size_t size)
	Regular new/delete operators. More...

static void	operator delete (void *p, size_t size)
	Regular new/delete operators. More...

static void *	operator new (size_t, void *p)

static void	operator delete (void , void )

Protected Types inherited from PRM_Instance
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 inherited from PRM_Instance
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

bool	shouldSaveData () const

Static Protected Member Functions inherited from PRM_Instance
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 43 of file PRM_Data.h.

Constructor & Destructor Documentation

PRM_Data::PRM_Data	(	PRM_Template *	thetemplateptr,
		PRM_Parm *	parm
	)

PRM_Data::PRM_Data	(	PRM_Data *	thesrcptr,
		PRM_Parm *	parm
	)

PRM_Data::~PRM_Data ( )

override

Member Function Documentation

void PRM_Data::adopt ( PRM_Instance & thesrc )

overridevirtual

Reimplemented from PRM_Instance.

PRM_Instance* PRM_Data::duplicateSelf ( PRM_Parm * parm )

overridevirtual

Implements PRM_Instance.

PRM_DataItemHandle PRM_Data::getData	(	fpreal	time,
		int	index
	)		const

void PRM_Data::getExpression	(	fpreal	thetime,
		UT_String &	expr,
		int	theindex,
		bool	allow_value,
		int	thread
	)		const

overridevirtual

Implements PRM_Instance.

void PRM_Data::getExpressionStringForUI	(	fpreal	thetime,
		UT_String &	thestrref,
		int	theindex,
		int	thread
	)		const

overridevirtual

Implements PRM_Instance.

bool PRM_Data::getMagicString	(	UT_TokenString &	magic,
		PRM_ParmList *	list,
		int	size,
		fpreal	t,
		bool	add_if_default,
		int	thread
	)

overridevirtual

Implements PRM_Instance.

int64 PRM_Data::getMemoryUsage ( bool inclusive ) const

overridevirtual

Reimplemented from PRM_Instance.

void PRM_Data::getValue	(	PRM_ParmList *	thelist,
		fpreal	thetime,
		int32 &	theintref,
		int	theindex,
		int	thread
	)		const

overridevirtual

Implements PRM_Instance.

void PRM_Data::getValue	(	PRM_ParmList *	thelist,
		fpreal	thetime,
		int64 &	theintref,
		int	theindex,
		int	thread
	)		const

overridevirtual

Implements PRM_Instance.

void PRM_Data::getValue	(	PRM_ParmList *	thelist,
		fpreal	thetime,
		fpreal &	thefloatref,
		int	theindex,
		int	thread
	)		const

overridevirtual

Implements PRM_Instance.

void PRM_Data::getValue	(	PRM_ParmList *	thelist,
		fpreal	thetime,
		UT_String &	thestrref,
		int	theindex,
		bool	expand,
		int	thread
	)		const

overridevirtual

Implements PRM_Instance.

void PRM_Data::getValue	(	PRM_ParmList *	thelist,
		fpreal	thetime,
		PRM_DataItemHandle &	thedataref,
		int	theindex,
		int	thread
	)		const

overridevirtual

Implements PRM_Instance.

void PRM_Data::getValue	(	PRM_ParmList *	thelist,
		fpreal	time,
		UT_JSONValueMap &	themap,
		int	index,
		bool	expand,
		int	thread
	)		const

overridevirtual

Implements PRM_Instance.

void PRM_Data::hardenChanges	(	fpreal	thetime,
		int	theindex,
		bool	theforceflag,
		const char *	patt = `0`,
		CH_ChannelRefList *	list = `0`
	)

overridevirtual

Implements PRM_Instance.

int PRM_Data::isDefault	(	int	index,
		enum PRM_DefaultType	deftype,
		bool	basiccheck = `true`
	)		const

overridevirtual

Reimplemented from PRM_Instance.

bool PRM_Data::load ( UT_IStream & is )

overridevirtual

Implements PRM_Instance.

int PRM_Data::loadCommand	(	int	argc,
		const char *const	argv[],
		int	index,
		bool	values_only,
		PRM_AddKeyType	add_key,
		PRM_KeySetType	set_type
	)

overridevirtual

Implements PRM_Instance.

bool PRM_Data::loadUndoData ( const PRM_UndoDataHandle & data )

overridevirtual

Reimplemented from PRM_Instance.

void PRM_Data::overwriteDefault	(	fpreal	time,
		int	index
	)

overridevirtual

Implements PRM_Instance.

void PRM_Data::overwriteDefaults ( fpreal time )

overridevirtual

Implements PRM_Instance.

void PRM_Data::restoreFactoryDefault ( int index )

overridevirtual

Implements PRM_Instance.

void PRM_Data::revertToDefault ( int index )

overridevirtual

Implements PRM_Instance.

void PRM_Data::revertToDefaults ( bool clear_channels = true )

overridevirtual

Implements PRM_Instance.

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

overridevirtual

Implements PRM_Instance.

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

overridevirtual

Implements PRM_Instance.

void PRM_Data::saveUndoData ( PRM_UndoDataHandle & data ) const

overridevirtual

Reimplemented from PRM_Instance.

bool PRM_Data::setData	(	const PRM_DataItemHandle &	b,
		fpreal	time,
		int	index
	)

void PRM_Data::setDefaultChannelValue	(	CH_Channel *	channelptr,
		int	theindex = `0`
	)

overridevirtual

Implements PRM_Instance.

void PRM_Data::setExpression	(	fpreal	time,
		const char *	expr,
		CH_ExprLanguage	language,
		int	index,
		bool	evaluate = `true`,
		bool	rmchannel = `false`
	)

overridevirtual

Reimplemented from PRM_Instance.

void PRM_Data::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`
	)

overridevirtual

Reimplemented from PRM_Instance.

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

overridevirtual

Reimplemented from PRM_Instance.

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

overridevirtual

Reimplemented from PRM_Instance.

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

overridevirtual

Reimplemented from PRM_Instance.

void PRM_Data::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`
	)

overridevirtual

Reimplemented from PRM_Instance.

void PRM_Data::setValueToDefault	(	fpreal	time,
		int	index,
		PRM_AddKeyType	add_key
	)

overridevirtual

Implements PRM_Instance.

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

PRM/PRM_Data.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation