PRM_ParmList Class Reference

#include <PRM_ParmList.h>

List of all members.

Public Member Functions
	PRM_ParmList (PRM_Template *thetemplates, CH_Collection *thechgroupptr, PRM_ParmOwner *node, PRM_PresetInfo *presetinfo, char *optype, bool clear_channels)
	PRM_ParmList (PRM_ParmList *thesrcptr, PRM_Template *thenewtemplate, PRM_ParmOwner *node, PRM_PresetInfo *presetinfo, char *optype, bool leavedefaultsunchanged)
	~PRM_ParmList ()
int	getEntries () const
void	setChannelGroupPtr (CH_Collection *thechgroupptr)
CH_Collection *	getChannelGroupPtr () const
float	findNextKey (double theoldtime)
float	findPrevKey (double theoldtime)
int	allDefaults () const
void	buildDelayedDefaults (bool clear_channels=true)
PRM_Parm *	getParmPtr (const char *theparmname, int &theparmidx)
PRM_Parm *	getParmPtr (const char *theparmname)
const PRM_Parm *	getParmPtr (const char *theparmname) const
PRM_Parm *	getParmPtr (const PRM_Name &name)
const PRM_Parm *	getParmPtr (const PRM_Name &name) const
PRM_Parm *	getParmPtr (const int theindex)
const PRM_Parm *	getParmPtr (const int theindex) const
int	getParmIndex (const PRM_Parm *parm) const
int	getParmIndex (const char *parmname) const
PRM_Parm *	getParmPtrFromChannel (const char *channel, int *vecidx=0)
int	getParmIndex (const char *channel_name, int &subidx, bool allow_alias=true) const
int	getParmIndexFromChannel (const char *channel, bool allow_alias) const
void	clearAllDirtyFlags ()
int	areAllFlagsClean () const
void	clearAllUndoSavedFlags ()
void	revertToDefaults (double time)
void	revertValuesToFactoryDefaults ()
void	updateFromOldTemplate (PRM_ParmList *oldlist)
void	updateSpareParmTemplates (PRM_Template *newtemplates, bool leavedefaultsunchanged)
void	saveSingle (PRM_Parm *, ostream &os, int binary) const
void	save (ostream &os, int binary, bool compiled) const
bool	load (UT_IStream &is, const char *path, PRM_ParmList *obsoleteparms)
void	saveChannelAliases (ostream &os, int binary)
bool	loadChannelAliases (UT_IStream &is, const char *path)
bool	hasChannelAliases () const
void	clearAndDestroyChannels ()
int	hasAnyChannels ()
int	addChannel (const char *name)
void	reloadChannelPtrs ()
int	channelPtrModified (const char *name)
unsigned	getUserMask () const
void	setUserMask (unsigned m)
unsigned	getPermissions () const
void	setPermissions (unsigned mask)
unsigned	getAssetPermissionMask () const
void	setAssetPermissionMask (unsigned mask)
int	canAccess (unsigned mask=PRM_WRITE_OK, const PRM_Type &type=PRM_TYPE_ZERO) const
int	canAccessIgnoringAssetMask (unsigned mask=PRM_WRITE_OK, const PRM_Type &type=PRM_TYPE_ZERO) const
int	canAccessCheckingOnlyAssetMask (unsigned mask=PRM_WRITE_OK, const PRM_Type &type=PRM_TYPE_ZERO) const
void	hardenChanges (double time, bool forceflag=0, const char *patt=0, CH_ChannelRefList *list=0)
PRM_ChanState	getChanState (double time)
void	sendChangeEvent (CH_CHANGE_TYPE what, PRM_Parm *who=0)
void	setEventHandler (void *data, void(*handler)(void *, CH_CHANGE_TYPE, int))
int	checkTimeDependence (bool evaluate_channels=false)
void	setTimeDependent (int onOff)
void	setCookTimeDependent (int onOff)
void	setDataDependent (int onOff=1)
int	getTimeDependent () const
int	getCookTimeDependent () const
int	getDataDependent () const
void	pushVariables ()
void	popVariables ()
int	findString (const char *str, bool fullword, bool usewildcards) const
int	changeString (const char *from, const char *to, bool fullword)
int	getSendExtraEvent ()
void	setSendExtraEvent ()
void	clearSendExtraEvent ()
void	getMagicString (UT_TokenString &string, double t, int parm_group=1)
void	setUndoSavedFlag ()
void	setAutoTakeUndoSavedFlag ()
void	appendMultiParms (const PRM_Multi *multiparmowner, PRM_Template *templ, int num, bool spare, const UT_IntArray &instance, UT_PtrArray< PRM_Parm * > &newparms)
void	removeAndDestroyParm (int index)
void	insertMultiParmItem (int index, int i)
void	removeMultiParmItem (int index, int i)
PRM_ParmOwner *	getParmOwner () const
PRM_PresetInfo *	getPresetInfo () const
void	clearParmOwner ()
bool	checkMultiParmInstance (const char *parmname, bool do_owner_init)
bool	setChannelAlias (PRM_Parm &parm, int subindex, const char *chan_alias)
int64	getMemUsage (UT_Bool onlythis) const
unsigned long	getAddRemoveCount () const
void	setAddRemoveCount (unsigned long count)
void	evalStringRaw (UT_String &value, const char *pn, int vi, double t)
void	evalString (UT_String &value, const char *pn, int vi, double t)
void	setString (const UT_String &value, CH_StringMeaning meaning, const char *pn, int vi, double t, bool propagate)
int	evalInt (const char *pn, int vi, double t)
void	setInt (int value, const char *pn, int vi, double t, bool propagate)
float	evalFloat (const char *pn, int vi, double t)
void	setFloat (float value, const char *pn, int vi, double t, bool propagate)
Static Public Member Functions
static void	beginLoading ()
static void	endLoading ()
static bool	isLoading ()
static PRM_ORCallback	getORCallback (void)
static void	setORCallback (PRM_ORCallback func)
static void	removeOpSharedInfo (const char *optoken)
static void	renameOpSharedInfo (const char *oldoptoken, const char *newoptoken)

---

Detailed Description

Examples:

SOP/MSS_CustomBrushState.C.

Definition at line 76 of file PRM_ParmList.h.

---

Constructor & Destructor Documentation

PRM_ParmList::PRM_ParmList	(	PRM_Template *	thetemplates,
		CH_Collection *	thechgroupptr,
		PRM_ParmOwner *	node,
		PRM_PresetInfo *	presetinfo,
		char *	optype,
		bool	clear_channels
	)

PRM_ParmList::PRM_ParmList	(	PRM_ParmList *	thesrcptr,
		PRM_Template *	thenewtemplate,
		PRM_ParmOwner *	node,
		PRM_PresetInfo *	presetinfo,
		char *	optype,
		bool	leavedefaultsunchanged
	)

PRM_ParmList::~PRM_ParmList

(

)

---

Member Function Documentation

int PRM_ParmList::addChannel

(

const char *

name

)

int PRM_ParmList::allDefaults

(

)

const

void PRM_ParmList::appendMultiParms	(	const PRM_Multi *	multiparmowner,
		PRM_Template *	templ,
		int	num,
		bool	spare,
		const UT_IntArray &	instance,
		UT_PtrArray< PRM_Parm * > &	newparms
	)

int PRM_ParmList::areAllFlagsClean

(

)

const

static void PRM_ParmList::beginLoading

(

)

[static]

void PRM_ParmList::buildDelayedDefaults

(

bool

clear_channels = true

)

int PRM_ParmList::canAccess	(	unsigned	mask = PRM_WRITE_OK,
		const PRM_Type &	type = PRM_TYPE_ZERO
	)			const

int PRM_ParmList::canAccessCheckingOnlyAssetMask	(	unsigned	mask = PRM_WRITE_OK,
		const PRM_Type &	type = PRM_TYPE_ZERO
	)			const

int PRM_ParmList::canAccessIgnoringAssetMask	(	unsigned	mask = PRM_WRITE_OK,
		const PRM_Type &	type = PRM_TYPE_ZERO
	)			const

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

int PRM_ParmList::channelPtrModified

(

const char *

name

)

bool PRM_ParmList::checkMultiParmInstance	(	const char *	parmname,
		bool	do_owner_init
	)

int PRM_ParmList::checkTimeDependence

(

bool

evaluate_channels = false

)

void PRM_ParmList::clearAllDirtyFlags

(

)

void PRM_ParmList::clearAllUndoSavedFlags

(

)

void PRM_ParmList::clearAndDestroyChannels

(

)

void PRM_ParmList::clearParmOwner

(

)

void PRM_ParmList::clearSendExtraEvent

(

)

[inline]

Definition at line 270 of file PRM_ParmList.h.

static void PRM_ParmList::endLoading

(

)

[static]

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

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

void PRM_ParmList::evalString	(	UT_String &	value,
		const char *	pn,
		int	vi,
		double	t
	)

void PRM_ParmList::evalStringRaw	(	UT_String &	value,
		const char *	pn,
		int	vi,
		double	t
	)

float PRM_ParmList::findNextKey

(

double

theoldtime

)

float PRM_ParmList::findPrevKey

(

double

theoldtime

)

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

unsigned long PRM_ParmList::getAddRemoveCount

(

)

const [inline]

Definition at line 310 of file PRM_ParmList.h.

unsigned PRM_ParmList::getAssetPermissionMask

(

)

const [inline]

Definition at line 193 of file PRM_ParmList.h.

CH_Collection* PRM_ParmList::getChannelGroupPtr

(

)

const

PRM_ChanState PRM_ParmList::getChanState

(

double

time

)

int PRM_ParmList::getCookTimeDependent

(

)

const [inline]

Definition at line 252 of file PRM_ParmList.h.

int PRM_ParmList::getDataDependent

(

)

const [inline]

Definition at line 253 of file PRM_ParmList.h.

int PRM_ParmList::getEntries

(

)

const [inline]

Definition at line 97 of file PRM_ParmList.h.

void PRM_ParmList::getMagicString	(	UT_TokenString &	string,
		double	t,
		int	parm_group = 1
	)

int64 PRM_ParmList::getMemUsage

(

UT_Bool

onlythis

)

const

static PRM_ORCallback PRM_ParmList::getORCallback

(

void

)

[inline, static]

Definition at line 256 of file PRM_ParmList.h.

int PRM_ParmList::getParmIndex	(	const char *	channel_name,
		int &	subidx,
		bool	allow_alias = true
	)			const

int PRM_ParmList::getParmIndex

(

const char *

parmname

)

const

int PRM_ParmList::getParmIndex

(

const PRM_Parm *

parm

)

const

int PRM_ParmList::getParmIndexFromChannel	(	const char *	channel,
		bool	allow_alias
	)			const

PRM_ParmOwner* PRM_ParmList::getParmOwner

(

)

const [inline]

Definition at line 290 of file PRM_ParmList.h.

const PRM_Parm* PRM_ParmList::getParmPtr

(

const int

theindex

)

const [inline]

Definition at line 128 of file PRM_ParmList.h.

PRM_Parm* PRM_ParmList::getParmPtr

(

const int

theindex

)

[inline]

Definition at line 122 of file PRM_ParmList.h.

const PRM_Parm* PRM_ParmList::getParmPtr

(

const PRM_Name &

name

)

const

PRM_Parm* PRM_ParmList::getParmPtr

(

const PRM_Name &

name

)

const PRM_Parm* PRM_ParmList::getParmPtr

(

const char *

theparmname

)

const

PRM_Parm* PRM_ParmList::getParmPtr

(

const char *

theparmname

)

PRM_Parm* PRM_ParmList::getParmPtr	(	const char *	theparmname,
		int &	theparmidx
	)

Examples:

SOP/MSS_CustomBrushState.C.

PRM_Parm* PRM_ParmList::getParmPtrFromChannel	(	const char *	channel,
		int *	vecidx = 0
	)

unsigned PRM_ParmList::getPermissions

(

)

const [inline]

Definition at line 184 of file PRM_ParmList.h.

PRM_PresetInfo* PRM_ParmList::getPresetInfo

(

)

const [inline]

Definition at line 291 of file PRM_ParmList.h.

int PRM_ParmList::getSendExtraEvent

(

)

[inline]

Definition at line 268 of file PRM_ParmList.h.

int PRM_ParmList::getTimeDependent

(

)

const [inline]

Definition at line 251 of file PRM_ParmList.h.

unsigned PRM_ParmList::getUserMask

(

)

const [inline]

Definition at line 181 of file PRM_ParmList.h.

void PRM_ParmList::hardenChanges	(	double	time,
		bool	forceflag = 0,
		const char *	patt = 0,
		CH_ChannelRefList *	list = 0
	)

int PRM_ParmList::hasAnyChannels

(

)

bool PRM_ParmList::hasChannelAliases

(

)

const

void PRM_ParmList::insertMultiParmItem	(	int	index,
		int	i
	)

static bool PRM_ParmList::isLoading

(

)

[static]

bool PRM_ParmList::load	(	UT_IStream &	is,
		const char *	path,
		PRM_ParmList *	obsoleteparms
	)

bool PRM_ParmList::loadChannelAliases	(	UT_IStream &	is,
		const char *	path
	)

void PRM_ParmList::popVariables

(

)

void PRM_ParmList::pushVariables

(

)

void PRM_ParmList::reloadChannelPtrs

(

)

void PRM_ParmList::removeAndDestroyParm

(

int

index

)

void PRM_ParmList::removeMultiParmItem	(	int	index,
		int	i
	)

static void PRM_ParmList::removeOpSharedInfo

(

const char *

optoken

)

[static]

static void PRM_ParmList::renameOpSharedInfo	(	const char *	oldoptoken,
		const char *	newoptoken
	)			[static]

void PRM_ParmList::revertToDefaults

(

double

time

)

void PRM_ParmList::revertValuesToFactoryDefaults

(

)

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

void PRM_ParmList::saveChannelAliases	(	ostream &	os,
		int	binary
	)

void PRM_ParmList::saveSingle	(	PRM_Parm *	,
		ostream &	os,
		int	binary
	)			const

void PRM_ParmList::sendChangeEvent	(	CH_CHANGE_TYPE	what,
		PRM_Parm *	who = 0
	)

void PRM_ParmList::setAddRemoveCount

(

unsigned long

count

)

[inline]

Definition at line 312 of file PRM_ParmList.h.

void PRM_ParmList::setAssetPermissionMask

(

unsigned

mask

)

[inline]

Definition at line 195 of file PRM_ParmList.h.

void PRM_ParmList::setAutoTakeUndoSavedFlag

(

)

[inline]

Definition at line 276 of file PRM_ParmList.h.

bool PRM_ParmList::setChannelAlias	(	PRM_Parm &	parm,
		int	subindex,
		const char *	chan_alias
	)

void PRM_ParmList::setChannelGroupPtr

(

CH_Collection *

thechgroupptr

)

void PRM_ParmList::setCookTimeDependent

(

int

onOff

)

[inline]

Definition at line 246 of file PRM_ParmList.h.

void PRM_ParmList::setDataDependent

(

int

onOff = 1

)

[inline]

Definition at line 248 of file PRM_ParmList.h.

void PRM_ParmList::setEventHandler	(	void *	data,
		void(*)(void *, CH_CHANGE_TYPE, int)	handler
	)			[inline]

Definition at line 225 of file PRM_ParmList.h.

void PRM_ParmList::setFloat	(	float	value,
		const char *	pn,
		int	vi,
		double	t,
		bool	propagate
	)

void PRM_ParmList::setInt	(	int	value,
		const char *	pn,
		int	vi,
		double	t,
		bool	propagate
	)

static void PRM_ParmList::setORCallback

(

PRM_ORCallback

func

)

[inline, static]

Definition at line 257 of file PRM_ParmList.h.

void PRM_ParmList::setPermissions

(

unsigned

mask

)

[inline]

Definition at line 185 of file PRM_ParmList.h.

void PRM_ParmList::setSendExtraEvent

(

)

[inline]

Definition at line 269 of file PRM_ParmList.h.

void PRM_ParmList::setString	(	const UT_String &	value,
		CH_StringMeaning	meaning,
		const char *	pn,
		int	vi,
		double	t,
		bool	propagate
	)

void PRM_ParmList::setTimeDependent

(

int

onOff

)

[inline]

Definition at line 244 of file PRM_ParmList.h.

void PRM_ParmList::setUndoSavedFlag

(

)

[inline]

Definition at line 275 of file PRM_ParmList.h.

void PRM_ParmList::setUserMask

(

unsigned

m

)

[inline]

Definition at line 182 of file PRM_ParmList.h.

void PRM_ParmList::updateFromOldTemplate

(

PRM_ParmList *

oldlist

)

void PRM_ParmList::updateSpareParmTemplates	(	PRM_Template *	newtemplates,
		bool	leavedefaultsunchanged
	)

---

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

• PRM/PRM_ParmList.h