HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Friends | List of all members
CH_Collection Class Referenceabstract

#include <CH_Collection.h>

+ Inheritance diagram for CH_Collection:

Public Member Functions

 CH_Collection (CH_Manager *manager)
 
 CH_Collection (CH_Manager *manager, const CH_Collection &from)
 
virtual ~CH_Collection ()
 
virtual int64 getMemoryUsage (bool inclusive) const
 
 SETUPCLASSPACKETID ("CH_Collection")
 
CH_Manager * getManager () const
 
fpreal getTolerance () const
 
virtual int canAccess (uint mask) const
 
virtual int canAccessChannel (uint mask, const CH_Channel *chp) const
 
exint entries () const
 
const CH_Channel * getChannel (const UT_StringRef &name) const
 
CH_Channel * getChannel (const UT_StringRef &name)
 
const CH_Channel * getChannel (int idx) const
 
CH_Channel * getChannel (int idx)
 
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 UT_StringHolder &name)
 
CH_Channel * addChannel (CH_Channel *chp)
 
CH_Channel * dupChannel (const UT_StringRef &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 (CH_Channel *chp)
 
int deleteChannels ()
 
fpreal evaluate (CH_Channel *chp, fpreal time, bool no_disabling, int thread)
 
void evaluate (CH_Channel *chp, fpreal from, fpreal to, fpreal *vals, int nsamples, bool no_disabling, bool use_cache, int thread)
 
void evaluateString (UT_String &result, CH_Channel *chp, fpreal time, int thread)
 
void unresolveLocalVars (int thread)
 
virtual UT_StringHolder getFullPath () const =0
 
void getFullPath (UT_String &path) const
 
void getFullPath (const CH_Channel *chp, UT_StringHolder &p, bool use_alias=false) const
 
void getFullPath (const CH_Channel *chp, UT_String &p, bool use_alias=false) const
 
void channelFind (const char *path, CHfindCallBack callback, void *data=nullptr) const
 
void findString (const char *word, bool fullword, bool usewildcards, CHfindCallBack callback, void *data=nullptr)
 
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_StringHolder & 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 const void * getOwner () const =0
 
virtual void * getOwner ()=0
 
virtual int getChildren (CH_NameList &names) const =0
 
virtual int getChildren (CH_CollectionList &grps) const =0
 
virtual bool getVariableValue (UT_String &str, int table, int index, int thread)
 
virtual bool getVariableValue (fpreal &val, int table, int index, int thread)
 
virtual const CH_LocalVariable * resolveVariable (const char *name, int &tab)
 
int save (std::ostream &os, bool binary, bool compiled, bool scoped, bool pending_state, const CH_ChannelList *channels) const
 
int saveToFile (const char *nm) const
 
template<typename FPREAL_TYPE >
bool load (UT_IStream &is, const char *path=nullptr, const CH_LoadInfo *load_info=nullptr, CH_ChannelList *loadedChannels=nullptr, bool delete_keys=false)
 
int loadFromFile (const char *nm)
 
fpreal findKey (fpreal gtime, int dir) const
 
virtual void saveKeyFrameForUndo (CH_Channel *chp, fpreal gtime)=0
 
virtual void saveChannelForUndo (CH_Channel *chp)=0
 Save the entire channel for undo. More...
 
int getChanged () const
 
virtual void setChanged (CH_CHANGE_TYPE how, void *data=nullptr)
 
void setExpose (bool onoff)
 
bool getExpose () const
 
void clearAndDestroy ()
 
void initManager (CH_Manager *manager)
 
void updateGlobalVariables (CH_LocalVariable *table)
 
fpreal getGlobalStart () const
 
fpreal getGlobalEnd () const
 
bool getCollectionRange (fpreal &start, fpreal &end, bool &timedep, int thread)
 
void addDynamicVariables (CH_LocalVariable *table)
 
void addedParamDependency ()
 
void removeParamDependency ()
 
virtual void getXformOrder (UT_XformOrder &xord, const CH_Channel *chp) const
 
bool setChannelAlias (CH_Channel &chp, const UT_StringHolder &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)
 
virtual void getLocalVariables (UT_StringArray &out_vars)
 
bool getExternal () const
 
void setExternal (bool yesno)
 

Static Public Member Functions

static bool isValidChannelName (const char *s)
 

Static Public Attributes

static const char * theValidChannelNameWordBreaks
 

Protected Member Functions

SYS_FORCE_INLINE void checkEvaluationError (const CH_Channel *chp, int thread) 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)
 

Friends

class CH_Manager
 

Detailed Description

Definition at line 93 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 ( const UT_StringHolder &  name)
CH_Channel* CH_Collection::addChannel ( CH_Channel *  chp)
void CH_Collection::addDynamicVariables ( CH_LocalVariable *  table)
inline

Definition at line 302 of file CH_Collection.h.

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

Reimplemented in OP_Channels.

void CH_Collection::addLocalVariables ( CH_LocalVariable *  table)
inlineprotected

Definition at line 361 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 OP_Channels* CH_Collection::castToOPChannels ( )
inlinevirtual

Reimplemented in OP_Channels, and OP_GeometryChannels.

Definition at line 336 of file CH_Collection.h.

virtual const OP_Channels* CH_Collection::castToOPChannels ( ) const
inlinevirtual

Reimplemented in OP_Channels, and OP_GeometryChannels.

Definition at line 337 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 = nullptr 
) const
SYS_FORCE_INLINE void CH_Collection::checkEvaluationError ( const CH_Channel *  chp,
int  thread 
) const
inlineprotected

Definition at line 354 of file CH_Collection.h.

void CH_Collection::clearAndDestroy ( )
void CH_Collection::deleteChannel ( CH_Channel *  chp)
int CH_Collection::deleteChannels ( )
CH_Channel* CH_Collection::dupChannel ( const UT_StringRef &  name)
virtual CH_Channel* CH_Collection::dupChannel ( const CH_Channel &  from)
virtual
exint CH_Collection::entries ( ) const
inline

Definition at line 110 of file CH_Collection.h.

fpreal CH_Collection::evaluate ( CH_Channel *  chp,
fpreal  time,
bool  no_disabling,
int  thread 
)
void CH_Collection::evaluate ( CH_Channel *  chp,
fpreal  from,
fpreal  to,
fpreal *  vals,
int  nsamples,
bool  no_disabling,
bool  use_cache,
int  thread 
)
void CH_Collection::evaluateString ( UT_String &  result,
CH_Channel *  chp,
fpreal  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.

fpreal CH_Collection::findKey ( fpreal  gtime,
int  dir 
) const
CH_Channel* CH_Collection::findOrCreateChannel ( const char *  path)
void CH_Collection::findString ( const char *  word,
bool  fullword,
bool  usewildcards,
CHfindCallBack  callback,
void *  data = nullptr 
)
int CH_Collection::findString ( const char *  word,
bool  fullword,
bool  usewildcards 
) const
int CH_Collection::getChanged ( ) const
inline

Definition at line 273 of file CH_Collection.h.

const CH_Channel* CH_Collection::getChannel ( const UT_StringRef &  name) const
Examples:
CHOP/CHOP_Stair.C.
CH_Channel* CH_Collection::getChannel ( const UT_StringRef &  name)
const CH_Channel* CH_Collection::getChannel ( int  idx) const
inline

Definition at line 118 of file CH_Collection.h.

CH_Channel* CH_Collection::getChannel ( int  idx)
inline

Definition at line 119 of file CH_Collection.h.

int CH_Collection::getChannelCount ( int  scoped = 0) const
int CH_Collection::getChannelNames ( CH_NameList &  list,
int  scope = 0 
) const
int CH_Collection::getChannels ( CH_ChannelList &  chans,
int  scope = 0 
) const
int CH_Collection::getChannels ( CH_ChannelList &  chans,
const char *  pattern 
) const
const CH_ChannelList* CH_Collection::getChannels ( ) const
inlineprotected

Definition at line 367 of file CH_Collection.h.

virtual const CH_Collection* CH_Collection::getChild ( const char *  name) const
pure virtual

Implemented in OP_Channels.

virtual CH_Collection* CH_Collection::getChild ( const char *  name)
pure virtual

Implemented in OP_Channels.

virtual int CH_Collection::getChildren ( CH_NameList &  names) const
pure virtual

Implemented in OP_Channels.

virtual int CH_Collection::getChildren ( CH_CollectionList &  grps) const
pure virtual

Implemented in OP_Channels.

bool CH_Collection::getCollectionRange ( fpreal &  start,
fpreal &  end,
bool &  timedep,
int  thread 
)
bool CH_Collection::getExpose ( ) const
inline

Definition at line 277 of file CH_Collection.h.

CH_ExprLanguage CH_Collection::getExprLanguage ( ) const
bool CH_Collection::getExternal ( ) const
inline

Definition at line 320 of file CH_Collection.h.

virtual UT_StringHolder CH_Collection::getFullPath ( ) const
pure virtual

Implemented in OP_Channels, and OP_GeometryChannels.

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

Definition at line 184 of file CH_Collection.h.

fpreal CH_Collection::getGlobalEnd ( ) const
inline

Definition at line 291 of file CH_Collection.h.

fpreal CH_Collection::getGlobalStart ( ) const
inline

Definition at line 289 of file CH_Collection.h.

virtual void CH_Collection::getLocalVariables ( UT_StringArray &  out_vars)
virtual
CH_Manager* CH_Collection::getManager ( ) const
inline

Definition at line 104 of file CH_Collection.h.

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

Reimplemented in OP_GeometryChannels, and OP_Channels.

virtual const UT_StringHolder& CH_Collection::getName ( ) const
pure virtual

Implemented in OP_GeometryChannels, and OP_Channels.

virtual const void* CH_Collection::getOwner ( ) const
pure virtual

Implemented in OP_Channels.

virtual void* CH_Collection::getOwner ( )
pure virtual

Implemented in OP_Channels.

virtual const CH_Collection* CH_Collection::getParent ( ) const
pure virtual

Implemented in OP_Channels.

virtual CH_Collection* CH_Collection::getParent ( )
pure virtual

Implemented in OP_Channels.

const CH_Collection* CH_Collection::getRoot ( ) const
protected
fpreal CH_Collection::getTolerance ( ) const
inline

Definition at line 105 of file CH_Collection.h.

virtual int CH_Collection::getUniqueId ( ) const
virtual

Reimplemented in OP_Channels.

virtual bool CH_Collection::getVariableValue ( UT_String &  str,
int  table,
int  index,
int  thread 
)
virtual

Reimplemented in OP_Channels.

virtual bool CH_Collection::getVariableValue ( fpreal &  val,
int  table,
int  index,
int  thread 
)
virtual

Reimplemented in OP_Channels.

virtual void CH_Collection::getXformOrder ( UT_XformOrder &  xord,
const CH_Channel *  chp 
) const
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 = nullptr,
const CH_LoadInfo *  load_info = nullptr,
CH_ChannelList *  loadedChannels = nullptr,
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 
)
protectedvirtual

Reimplemented in OP_Channels.

void CH_Collection::removeParamDependency ( )
virtual int CH_Collection::rename ( const char *  from_name,
const char *  to_name,
const char *  to_alias 
)
virtual
virtual int CH_Collection::rename ( CH_Channel *  from,
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 ( std::ostream &  os,
bool  binary,
bool  compiled,
bool  scoped,
bool  pending_state,
const CH_ChannelList *  channels 
) const
virtual void CH_Collection::saveChannelForUndo ( CH_Channel *  chp)
pure virtual

Save the entire channel for undo.

Implemented in OP_Channels.

virtual void CH_Collection::saveKeyFrameForUndo ( CH_Channel *  chp,
fpreal  gtime 
)
pure virtual

Implemented in OP_Channels, and OP_GeometryChannels.

int CH_Collection::saveToFile ( const char *  nm) const
virtual void CH_Collection::setChanged ( CH_CHANGE_TYPE  how,
void *  data = nullptr 
)
virtual

Reimplemented in OP_Channels, and OP_GeometryChannels.

bool CH_Collection::setChannelAlias ( CH_Channel &  chp,
const UT_StringHolder &  alias 
)
void CH_Collection::setExpose ( bool  onoff)
void CH_Collection::setExprLanguage ( CH_ExprLanguage  language)
void CH_Collection::setExternal ( bool  yesno)
inline

Definition at line 322 of file CH_Collection.h.

CH_Collection::SETUPCLASSPACKETID ( "CH_Collection"  )
void CH_Collection::unresolveLocalVars ( int  thread)
void CH_Collection::updateGlobalVariables ( CH_LocalVariable *  table)
inline

Definition at line 286 of file CH_Collection.h.

Friends And Related Function Documentation

friend class CH_Manager
friend

Definition at line 403 of file CH_Collection.h.

Member Data Documentation

const char* CH_Collection::theValidChannelNameWordBreaks
static

Definition at line 373 of file CH_Collection.h.

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