CH_Collection Class Reference

#include <CH_Collection.h>

Inheritance diagram for CH_Collection:

List of all members.

Classes
class	ch_ThreadSpecificData
Public Member Functions
	CH_Collection (CH_Manager *manager)
	CH_Collection (CH_Manager *manager, const CH_Collection &from)
virtual	~CH_Collection ()
	SETUPCLASSPACKETID ("CH_Collection")
CH_Manager *	getManager () const
float	getTolerance () const
virtual int	canAccess (uint mask) const
virtual int	canAccessChannel (uint mask, const CH_Channel *chp) const
const CH_Channel *	getChannel (const char *name) const
CH_Channel *	getChannel (const char *name)
const CH_Channel *	getChannel (int idx) const
CH_Channel *	getChannel (int idx)
const CH_Channel *	getChannel (const UT_String &name) const
CH_Channel *	getChannel (const UT_String &name)
int	getChannels (CH_ChannelList &chans, int scope=0) const
int	getChannels (CH_ChannelList &chans, const char *pattern) const
int	getChannelNames (CH_NameList &list, int scope=0) const
int	getChannelCount (int scoped=0) const
virtual CH_Collection *	findCollection (const char *path) const =0
CH_Channel *	findChannel (const char *path) const
CH_Channel *	findOrCreateChannel (const char *path)
CH_Channel *	addChannel (const char *name)
CH_Channel *	addChannel (CH_Channel *chp)
CH_Channel *	dupChannel (const char *name)
virtual CH_Channel *	dupChannel (const CH_Channel &from)
virtual int	rename (const char *from_name, const char *to_name, const char *to_alias)
virtual int	rename (CH_Channel *from, const char *to_name, const char *to_alias)
void	deleteChannel (const char *name)
void	deleteChannel (CH_Channel *chp)
int	deleteChannels ()
float	evaluate (CH_Channel *chp, float time, bool no_disabling, int thread)
void	evaluate (CH_Channel *chp, float from, float to, float *vals, int nsamples, bool no_disabling, bool use_cache, int thread)
void	evaluateString (UT_String &result, CH_Channel *chp, float time, int thread)
void	unresolveLocalVars (int thread)
virtual void	getFullPath (UT_String &path) const =0
void	getFullPath (const CH_Channel *chp, UT_String &p, bool use_alias=false) const
void	channelFind (const char *path, CHfindCallBack callback, void *data=0) const
void	findString (const char *word, bool fullword, bool usewildcards, CHfindCallBack callback, void *data=0)
int	findString (const char *word, bool fullword, bool usewildcards) const
int	changeString (const char *from, const char *to, bool fullword, int thread)
virtual const UT_String &	getName () const =0
virtual int	getUniqueId () const
virtual CH_Collection *	lookupCollection (int id) const
virtual const CH_Collection *	getParent () const =0
virtual CH_Collection *	getParent ()=0
virtual const CH_Collection *	getChild (const char *name) const =0
virtual CH_Collection *	getChild (const char *name)=0
virtual int	getChildren (CH_NameList &names) const =0
virtual int	getChildren (CH_CollectionList &grps) const =0
virtual void	getVariableValue (int table, int index, UT_String &str, int thread)
virtual float	getVariableValue (int table, int index, int thread)
virtual void *	getVariableData (int table, int index, int thread)
virtual const CH_LocalVariable *	resolveVariable (const char *name, int &tab)
int	save (ostream &os, int binary, bool compiled, int scope, const CH_ChannelList *channels=NULL) const
int	saveToFile (const char *nm) const
bool	load (UT_IStream &is, const char *path=0, const CH_LoadInfo *load_info=0, CH_ChannelList *loadedChannels=0, bool delete_keys=false)
template<typename FPREAL_TYPE >
bool	load (UT_IStream &is, const char *path=0, const CH_LoadInfo *load_info=0, CH_ChannelList *loadedChannels=0, bool delete_keys=false)
int	loadFromFile (const char *nm)
float	findKey (float gtime, int dir) const
virtual void	saveKeyFrameForUndo (CH_Channel *chp, float gtime)=0
int	getChanged () const
virtual void	setChanged (CH_CHANGE_TYPE how, void *data=0)
void	setExpose (bool onoff)
bool	getExpose () const
void	clearAndDestroy ()
float	getGlueIV (int thread) const
void	getGlueTime (float &t, float &t0, float &t1, float &v0, float &v1, int thread) const
void	getGlueSlope (float *m0, float *m1, float *a0, float *a1, int thread) const
void	setEvalChannel (CH_Channel *chp, int thraed, const char *name=NULL)
void	setEvalChannel (CH_Channel *chp, const char *name, CH_Channel *&old_chp, const char *&old_name, int thread)
const CH_Channel *	getEvalChannel (int thread) const
CH_Channel *	getEvalChannel (int thread)
const char *	getEvalChannelName (int thread) const
void	getEvalChannelAndName (CH_Channel *&chp, const char *&name, int thread) const
void	initManager (CH_Manager *manager)
float	getGlobalStart () const
float	getGlobalEnd () const
bool	getCollectionRange (float &start, float &end, bool &timedep, int thread)
void	addDynamicVariables (CH_LocalVariable *table)
void	addedParamDependency ()
void	removeParamDependency ()
virtual void	getXformOrder (UT_XformOrder &xord, CH_Channel *chp)
bool	getExternal () const
void	setExternal (bool yesno)
bool	setChannelAlias (CH_Channel &chp, const char *alias)
virtual OP_Channels *	castToOPChannels ()
virtual const OP_Channels *	castToOPChannels () const
virtual void	addLocalVarDependency (int table, int index, void *ref_id)
CH_ExprLanguage	getExprLanguage () const
void	setExprLanguage (CH_ExprLanguage language)
Static Public Member Functions
static bool	isValidChannelName (const char *s)
Protected Member Functions
SYS_FORCE_INLINE void	checkEvaluationError (const CH_Channel *chp, int thread) const
virtual void	addErrorToErrorManager (const char *type, int code, const char *msg=0) const
void	addLocalVariables (CH_LocalVariable *table)
const CH_Collection *	getRoot () const
const CH_ChannelList *	getChannels () const
virtual void	notifyChannelRenameDependents (const char *old_name, const char *new_name)
Protected Attributes
CH_Manager *	myManager
CH_LocalVariable *	myVariables [4]
CH_ChannelList	myChannels
UT_ThreadSpecificValue < ch_ThreadSpecificData >	myThreadSpecificData
UT_SymbolTable *	myChannelAliasesTable
int	myModifiedFlag
CH_ExprLanguage	myExprLanguage
char	myParamDependent
bool	myExternal
bool	myExpose
Friends
class	CH_Manager

---

Detailed Description

Examples:

expr/channel.C, and SOP/SOP_PrimVOP.C.

Definition at line 87 of file CH_Collection.h.

---

Constructor & Destructor Documentation

CH_Collection::CH_Collection

(

CH_Manager *

manager

)

CH_Collection::CH_Collection	(	CH_Manager *	manager,
		const CH_Collection &	from
	)

virtual CH_Collection::~CH_Collection

(

)

[virtual]

---

Member Function Documentation

CH_Channel* CH_Collection::addChannel

(

CH_Channel *

chp

)

CH_Channel* CH_Collection::addChannel

(

const char *

name

)

void CH_Collection::addDynamicVariables

(

CH_LocalVariable *

table

)

[inline]

Definition at line 309 of file CH_Collection.h.

void CH_Collection::addedParamDependency

(

)

virtual void CH_Collection::addErrorToErrorManager	(	const char *	type,
		int	code,
		const char *	msg = 0
	)			const [protected, virtual]

Reimplemented in OP_Channels.

virtual void CH_Collection::addLocalVarDependency	(	int	table,
		int	index,
		void *	ref_id
	)			[virtual]

Reimplemented in OP_Channels.

void CH_Collection::addLocalVariables

(

CH_LocalVariable *

table

)

[inline, protected]

Definition at line 386 of file CH_Collection.h.

virtual int CH_Collection::canAccess

(

uint

mask

)

const [virtual]

virtual int CH_Collection::canAccessChannel	(	uint	mask,
		const CH_Channel *	chp
	)			const [virtual]

Reimplemented in OP_Channels.

virtual const OP_Channels* CH_Collection::castToOPChannels

(

)

const [inline, virtual]

Reimplemented in OP_Channels.

Definition at line 340 of file CH_Collection.h.

virtual OP_Channels* CH_Collection::castToOPChannels

(

)

[inline, virtual]

Reimplemented in OP_Channels.

Definition at line 339 of file CH_Collection.h.

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

void CH_Collection::channelFind	(	const char *	path,
		CHfindCallBack	callback,
		void *	data = 0
	)			const

SYS_FORCE_INLINE void CH_Collection::checkEvaluationError	(	const CH_Channel *	chp,
		int	thread
	)			const [inline, protected]

Definition at line 376 of file CH_Collection.h.

void CH_Collection::clearAndDestroy

(

)

void CH_Collection::deleteChannel

(

CH_Channel *

chp

)

void CH_Collection::deleteChannel

(

const char *

name

)

int CH_Collection::deleteChannels

(

)

virtual CH_Channel* CH_Collection::dupChannel

(

const CH_Channel &

from

)

[virtual]

CH_Channel* CH_Collection::dupChannel

(

const char *

name

)

void CH_Collection::evaluate	(	CH_Channel *	chp,
		float	from,
		float	to,
		float *	vals,
		int	nsamples,
		bool	no_disabling,
		bool	use_cache,
		int	thread
	)

float CH_Collection::evaluate	(	CH_Channel *	chp,
		float	time,
		bool	no_disabling,
		int	thread
	)

void CH_Collection::evaluateString	(	UT_String &	result,
		CH_Channel *	chp,
		float	time,
		int	thread
	)

CH_Channel* CH_Collection::findChannel

(

const char *

path

)

const

virtual CH_Collection* CH_Collection::findCollection

(

const char *

path

)

const [pure virtual]

Implemented in OP_Channels.

float CH_Collection::findKey	(	float	gtime,
		int	dir
	)			const

CH_Channel* CH_Collection::findOrCreateChannel

(

const char *

path

)

int CH_Collection::findString	(	const char *	word,
		bool	fullword,
		bool	usewildcards
	)			const

void CH_Collection::findString	(	const char *	word,
		bool	fullword,
		bool	usewildcards,
		CHfindCallBack	callback,
		void *	data = 0
	)

int CH_Collection::getChanged

(

)

const [inline]

Definition at line 256 of file CH_Collection.h.

CH_Channel* CH_Collection::getChannel

(

const UT_String &

name

)

[inline]

Definition at line 114 of file CH_Collection.h.

const CH_Channel* CH_Collection::getChannel

(

const UT_String &

name

)

const [inline]

Definition at line 110 of file CH_Collection.h.

CH_Channel* CH_Collection::getChannel

(

int

idx

)

[inline]

Definition at line 109 of file CH_Collection.h.

const CH_Channel* CH_Collection::getChannel

(

int

idx

)

const [inline]

Definition at line 108 of file CH_Collection.h.

CH_Channel* CH_Collection::getChannel

(

const char *

name

)

const CH_Channel* CH_Collection::getChannel

(

const char *

name

)

const

Examples:

CHOP/CHOP_Stair.C.

int CH_Collection::getChannelCount

(

int

scoped = 0

)

const

int CH_Collection::getChannelNames	(	CH_NameList &	list,
		int	scope = 0
	)			const

const CH_ChannelList* CH_Collection::getChannels

(

)

const [inline, protected]

Definition at line 392 of file CH_Collection.h.

int CH_Collection::getChannels	(	CH_ChannelList &	chans,
		const char *	pattern
	)			const

int CH_Collection::getChannels	(	CH_ChannelList &	chans,
		int	scope = 0
	)			const

virtual CH_Collection* CH_Collection::getChild

(

const char *

name

)

[pure virtual]

Implemented in OP_Channels.

virtual const CH_Collection* CH_Collection::getChild

(

const char *

name

)

const [pure virtual]

Implemented in OP_Channels.

virtual int CH_Collection::getChildren

(

CH_CollectionList &

grps

)

const [pure virtual]

Implemented in OP_Channels.

virtual int CH_Collection::getChildren

(

CH_NameList &

names

)

const [pure virtual]

Implemented in OP_Channels.

bool CH_Collection::getCollectionRange	(	float &	start,
		float &	end,
		bool &	timedep,
		int	thread
	)

CH_Channel* CH_Collection::getEvalChannel

(

int

thread

)

[inline]

Definition at line 284 of file CH_Collection.h.

const CH_Channel* CH_Collection::getEvalChannel

(

int

thread

)

const [inline]

Definition at line 282 of file CH_Collection.h.

void CH_Collection::getEvalChannelAndName	(	CH_Channel *&	chp,
		const char *&	name,
		int	thread
	)			const [inline]

Definition at line 289 of file CH_Collection.h.

const char* CH_Collection::getEvalChannelName

(

int

thread

)

const [inline]

Definition at line 286 of file CH_Collection.h.

bool CH_Collection::getExpose

(

)

const [inline]

Definition at line 260 of file CH_Collection.h.

CH_ExprLanguage CH_Collection::getExprLanguage

(

)

const

bool CH_Collection::getExternal

(

)

const [inline]

Definition at line 325 of file CH_Collection.h.

void CH_Collection::getFullPath	(	const CH_Channel *	chp,
		UT_String &	p,
		bool	use_alias = false
	)			const

virtual void CH_Collection::getFullPath

(

UT_String &

path

)

const [pure virtual]

Implemented in OP_Channels.

float CH_Collection::getGlobalEnd

(

)

const [inline]

Definition at line 298 of file CH_Collection.h.

float CH_Collection::getGlobalStart

(

)

const [inline]

Definition at line 296 of file CH_Collection.h.

float CH_Collection::getGlueIV

(

int

thread

)

const

void CH_Collection::getGlueSlope	(	float *	m0,
		float *	m1,
		float *	a0,
		float *	a1,
		int	thread
	)			const

Examples:

expr/channel.C.

void CH_Collection::getGlueTime	(	float &	t,
		float &	t0,
		float &	t1,
		float &	v0,
		float &	v1,
		int	thread
	)			const

Examples:

expr/channel.C.

CH_Manager* CH_Collection::getManager

(

)

const [inline]

Definition at line 96 of file CH_Collection.h.

virtual const UT_String& CH_Collection::getName

(

)

const [pure virtual]

Implemented in OP_Channels.

virtual CH_Collection* CH_Collection::getParent

(

)

[pure virtual]

Implemented in OP_Channels.

virtual const CH_Collection* CH_Collection::getParent

(

)

const [pure virtual]

Implemented in OP_Channels.

const CH_Collection* CH_Collection::getRoot

(

)

const [protected]

float CH_Collection::getTolerance

(

)

const [inline]

Definition at line 97 of file CH_Collection.h.

virtual int CH_Collection::getUniqueId

(

)

const [virtual]

Reimplemented in OP_Channels.

virtual void* CH_Collection::getVariableData	(	int	table,
		int	index,
		int	thread
	)			[virtual]

virtual float CH_Collection::getVariableValue	(	int	table,
		int	index,
		int	thread
	)			[virtual]

Reimplemented in OP_Channels.

virtual void CH_Collection::getVariableValue	(	int	table,
		int	index,
		UT_String &	str,
		int	thread
	)			[virtual]

Reimplemented in OP_Channels.

virtual void CH_Collection::getXformOrder	(	UT_XformOrder &	xord,
		CH_Channel *	chp
	)			[virtual]

Reimplemented in OP_Channels.

void CH_Collection::initManager

(

CH_Manager *

manager

)

static bool CH_Collection::isValidChannelName

(

const char *

s

)

[static]

template<typename FPREAL_TYPE >

bool CH_Collection::load	(	UT_IStream &	is,
		const char *	path = 0,
		const CH_LoadInfo *	load_info = 0,
		CH_ChannelList *	loadedChannels = 0,
		bool	delete_keys = false
	)			[inline]

bool CH_Collection::load	(	UT_IStream &	is,
		const char *	path = 0,
		const CH_LoadInfo *	load_info = 0,
		CH_ChannelList *	loadedChannels = 0,
		bool	delete_keys = false
	)

int CH_Collection::loadFromFile

(

const char *

nm

)

virtual CH_Collection* CH_Collection::lookupCollection

(

int

id

)

const [virtual]

Reimplemented in OP_Channels.

virtual void CH_Collection::notifyChannelRenameDependents	(	const char *	old_name,
		const char *	new_name
	)			[protected, virtual]

Reimplemented in OP_Channels.

void CH_Collection::removeParamDependency

(

)

virtual int CH_Collection::rename	(	CH_Channel *	from,
		const char *	to_name,
		const char *	to_alias
	)			[virtual]

virtual int CH_Collection::rename	(	const char *	from_name,
		const char *	to_name,
		const char *	to_alias
	)			[virtual]

virtual const CH_LocalVariable* CH_Collection::resolveVariable	(	const char *	name,
		int &	tab
	)			[virtual]

Reimplemented in OP_Channels.

int CH_Collection::save	(	ostream &	os,
		int	binary,
		bool	compiled,
		int	scope,
		const CH_ChannelList *	channels = NULL
	)			const

virtual void CH_Collection::saveKeyFrameForUndo	(	CH_Channel *	chp,
		float	gtime
	)			[pure virtual]

Implemented in OP_Channels.

int CH_Collection::saveToFile

(

const char *

nm

)

const

virtual void CH_Collection::setChanged	(	CH_CHANGE_TYPE	how,
		void *	data = 0
	)			[virtual]

Reimplemented in OP_Channels.

bool CH_Collection::setChannelAlias	(	CH_Channel &	chp,
		const char *	alias
	)

void CH_Collection::setEvalChannel	(	CH_Channel *	chp,
		const char *	name,
		CH_Channel *&	old_chp,
		const char *&	old_name,
		int	thread
	)

void CH_Collection::setEvalChannel	(	CH_Channel *	chp,
		int	thraed,
		const char *	name = NULL
	)

void CH_Collection::setExpose

(

bool

onoff

)

void CH_Collection::setExprLanguage

(

CH_ExprLanguage

language

)

void CH_Collection::setExternal

(

bool

yesno

)

[inline]

Definition at line 327 of file CH_Collection.h.

CH_Collection::SETUPCLASSPACKETID

(

"CH_Collection"

)

void CH_Collection::unresolveLocalVars

(

int

thread

)

---

Friends And Related Function Documentation

friend class CH_Manager [friend]

Definition at line 425 of file CH_Collection.h.

---

Member Data Documentation

UT_SymbolTable* CH_Collection::myChannelAliasesTable [protected]

Definition at line 402 of file CH_Collection.h.

CH_ChannelList CH_Collection::myChannels [protected]

Definition at line 400 of file CH_Collection.h.

bool CH_Collection::myExpose [protected]

Definition at line 411 of file CH_Collection.h.

CH_ExprLanguage CH_Collection::myExprLanguage [protected]

Definition at line 406 of file CH_Collection.h.

bool CH_Collection::myExternal [protected]

Definition at line 410 of file CH_Collection.h.

CH_Manager* CH_Collection::myManager [protected]

Definition at line 398 of file CH_Collection.h.

int CH_Collection::myModifiedFlag [protected]

Definition at line 404 of file CH_Collection.h.

char CH_Collection::myParamDependent [protected]

Definition at line 408 of file CH_Collection.h.

UT_ThreadSpecificValue<ch_ThreadSpecificData> CH_Collection::myThreadSpecificData [protected]

Definition at line 401 of file CH_Collection.h.

CH_LocalVariable* CH_Collection::myVariables[4] [protected]

Definition at line 399 of file CH_Collection.h.

---

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

• CH/CH_Collection.h