HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
CH_Manager Class Reference

#include <CH_Manager.h>

+ Inheritance diagram for CH_Manager:

Public Types

enum  CollisionBehaviour { CH_ON_COLLISION_RENAME, CH_ON_COLLISION_MERGE, CH_ON_COLLISION_REPLACE, CH_ON_COLLISION_ASSERT }
 
enum  ExpansionType {
  CH_EXPANSION_TYPE_EXPRESSION = 1, CH_EXPANSION_TYPE_VARIABLE = 1 << 1, CH_EXPANSION_TYPE_TILDE = 1 << 2, CH_EXPANSION_TYPE_NO_COMMENTS = 1 << 3,
  CH_EXPANSION_TYPE_NO_RAWSTRINGS = 1 << 4, CH_EXPANSION_TYPE_DEFAULT
}
 
enum  SlopeMode { CH_SLOPE_MANUAL, CH_SLOPE_MANUAL_KEEP, CH_SLOPE_AUTOMATIC }
 
typedef CollisionBehaviour(* CBCallback )(CH_Group *source, CH_Group *target)
 

Public Member Functions

 CH_Manager (bool init_the_expression_library=true)
 
virtual ~CH_Manager ()
 
virtual void setContext ()
 
int condenseCommon (UT_String &path)
 
void resetPlayback ()
 
void resetChannelOptions (bool notify=true)
 
bool loadChannelOptions (const char *filename)
 
bool saveChannelOptions (const char *filename)
 
void setDefaultExpression (const char *s, bool notify=false)
 
const char * getDefaultExpression () const
 
bool shouldShowFakeAccelHandles () const
 
void setDefaultRotationExpression (const char *s)
 
const char * getDefaultRotationExpression () const
 
void setAutoSlope (SlopeMode m)
 
SlopeMode getAutoSlope () const
 
void setDefaultSlope (fpreal slope)
 
fpreal getDefaultSlope () const
 
void setAutoSplit (bool onoff)
 
bool getAutoSplit () const
 
void setDefaultSplitExpression (const char *expr)
 
const char * getDefaultSplitExpression () const
 
void setHoldLastKey (bool onoff)
 
int getHoldLastKey () const
 
const char * getChanCreateKeyExpression () const
 
void setChanCreateKeyExpression (const char *s)
 
bool getAlwaysCommitKeyChange () const
 
void setAlwaysCommitKeyChange (bool onoff)
 
void clearChannelScope ()
 
void getScopedChannels (CH_ChannelList &channels, bool sorted=false)
 
int getNumScopedChanRefs ()
 
void getScopedChanRefs (CH_ChannelRefList &chanrefs, unsigned mask=0, bool sorted=false) const
 
void getSelectedScopedChanRefs (CH_ChannelRefList &chanrefs, bool sorted=false, int operate_on=CH_SELECTED)
 
void getScopedChannelsKeyFrames (UT_IntArray &frames, int minframe, int maxframe)
 
void blockModifyScope (int on_off)
 
void scopeChannel (const CH_ChannelRef &chref, bool on_off)
 
void scopeChannel (const char *full_chan_path, bool on_off)
 
bool scopeChannelInternal (const CH_Channel *chp, bool on_off)
 
bool scopeChannelInternal (const CH_ChannelRef &chref, bool on_off)
 
virtual void getChannelsWithNodeId (CH_ChannelList &chans, int node_id) const
 
void scopeChanged (unsigned flags, bool propagate=true)
 
bool isChannelScoped (CH_Channel *chp) const
 
bool isChannelScoped (const char *full_chan_path) const
 
bool isChannelScoped (const CH_ChannelRef &chref) const
 
void clearPendingChannels ()
 
void getPendingChannels (CH_ChannelList &channels) const
 
bool hasPendingChannels () const
 
void addPendingChannel (CH_Channel *chp)
 
void removePendingChannel (CH_Channel *chp)
 
bool isChannelDisplayed (CH_Channel *chp) const
 
bool isChannelDisplayed (const CH_ChannelRef &chref) const
 
bool isChannelDisplayed (const char *full_chan_path) const
 
void clearDisplayedChannels (bool propagate=true)
 
void displayAllScopedChannels (bool propagate=true)
 
void displaySelectedScopedChannels (bool propagate=true)
 
void displayChannel (const CH_ChannelRef &chref, bool propagate=true)
 
void displayChannel (const char *full_chan_path, bool propagate=true)
 
void undisplayChannel (const CH_ChannelRef &chref, bool propagate=true)
 
void undisplayChannel (const char *full_chan_path, bool propagate=true)
 
bool isChannelSelected (const CH_ChannelRef &chref) const
 
bool isChannelSelected (const char *full_chan_path) const
 
void clearSelectedChannels (bool propagate=true)
 
void selectAllScopedChannels (bool propagate=true)
 
void selectChannel (const CH_ChannelRef &chref, bool propagate=true)
 
void selectChannel (const char *full_chan_path, bool propagate=true)
 
void deselectChannel (const CH_ChannelRef &chref, bool propagate=true)
 
void deselectChannel (const char *full_chan_path, bool propagate=true)
 
void togglePinAllScopedChannels ()
 
void togglePinScopedChannels (const CH_ChannelRefList &chanrefs)
 
void pinAllScopedChannels (bool propagate=true)
 
void unpinAllScopedChannels (bool propagate=true)
 
void pinSelectedChannels (bool propagate=true, int operate_on=CH_SELECTED)
 
void unpinSelectedChannels (bool propagate=true, int operate_on=CH_SELECTED)
 
void pinChannels (const CH_ChannelRefList &chanrefs, bool propagate=true)
 
void unpinChannels (const CH_ChannelRefList &chanrefs, bool propagate=true)
 
void clearLayerScope ()
 
bool isLayerScoped (CH_Channel *chp) const
 
bool isLayerScoped (const char *full_chan_path) const
 
bool isLayerScoped (const CH_ChannelRef &chref) const
 
void scopeLayer (const CH_ChannelRef &chref, bool on_off)
 
void scopeLayer (const char *full_chan_path, bool on_off)
 
bool scopeLayerInternal (CH_Channel *chp, bool on_off)
 
bool scopeLayerInternal (const CH_ChannelRef &chref, bool on_off)
 
bool isLayerSelected (const CH_ChannelRef &chref) const
 
bool isLayerSelected (const char *full_chan_path) const
 
void clearSelectedLayers (bool propagate=true)
 
void selectAllScopedLayers (bool propagate=true)
 
void selectLayer (const CH_ChannelRef &chref, bool propagate=true)
 
void selectLayer (const char *full_chan_path, bool propagate=true)
 
void deselectLayer (const CH_ChannelRef &chref, bool propagate=true)
 
void deselectLayer (const char *full_chan_path, bool propagate=true)
 
void togglePinAllScopedLayers ()
 
void togglePinScopedLayers (const CH_ChannelRefList &chanrefs)
 
void pinAllScopedLayers (bool propagate=true)
 
void unpinAllScopedLayers (bool propagate=true)
 
void pinSelectedLayers (bool propagate=true, int operate_on=CH_LAYER_SELECTED)
 
void unpinSelectedLayers (bool propagate=true, int operate_on=CH_LAYER_SELECTED)
 
void pinLayers (const CH_ChannelRefList &chanrefs, bool propagate=true)
 
void unpinLayers (const CH_ChannelRefList &chanrefs, bool propagate=true)
 
bool isLayerDisplayed (CH_Channel *chp) const
 
bool isLayerDisplayed (const CH_ChannelRef &chref) const
 
bool isLayerDisplayed (const char *full_chan_path) const
 
void clearDisplayedLayers (bool propagate=true)
 
void displayAllScopedLayers (bool propagate=true)
 
void displaySelectedScopedLayers (bool propagate=true)
 
void displayLayer (const CH_ChannelRef &chref, bool propagate=true)
 
void displayLayer (const char *full_chan_path, bool propagate=true)
 
void undisplayLayer (const CH_ChannelRef &chref, bool propagate=true)
 
void undisplayLayer (const char *full_chan_path, bool propagate=true)
 
void setChannelFlags (const CH_ChannelRef &chref, unsigned flags, bool on_off, bool propagate=true)
 
unsigned getChannelFlags (const CH_ChannelRef &chref) const
 
int expandString (const char *string, UT_String &expanded, fpreal time, CH_Collection *local=nullptr, int thread=0, int expansion_type=CH_EXPANSION_TYPE_DEFAULT, const DEP_ContextOptionsStack *context_options_stack=nullptr, DEP_ContextOptionsReadHandle context_options=DEP_ContextOptionsReadHandle())
 
void buildStringOpDependencies (const char *str, void *ref_id, CH_Collection *locals, int thread)
 
bool scanForVariableInString (const char *variable, const char *string) const
 
bool changeStringOpRef (UT_String &str, const char *new_fullpath, const char *old_fullpath, const char *old_cwd, const char *chan_name, const char *old_chan_name, CH_Collection *locals, int thread)
 
fpreal evaluate (const char *expr, fpreal now, CH_Collection *local=nullptr, int *frame_dep=nullptr, int thread=0, CH_ExprLanguage language=CH_OLD_EXPR_LANGUAGE, const DEP_ContextOptionsStack *context_options_stack=nullptr, DEP_ContextOptionsReadHandle context_options=DEP_ContextOptionsReadHandle())
 
int evaluateString (const char *expr, UT_String &result, fpreal now, CH_Collection *local=nullptr, int thread=0, CH_ExprLanguage language=CH_OLD_EXPR_LANGUAGE, const DEP_ContextOptionsStack *context_options_stack=nullptr, DEP_ContextOptionsReadHandle context_options=DEP_ContextOptionsReadHandle())
 
bool getIsSettingGlobalParam () const
 
void getGlobalParamF (const char *token, CH_Collection *scope, fpreal &result, fpreal def, int thread, bool add_dependencies)
 
void getGlobalParamS (const char *token, CH_Collection *scope, UT_String &result, const char *def, int thread, bool add_dependencies)
 
void getGlobalParamAnyScopeF (const char *token, CH_Collection *scope, fpreal &result, fpreal def, int thread, bool add_dependencies)
 
void getGlobalParamAnyScopeS (const char *token, CH_Collection *scope, UT_String &result, const char *def, int thread, bool add_dependencies)
 
int setGlobalFloatParam (const char *token, fpreal val, CH_Collection *&owner)
 
int setGlobalStringParam (const char *token, const char *strval, CH_Collection *&owner)
 
int removeGlobalParamOwner (CH_Collection *owner)
 
void dumpGlobalParams (std::ostream &out) const
 
void dirtyOrphanGlobalParamDependents (const char *token, CH_Collection *scope, bool recurse, UT_Set< CH_Collection * > *dependents)
 
bool getIsSettingGuideParam () const
 
CH_GroupgetTopGroup () const
 
CH_GroupfindGroup (const char *const_path, bool create=false, CH_Group *head=nullptr)
 
void findGroups (CH_GroupList &groups, const char *pattern, bool minimal)
 
void findChannelsFromGroups (CH_ChannelList &channels, const char *pattern)
 
void findChanRefsFromGroups (CH_ChannelRefList &chanrefs, const char *pattern)
 
CH_GroupList getSelectedGroups ()
 
CH_GroupgetCurrentGroup ()
 
void updateGroupSelection (const CH_GroupList &groups, void *by, bool propagate=true)
 
void updateGroupSelectionFromScoped (void *by, bool propagate=true)
 
void updateCurrentGroup (CH_Group *group, void *by, bool propagate=true)
 
void enforceLeafOnlyChannels (CH_Group *group, const char *name="new_group")
 
CH_GroupcreateGroup (const char *const_path, bool do_rename=true, CH_Group *head=nullptr)
 
void renameGroup (CH_Group *group, const char *newname)
 
void deleteGroup (CH_Group *group)
 
void extractGroup (CH_Group *group, CollisionBehaviour cb)
 
CH_GroupcollapseGroups (CH_GroupList const &groups, const char *name)
 
void collapseChildren (CH_Group *parent)
 
void copyIntoGroup (CH_Group *source, CH_Group *target, CollisionBehaviour cb, const char *new_name=nullptr)
 
void moveIntoGroup (CH_Group *source, CH_Group *target, CollisionBehaviour cb, const char *new_name=nullptr)
 
void addToGroup (CH_Group *source, CH_Group *target, CollisionBehaviour cb)
 
void mergeWithGroup (CH_Group *source, CH_Group *target, CollisionBehaviour cb)
 
void channelCreated (const CH_Channel *chp)
 
void channelDeleted (const CH_Channel *chp)
 
void saveGroup (CH_Group *g, std::ostream &os, int binary)
 
CH_GrouploadGroup (UT_IStream &is)
 
bool saveBookmarks (UT_JSONWriter &w, bool include_temporary=false)
 
bool saveBookmarks (UT_JSONWriter &w, const UT_Array< CH_Bookmark * > &bookmarks)
 
bool loadBookmarks (UT_JSONParser &w, bool remove_existing=true)
 
CH_ExprLanguage getDefaultExprLanguage ()
 
void setDefaultExprLanguage (CH_ExprLanguage language)
 
bool isGlobalScopedChannels (CH_ScopedChannelsBase *p)
 
CH_ScopedChannelsgetGlobalScopedChannels ()
 
const CH_ScopedChannelsgetGlobalScopedChannels () const
 
bool hasExternalCollection (const CH_Collection *collection) const
 
void scopeExternalCollection (CH_Collection *collection, bool on_off=true)
 
CH_CollectiongetExternalCollection (const UT_StringHolder &name) const
 
CH_ChannelgetExternalChannel (const char *collection, const char *name) const
 Returns an external channel given a collection and a channel name. More...
 
CH_ChannelfindExternalChannel (const UT_StringHolder &path)
 
*to get _Base exint globExternalChannels (const UT_StringHolder &pattern, CH_ChannelList &chans)
 
const UT_StringMap
< UT_UniquePtr< CH_Collection > > & 
getExternalCollections () const
 
void timeGroupsChanged ()
 
void addTimeGroup (CH_TimeGroup *group, bool do_rename=true, bool force=false)
 
void destroyTimeGroup (const CH_TimeGroup *group)
 
void destroyTimeGroup (int i)
 
void renameTimeGroup (CH_TimeGroup *group, const char *newname, bool force=false)
 
int getNTimeGroups () const
 
CH_TimeGroupgetTimeGroup (int i)
 
const CH_TimeGroupgetTimeGroup (int i) const
 
CH_TimeGroupgetTimeGroup (const char *name)
 
const CH_TimeGroupgetTimeGroup (const char *name) const
 
int getTimeGroupIdx (const char *name) const
 
void bookmarksChanged (CH_BookmarkEvent action, int64 bookmark_id)
 
DEP_MicroNodegetBookmarksMicroNode ()
 
int addBookmark (UT_UniquePtr< CH_Bookmark > &&bookmark, bool create=true)
 
int sortBookmark (CH_Bookmark *bookmark, bool notify=true)
 
void destroyBookmark (int index, bool create_undo=true, bool notify=true)
 
void destroyBookmarks (const UT_Array< CH_Bookmark * > &bookmarks, bool create_undo=true, bool notify=true)
 
void destroyBookmark (CH_Bookmark *bookmark, bool create_undo=true, bool notify=true)
 
void frameBookmark (int index, bool store_previous_range=true)
 
void frameBookmark (CH_Bookmark *bookmark, bool store_previous_range=true)
 
void clearBookmarks ()
 
CH_BookmarkgetMostRecentBookmark () const
 
CH_BookmarkgetLeastRecentBookmark () const
 
void setMostRecentBookmark (CH_Bookmark *bookmark)
 
void setLeastRecentBookmark (CH_Bookmark *bookmark)
 
CH_BookmarkgetFramedBookmark () const
 
int getFramedBookmarkIndex () const
 
int getNBookmarks () const
 
int getBookmarkIndex (CH_Bookmark *bookmark)
 
CH_BookmarkgetBookmark (int i)
 
const CH_BookmarkgetBookmark (int i) const
 
CH_BookmarkgetBookmarkBySessionId (int64 bookmark_id) const
 
UT_Array< CH_Bookmark * > getBookmarksBySessionIds (const UT_Array< int64 > &ids) const
 
const UT_Array< exint > & getBookmarksOrderByRecentUsage ()
 
int niceFrameSeparation (fpreal initial_sep, int minimum_sep=1) const
 
void stretchCollections (CH_Collection *from, fpreal ostart, fpreal oend)
 
void preserveCollectionKeyframes (CH_Collection *grp, fpreal old_fps)
 
void shiftCollections (CH_Collection *grp, fpreal time_delta)
 Shifts all collections by the given time_delta. More...
 
fpreal getNumSamples () const
 
void setRawNumSamples (int n, bool notify=true)
 
fpreal getSamplesPerSec () const
 
void setSamplesPerSec (fpreal fps, bool notify=true)
 
fpreal getSecsPerSample () const
 
void setRawSamplesPerSec (fpreal fps, bool notify=true)
 
int getChopMotionSamples () const
 
void setChopMotionSamples (int n, bool notify=true)
 
fpreal getGlobalStart () const
 
fpreal getGlobalEnd () const
 
int getGlobalStartFrame () const
 
int getGlobalEndFrame () const
 
void setGlobalTime (fpreal start, fpreal end, bool notify=true)
 
void setGlobalStart (fpreal start, bool notify=true)
 
void setRawInterpolation (int state)
 
int getRawInterpolation ()
 
fpreal getTolerance () const
 
fpreal getFrameTolerance () const
 
fpreal getTime (fpreal sample) const
 
fpreal getSampleRaw (fpreal t) const
 
fpreal getSample (fpreal t) const
 
int getFrame (fpreal t) const
 
fpreal getTimeDelta (fpreal sample_delta) const
 
fpreal getSampleDelta (fpreal time_delta) const
 
fpreal getSnapToFrameTime (fpreal t) const
 
fpreal getSnapToSubframeTime (fpreal t) const
 
fpreal getSnapSample (fpreal frame) const
 
fpreal getSnapSubsample (fpreal frame) const
 
fpreal getSnapToFrameDelta (fpreal base_time, fpreal time_delta) const
 
bool getIsAtFrame (fpreal t) const
 
void getTimeCode (char *buf, fpreal t)
 
int setTimeCode (const char *buf, fpreal &t)
 
void setTimeCodeOffset (fpreal t)
 
fpreal getTimeCodeOffset (fpreal) const
 
int getIntegerFrameFlag () const
 
void setIntegerFrameFlag (int flag, bool notify=true)
 
int getRestrictRangeFlag () const
 
void setRestrictRangeFlag (int flag, bool notify=true)
 
int getShowRangeFlag () const
 
void setShowRangeFlag (int flag, bool notify=true)
 
int getShowTicksFlag () const
 
void setShowTicksFlag (int flag, bool notify=true)
 
int getShowAudioFlag () const
 
void setShowAudioFlag (int flag, bool notify=true)
 
int getShowKeysFlag () const
 
void setShowKeysFlag (int flag, bool notify=true)
 
int getShowBookmarksFlag () const
 
void setShowBookmarksFlag (int flag, bool notify=true)
 
int getShowSimCacheFlag () const
 
void setShowSimCacheFlag (int flag, bool notify=true)
 
int getShowAnimBarFlag () const
 
void setShowAnimBarFlag (int flag, bool notify=true)
 
fpreal getAudioLevel () const
 
void setAudioLevel (fpreal lvl)
 
fpreal getUnitLength () const
 
void setUnitLength (fpreal unitlength)
 
fpreal getUnitMass () const
 
void setUnitMass (fpreal unitmass)
 
void parseUnitsString (const char *units, fpreal &distexp, fpreal &massexp) const
 
fpreal scaleToMKS (const char *fromunits) const
 
fpreal scaleFromMKS (const char *tounits) const
 
int getRealTimeFlag () const
 
void setRealTimeFlag (int flag, bool notify=true)
 
fpreal getRealTimeFactor () const
 
void setRealTimeFactor (fpreal f, bool notify=true)
 
bool getRealTimeDisableSkip () const
 
void setRealTimeDisableSkip (bool b, bool notify=true)
 
fpreal getSampleStep () const
 
void setSampleStep (fpreal s, bool notify=true)
 
void getSampleRange (fpreal &start, fpreal &end)
 
void setSampleRange (fpreal start, fpreal end, bool notify=true)
 
int getHoldFlag () const
 
void setHoldFlag (int flag)
 
int saveChannels (const char *filename, bool binary, bool compiled, const CH_ChannelList &channels, bool displayed=false) const
 
int loadChannels (const char *filename, const char *src_pattern, const char *dest_pattern, bool use_range, const fpreal *tstart, const fpreal *tend, CH_CollectionList &parents, bool delete_keys=false, CH_ChannelRefList *displayed_parms=nullptr)
 
void addExpressionDefine (CH_ExprDefine *def)
 
void setEvalCollection (CH_Collection *g, int thread)
 
CH_CollectiongetEvalCollection (int thread) const
 
void setRootCollection (CH_Collection *root)
 
CH_CollectiongetRootCollection () const
 
virtual CH_ScriptAccessManager * getAccessManager (int)
 
const CH_EvalContextevalContext (int thread) const
 
CH_EvalContextevalContext (int thread)
 
const CH_ChannelgetEvalChannel (int thread) const
 
const CH_SegmentgetEvalSegment (int thread) const
 
const char * getEvalChannelName (int thread) const
 
const DEP_ContextOptionsStackgetEvalChannelContextOptionsStack (int thread) const
 
DEP_ContextOptionsReadHandle getEvalChannelContextOptions (int thread) const
 
fpreal getEvaluateTime () const
 
CH_LocalVariablegetLocalVariableTable () const
 
bool getVariableValue (UT_String &str, int i, int thread) const
 
bool getVariableValue (fpreal &val, int i, int thread) const
 
bool getVariableValue (int &val, int i, int thread) const
 
virtual bool getVariableString (const char *name, UT_String &value, int &time_depend, int thread)
 
int addVariable (const CH_LocalVariable &var, CH_StringVarEvalFunc strfunc, CH_FloatVarEvalFunc floatfunc, CH_IntVarEvalFunc intfunc) const
 
void removeParamDependency (CH_Collection *coll)
 
virtual CH_ChannelgetChRefChannel (const CH_ChannelRef &r) const
 
virtual bool isOwnerExposed (const CH_ChannelRef &r) const
 
virtual bool buildChanRef (CH_ChannelRef &r, const CH_Channel *chp) const
 Use this method to build a channel reference from a channel pointer. More...
 
virtual bool buildChanRef (CH_ChannelRef &r, const char *path) const
 Use this method to build a channel reference from a channel path. More...
 
bool buildChannelRefs (CH_ChannelRefList &reflist, const CH_ChannelList &chlist)
 
bool buildChannelRefs (CH_ChannelRefList &reflist, const UT_StringArray &chlist)
 
virtual int compareChanRefs (const CH_ChannelRef &r1, const CH_ChannelRef &r2) const
 
virtual int compareLayerRefs (const CH_ChannelRef &r1, const CH_ChannelRef &r2) const
 
virtual void getChanRefPath (const CH_ChannelRef &r, UT_String &path, bool use_alias=false) const
 Use this method to get the full path of the channel referenced by r. More...
 
virtual bool isChanRefValid (const CH_ChannelRef &chref) const
 
void changeReferencesToNodeId (int old_id, int new_id)
 
void removeReferencesToNodeId (int node_id)
 
void displayScope () const
 
virtual bool resolveChanRefExport (const CH_ChannelRef &r, CH_ChannelRef &out_export)
 
bool getAutoKeyTuples () const
 Auto-Key all Tuples is a preference to key tuples together. More...
 
void setAutoKeyTuples (bool b)
 
bool getAutoScopeOnChannelCreate () const
 
void setAutoScopeOnChannelCreate (bool b)
 
bool getAutoScopeIncludeAnimated () const
 
void setAutoScopeIncludeAnimated (bool b)
 
bool getFollowScopedChannelReferences () const
 
void setFollowScopedChannelReferences (bool b)
 
fpreal evalBezierFunc (int thread)
 
fpreal evalConstantFunc (int thread)
 
fpreal evalCubicFunc (int thread)
 
fpreal evalCycleFunc (fpreal start_frame, fpreal end_frame, int thread)
 
fpreal evalCycletFunc (fpreal start_frame, fpreal end_frame, int thread)
 
fpreal evalCycleOffsetFunc (fpreal start_frame, fpreal end_frame, int thread)
 
fpreal evalCycleOffsettFunc (fpreal start_frame, fpreal end_frame, int thread)
 
fpreal evalEaseFunc (int thread)
 
fpreal evalEaseinFunc (int thread)
 
fpreal evalEaseinpFunc (fpreal ease_speed, int thread)
 
fpreal evalEaseoutFunc (int thread)
 
fpreal evalEaseoutpFunc (fpreal ease_speed, int thread)
 
fpreal evalEasepFunc (fpreal ease_speed, int thread)
 
fpreal evalLinearFunc (int thread)
 
fpreal evalMatchFunc (int thread)
 
fpreal evalMatchinFunc (int thread)
 
fpreal evalMatchoutFunc (int thread)
 
fpreal evalQcubicFunc (int thread)
 
fpreal evalQlinearFunc (int thread)
 
fpreal evalQuinticFunc (int thread)
 
fpreal evalRepeatFunc (fpreal start_frame, fpreal end_frame, int thread)
 
fpreal evalRepeattFunc (fpreal start_frame, fpreal end_frame, int thread)
 
fpreal evalSplineFunc (int thread)
 
fpreal evalVmatchFunc (int thread)
 
fpreal evalVmatchinFunc (int thread)
 
fpreal evalVmatchoutFunc (int thread)
 
bool getAutoScopeIncludeChild () const
 
void setAutoScopeIncludeChild (bool b)
 
bool getAutoScopeIncludeConstraints () const
 
void setAutoScopeIncludeConstraints (bool b)
 
DEP_ContextOptionsHandle getDefaultContextOptions () const
 
DEP_MicroNodegetDefaultContextOptionMicroNode (const UT_StringHolder &opt)
 
void setDefaultContextOption (const UT_StringHolder &opt, const UT_StringHolder &value, bool create_undo)
 
void setDefaultContextOption (const UT_StringHolder &opt, fpreal64 value, bool create_undo)
 
const UT_StringHoldergetDefaultContextOptionUiConfig (const UT_StringHolder &opt) const
 
void setDefaultContextOptionUiConfig (const UT_StringHolder &opt, const UT_StringHolder &ui_config)
 
void removeDefaultContextOption (const UT_StringHolder &opt, bool create_undo)
 
void clearDefaultContextOptions (bool create_undo)
 
bool saveDefaultContextOptions (std::ostream &os) const
 
bool loadDefaultContextOptions (UT_IStream &is)
 
int addDefaultContextOptionCallback (CH_DefaultContextOptionCallback cb)
 
void removeDefaultContextOptionCallback (int id)
 
bool isAutomaticContextOption (const UT_StringHolder &opt) const
 
bool isAutomaticContextOptionOverridden (const UT_StringHolder &opt) const
 
void pushRopCookContextOptions ()
 
void pushRopCookContextOptions (bool ropcook, fpreal fstart, fpreal fend, fpreal finc, const UT_StringHolder &ropname, const UT_StringHolder &roppath)
 
void resetRopCookContextOptions ()
 
void updateRopCookContextOptions (bool ropcook, fpreal fstart, fpreal fend, fpreal finc, const UT_StringHolder &ropname, const UT_StringHolder &roppath)
 
void popRopCookContextOptions ()
 
void setChannelColorManager (CH_ChannelColorManager *mgr)
 
CH_ChannelColorManagerchannelColorManager ()
 
void setChannelChanged (CH_ChannelChanged *mgr)
 
CH_ChannelChangedgetChannelChanged ()
 
void triggerChannelChanged ()
 
CH_TweenergetChannelTweener ()
 
virtual bool getChannelAutoSelect (const CH_ChannelRef &chref) const
 
virtual bool getChRefLabelForUI (const CH_ChannelRef &r, UT_String &ret) const
 
virtual bool getChRefAlias (const CH_ChannelRef &r, UT_String &ret) const
 
virtual bool getChRefNodePath (const CH_ChannelRef &r, UT_String &ret) const
 
bool getIgnoreUpdateScopeFlag () const
 
void setIgnoreUpdateScopeFlag (bool onoff)
 
virtual void beginChannelChanges ()
 
virtual void channelsChanged ()
 
virtual void endChannelChanges ()
 
virtual bool channelsBeingChanged ()
 
fpreal getEvaluateTime (int thread) const
 Functions for obtaining and setting the current evaluation time. More...
 
void setEvaluateTime (fpreal time, int thread)
 Functions for obtaining and setting the current evaluation time. More...
 
void setEvaluateTime (SYS_Flicks fl, int thread)
 Functions for obtaining and setting the current evaluation time. More...
 

Static Public Member Functions

static CH_ManagergetContext ()
 
static bool getContextExists ()
 
static void evaluationError (int err, int thread, const char *path)
 
static CH_KeyState getKeyState (fpreal gtime, const CH_ChannelList &channels, bool loose=false)
 
static bool makeGroupPathValid (UT_String &path)
 
static bool makeGroupNameValid (UT_String &path)
 
static bool couldExpandString (const char *str)
 
static fpreal niceNumber (fpreal num, int digits=6)
 
static fpreal getDefaultFPS ()
 
static fpreal getDefaultLength (fpreal fps)
 
static fpreal getDefaultLengthFrames (fpreal fps)
 
static int getDefaultChopMotionSamples ()
 
static bool readCHNFileHeader (UT_IStream &is, bool quiet, fpreal32 &version, int &binary, bool &is_fp64, fpreal64 &tstart, fpreal64 &tend)
 
static bool skipCHNFileHeaderForCollection (UT_IStream &is, bool &is_fp64)
 
static bool getFileType (const char *filename, int &raw, int &binary)
 
static bool printFileInfo (std::ostream &os, const char *filename, CH_Collection *load_coll, bool print_segments=true)
 
static void lookupVariable (const char *name, UT_String &val, int thread)
 
static void lookupVariableNoThread (const char *name, UT_String &val)
 
static void lookupExpression (const char *name, UT_String &val, int thread)
 
static void lookupExpressionNoThread (const char *name, UT_String &val)
 
static int getSimpleSegmentTypeFromExpression (const char *expr)
 

Public Attributes

*to get everything
 

Static Public Attributes

static constexpr int CH_SCOPE_REPLACED = 0
 
static constexpr int CH_SCOPE_FILTERED = 1
 

Protected Member Functions

void setTolerance (fpreal tol)
 
void initExpressionLibrary ()
 
void initLibraryGlue ()
 
CH_CollectionaddExternalCollection (UT_UniquePtr< CH_Collection > &&collection)
 
void destroyExternalCollection (const UT_StringHolder &name)
 

Friends

class CH_SetGlobalParamScope
 
class CH_SetGuideParamScope
 
class CH_UndoScopeChannels
 
class CH_ScopeUndo
 

Detailed Description

Examples:
SOP/SOP_SParticle.C.

Definition at line 490 of file CH_Manager.h.

Member Typedef Documentation

typedef CollisionBehaviour(* CH_Manager::CBCallback)(CH_Group *source, CH_Group *target)

Definition at line 521 of file CH_Manager.h.

Member Enumeration Documentation

Enumerator
CH_ON_COLLISION_RENAME 
CH_ON_COLLISION_MERGE 
CH_ON_COLLISION_REPLACE 
CH_ON_COLLISION_ASSERT 

Definition at line 493 of file CH_Manager.h.

Enumerator
CH_EXPANSION_TYPE_EXPRESSION 
CH_EXPANSION_TYPE_VARIABLE 
CH_EXPANSION_TYPE_TILDE 
CH_EXPANSION_TYPE_NO_COMMENTS 
CH_EXPANSION_TYPE_NO_RAWSTRINGS 
CH_EXPANSION_TYPE_DEFAULT 

Definition at line 501 of file CH_Manager.h.

Enumerator
CH_SLOPE_MANUAL 
CH_SLOPE_MANUAL_KEEP 
CH_SLOPE_AUTOMATIC 

Definition at line 512 of file CH_Manager.h.

Constructor & Destructor Documentation

CH_Manager::CH_Manager ( bool  init_the_expression_library = true)
virtual CH_Manager::~CH_Manager ( )
virtual

Member Function Documentation

int CH_Manager::addBookmark ( UT_UniquePtr< CH_Bookmark > &&  bookmark,
bool  create = true 
)

Add a new bookmark, returning the index at which it was added If create is true, creates an undo block. This should only be set to

int CH_Manager::addDefaultContextOptionCallback ( CH_DefaultContextOptionCallback  cb)
void CH_Manager::addExpressionDefine ( CH_ExprDefine def)
CH_Collection* CH_Manager::addExternalCollection ( UT_UniquePtr< CH_Collection > &&  collection)
protected

Add and take ownership of an external channel collection, such as geometry channels passed in by the MOT_GeometryChannelsManager Returns a pointer to the added collection. Should only be called by the OP_CommandManager

void CH_Manager::addPendingChannel ( CH_Channel chp)
void CH_Manager::addTimeGroup ( CH_TimeGroup group,
bool  do_rename = true,
bool  force = false 
)
void CH_Manager::addToGroup ( CH_Group source,
CH_Group target,
CollisionBehaviour  cb 
)
int CH_Manager::addVariable ( const CH_LocalVariable var,
CH_StringVarEvalFunc  strfunc,
CH_FloatVarEvalFunc  floatfunc,
CH_IntVarEvalFunc  intfunc 
) const
Examples:
expr/globalvar.C.
virtual void CH_Manager::beginChannelChanges ( )
inlinevirtual

Reimplemented in OP_CommandManager.

Definition at line 1732 of file CH_Manager.h.

void CH_Manager::blockModifyScope ( int  on_off)
void CH_Manager::bookmarksChanged ( CH_BookmarkEvent  action,
int64  bookmark_id 
)
bool CH_Manager::buildChannelRefs ( CH_ChannelRefList reflist,
const CH_ChannelList chlist 
)
bool CH_Manager::buildChannelRefs ( CH_ChannelRefList reflist,
const UT_StringArray chlist 
)
virtual bool CH_Manager::buildChanRef ( CH_ChannelRef r,
const CH_Channel chp 
) const
virtual

Use this method to build a channel reference from a channel pointer.

Reimplemented in OP_CommandManager.

virtual bool CH_Manager::buildChanRef ( CH_ChannelRef r,
const char *  path 
) const
virtual

Use this method to build a channel reference from a channel path.

Reimplemented in OP_CommandManager.

void CH_Manager::buildStringOpDependencies ( const char *  str,
void ref_id,
CH_Collection locals,
int  thread 
)
void CH_Manager::changeReferencesToNodeId ( int  old_id,
int  new_id 
)
bool CH_Manager::changeStringOpRef ( UT_String str,
const char *  new_fullpath,
const char *  old_fullpath,
const char *  old_cwd,
const char *  chan_name,
const char *  old_chan_name,
CH_Collection locals,
int  thread 
)
CH_ChannelColorManager* CH_Manager::channelColorManager ( )
void CH_Manager::channelCreated ( const CH_Channel chp)
void CH_Manager::channelDeleted ( const CH_Channel chp)
virtual bool CH_Manager::channelsBeingChanged ( )
inlinevirtual

Reimplemented in OP_CommandManager.

Definition at line 1735 of file CH_Manager.h.

virtual void CH_Manager::channelsChanged ( )
inlinevirtual

Reimplemented in OP_CommandManager.

Definition at line 1733 of file CH_Manager.h.

void CH_Manager::clearBookmarks ( )
void CH_Manager::clearChannelScope ( )
void CH_Manager::clearDefaultContextOptions ( bool  create_undo)
void CH_Manager::clearDisplayedChannels ( bool  propagate = true)
void CH_Manager::clearDisplayedLayers ( bool  propagate = true)
void CH_Manager::clearLayerScope ( )
void CH_Manager::clearPendingChannels ( )
void CH_Manager::clearSelectedChannels ( bool  propagate = true)
void CH_Manager::clearSelectedLayers ( bool  propagate = true)
void CH_Manager::collapseChildren ( CH_Group parent)
CH_Group* CH_Manager::collapseGroups ( CH_GroupList const &  groups,
const char *  name 
)
virtual int CH_Manager::compareChanRefs ( const CH_ChannelRef r1,
const CH_ChannelRef r2 
) const
virtual

Returns 0 if r1 and r2 are equal, returns -1 if r1 < r2 and returns 1 if r1 > r2.

Reimplemented in OP_CommandManager.

virtual int CH_Manager::compareLayerRefs ( const CH_ChannelRef r1,
const CH_ChannelRef r2 
) const
virtual

Returns 0 if r1 and r2 are equal, returns -1 if r1 < r2 and returns 1 if r1 > r2.

Reimplemented in OP_CommandManager.

int CH_Manager::condenseCommon ( UT_String path)
void CH_Manager::copyIntoGroup ( CH_Group source,
CH_Group target,
CollisionBehaviour  cb,
const char *  new_name = nullptr 
)
static bool CH_Manager::couldExpandString ( const char *  str)
static
CH_Group* CH_Manager::createGroup ( const char *  const_path,
bool  do_rename = true,
CH_Group head = nullptr 
)
void CH_Manager::deleteGroup ( CH_Group group)
void CH_Manager::deselectChannel ( const CH_ChannelRef chref,
bool  propagate = true 
)
void CH_Manager::deselectChannel ( const char *  full_chan_path,
bool  propagate = true 
)
void CH_Manager::deselectLayer ( const CH_ChannelRef chref,
bool  propagate = true 
)
void CH_Manager::deselectLayer ( const char *  full_chan_path,
bool  propagate = true 
)
void CH_Manager::destroyBookmark ( int  index,
bool  create_undo = true,
bool  notify = true 
)
void CH_Manager::destroyBookmark ( CH_Bookmark bookmark,
bool  create_undo = true,
bool  notify = true 
)
void CH_Manager::destroyBookmarks ( const UT_Array< CH_Bookmark * > &  bookmarks,
bool  create_undo = true,
bool  notify = true 
)
void CH_Manager::destroyExternalCollection ( const UT_StringHolder name)
protected
void CH_Manager::destroyTimeGroup ( const CH_TimeGroup group)
void CH_Manager::destroyTimeGroup ( int  i)
void CH_Manager::dirtyOrphanGlobalParamDependents ( const char *  token,
CH_Collection scope,
bool  recurse,
UT_Set< CH_Collection * > *  dependents 
)
void CH_Manager::displayAllScopedChannels ( bool  propagate = true)
void CH_Manager::displayAllScopedLayers ( bool  propagate = true)
void CH_Manager::displayChannel ( const CH_ChannelRef chref,
bool  propagate = true 
)
void CH_Manager::displayChannel ( const char *  full_chan_path,
bool  propagate = true 
)
void CH_Manager::displayLayer ( const CH_ChannelRef chref,
bool  propagate = true 
)
void CH_Manager::displayLayer ( const char *  full_chan_path,
bool  propagate = true 
)
void CH_Manager::displayScope ( ) const
void CH_Manager::displaySelectedScopedChannels ( bool  propagate = true)
void CH_Manager::displaySelectedScopedLayers ( bool  propagate = true)
void CH_Manager::dumpGlobalParams ( std::ostream &  out) const
virtual void CH_Manager::endChannelChanges ( )
inlinevirtual

Reimplemented in OP_CommandManager.

Definition at line 1734 of file CH_Manager.h.

void CH_Manager::enforceLeafOnlyChannels ( CH_Group group,
const char *  name = "new_group" 
)
fpreal CH_Manager::evalBezierFunc ( int  thread)
fpreal CH_Manager::evalConstantFunc ( int  thread)
const CH_EvalContext& CH_Manager::evalContext ( int  thread) const
inline

Definition at line 1441 of file CH_Manager.h.

CH_EvalContext& CH_Manager::evalContext ( int  thread)
inline

Definition at line 1445 of file CH_Manager.h.

fpreal CH_Manager::evalCubicFunc ( int  thread)
fpreal CH_Manager::evalCycleFunc ( fpreal  start_frame,
fpreal  end_frame,
int  thread 
)
fpreal CH_Manager::evalCycleOffsetFunc ( fpreal  start_frame,
fpreal  end_frame,
int  thread 
)
fpreal CH_Manager::evalCycleOffsettFunc ( fpreal  start_frame,
fpreal  end_frame,
int  thread 
)
fpreal CH_Manager::evalCycletFunc ( fpreal  start_frame,
fpreal  end_frame,
int  thread 
)
fpreal CH_Manager::evalEaseFunc ( int  thread)
fpreal CH_Manager::evalEaseinFunc ( int  thread)
fpreal CH_Manager::evalEaseinpFunc ( fpreal  ease_speed,
int  thread 
)
fpreal CH_Manager::evalEaseoutFunc ( int  thread)
fpreal CH_Manager::evalEaseoutpFunc ( fpreal  ease_speed,
int  thread 
)
fpreal CH_Manager::evalEasepFunc ( fpreal  ease_speed,
int  thread 
)
fpreal CH_Manager::evalLinearFunc ( int  thread)
fpreal CH_Manager::evalMatchFunc ( int  thread)
fpreal CH_Manager::evalMatchinFunc ( int  thread)
fpreal CH_Manager::evalMatchoutFunc ( int  thread)
fpreal CH_Manager::evalQcubicFunc ( int  thread)
fpreal CH_Manager::evalQlinearFunc ( int  thread)
fpreal CH_Manager::evalQuinticFunc ( int  thread)
fpreal CH_Manager::evalRepeatFunc ( fpreal  start_frame,
fpreal  end_frame,
int  thread 
)
fpreal CH_Manager::evalRepeattFunc ( fpreal  start_frame,
fpreal  end_frame,
int  thread 
)
fpreal CH_Manager::evalSplineFunc ( int  thread)
fpreal CH_Manager::evaluate ( const char *  expr,
fpreal  now,
CH_Collection local = nullptr,
int frame_dep = nullptr,
int  thread = 0,
CH_ExprLanguage  language = CH_OLD_EXPR_LANGUAGE,
const DEP_ContextOptionsStack context_options_stack = nullptr,
DEP_ContextOptionsReadHandle  context_options = DEP_ContextOptionsReadHandle() 
)
int CH_Manager::evaluateString ( const char *  expr,
UT_String result,
fpreal  now,
CH_Collection local = nullptr,
int  thread = 0,
CH_ExprLanguage  language = CH_OLD_EXPR_LANGUAGE,
const DEP_ContextOptionsStack context_options_stack = nullptr,
DEP_ContextOptionsReadHandle  context_options = DEP_ContextOptionsReadHandle() 
)
static void CH_Manager::evaluationError ( int  err,
int  thread,
const char *  path 
)
static
fpreal CH_Manager::evalVmatchFunc ( int  thread)
fpreal CH_Manager::evalVmatchinFunc ( int  thread)
fpreal CH_Manager::evalVmatchoutFunc ( int  thread)
int CH_Manager::expandString ( const char *  string,
UT_String expanded,
fpreal  time,
CH_Collection local = nullptr,
int  thread = 0,
int  expansion_type = CH_EXPANSION_TYPE_DEFAULT,
const DEP_ContextOptionsStack context_options_stack = nullptr,
DEP_ContextOptionsReadHandle  context_options = DEP_ContextOptionsReadHandle() 
)
void CH_Manager::extractGroup ( CH_Group group,
CollisionBehaviour  cb 
)
void CH_Manager::findChannelsFromGroups ( CH_ChannelList channels,
const char *  pattern 
)
void CH_Manager::findChanRefsFromGroups ( CH_ChannelRefList chanrefs,
const char *  pattern 
)
CH_Channel* CH_Manager::findExternalChannel ( const UT_StringHolder path)

Returns an external channel from a collection name and channel name separated by a '/'.

CH_Group* CH_Manager::findGroup ( const char *  const_path,
bool  create = false,
CH_Group head = nullptr 
)
void CH_Manager::findGroups ( CH_GroupList groups,
const char *  pattern,
bool  minimal 
)
void CH_Manager::frameBookmark ( int  index,
bool  store_previous_range = true 
)

Adjust the sample range to match that of the given bookmark If store_previous_range is true, stores the current sample range so that it can be restored later.

void CH_Manager::frameBookmark ( CH_Bookmark bookmark,
bool  store_previous_range = true 
)
virtual CH_ScriptAccessManager* CH_Manager::getAccessManager ( int  )
inlinevirtual

Reimplemented in OP_CommandManager.

Definition at line 1437 of file CH_Manager.h.

bool CH_Manager::getAlwaysCommitKeyChange ( ) const
inline

Definition at line 587 of file CH_Manager.h.

fpreal CH_Manager::getAudioLevel ( ) const
inline

Definition at line 1337 of file CH_Manager.h.

bool CH_Manager::getAutoKeyTuples ( ) const
inline

Auto-Key all Tuples is a preference to key tuples together.

Definition at line 1577 of file CH_Manager.h.

bool CH_Manager::getAutoScopeIncludeAnimated ( ) const
inline

Include all the Animated Channels when building the scoped parameter list from selection

Definition at line 1591 of file CH_Manager.h.

bool CH_Manager::getAutoScopeIncludeChild ( ) const
inline

Include all the Child nodes when building the scoped parameter list from selection

Definition at line 1641 of file CH_Manager.h.

bool CH_Manager::getAutoScopeIncludeConstraints ( ) const
inline

Include all the Constraints nodes when building the scoped parameter list from selection

Definition at line 1648 of file CH_Manager.h.

bool CH_Manager::getAutoScopeOnChannelCreate ( ) const
inline

Auto-Scope when Creating Channel is a preference to set the auto-scope flag when creating a channel.

Definition at line 1584 of file CH_Manager.h.

SlopeMode CH_Manager::getAutoSlope ( ) const
inline

Definition at line 565 of file CH_Manager.h.

bool CH_Manager::getAutoSplit ( ) const
inline

Definition at line 572 of file CH_Manager.h.

CH_Bookmark* CH_Manager::getBookmark ( int  i)
inline

Definition at line 1157 of file CH_Manager.h.

const CH_Bookmark* CH_Manager::getBookmark ( int  i) const
inline

Definition at line 1158 of file CH_Manager.h.

CH_Bookmark* CH_Manager::getBookmarkBySessionId ( int64  bookmark_id) const
int CH_Manager::getBookmarkIndex ( CH_Bookmark bookmark)

Given a bookmark, return its index in the bookmark list, or -1 if the bookmark is not in the list

UT_Array<CH_Bookmark *> CH_Manager::getBookmarksBySessionIds ( const UT_Array< int64 > &  ids) const

Given an input array of bookmark session ids, returns an array of matching bookmark objects. Any invalid ids will be returned as nullptr in the output array.

DEP_MicroNode& CH_Manager::getBookmarksMicroNode ( )
inline

Definition at line 1101 of file CH_Manager.h.

const UT_Array<exint>& CH_Manager::getBookmarksOrderByRecentUsage ( )
inline

Definition at line 1169 of file CH_Manager.h.

const char* CH_Manager::getChanCreateKeyExpression ( ) const
inline

Definition at line 583 of file CH_Manager.h.

virtual bool CH_Manager::getChannelAutoSelect ( const CH_ChannelRef chref) const
inlinevirtual

Reimplemented in OP_CommandManager.

Definition at line 1713 of file CH_Manager.h.

CH_ChannelChanged* CH_Manager::getChannelChanged ( )
unsigned CH_Manager::getChannelFlags ( const CH_ChannelRef chref) const
virtual void CH_Manager::getChannelsWithNodeId ( CH_ChannelList chans,
int  node_id 
) const
virtual

Reimplemented in OP_CommandManager.

CH_Tweener* CH_Manager::getChannelTweener ( )
inline

Definition at line 1711 of file CH_Manager.h.

virtual void CH_Manager::getChanRefPath ( const CH_ChannelRef r,
UT_String path,
bool  use_alias = false 
) const
virtual

Use this method to get the full path of the channel referenced by r.

Reimplemented in OP_CommandManager.

int CH_Manager::getChopMotionSamples ( ) const
inline

Definition at line 1207 of file CH_Manager.h.

virtual bool CH_Manager::getChRefAlias ( const CH_ChannelRef r,
UT_String ret 
) const
virtual

Reimplemented in CMD_Manager, and OP_CommandManager.

virtual CH_Channel* CH_Manager::getChRefChannel ( const CH_ChannelRef r) const
virtual

Use this method to translate a channel reference to a channel pointer. May return NULL if the channel reference does not reference a valid channel.

Reimplemented in OP_CommandManager.

virtual bool CH_Manager::getChRefLabelForUI ( const CH_ChannelRef r,
UT_String ret 
) const
virtual

Reimplemented in CMD_Manager, and OP_CommandManager.

virtual bool CH_Manager::getChRefNodePath ( const CH_ChannelRef r,
UT_String ret 
) const
virtual

Reimplemented in CMD_Manager, and OP_CommandManager.

static CH_Manager* CH_Manager::getContext ( )
inlinestatic

Definition at line 534 of file CH_Manager.h.

static bool CH_Manager::getContextExists ( )
inlinestatic

Definition at line 539 of file CH_Manager.h.

CH_Group* CH_Manager::getCurrentGroup ( )
static int CH_Manager::getDefaultChopMotionSamples ( )
static
DEP_MicroNode& CH_Manager::getDefaultContextOptionMicroNode ( const UT_StringHolder opt)
DEP_ContextOptionsHandle CH_Manager::getDefaultContextOptions ( ) const
inline

Definition at line 1658 of file CH_Manager.h.

const UT_StringHolder& CH_Manager::getDefaultContextOptionUiConfig ( const UT_StringHolder opt) const
const char* CH_Manager::getDefaultExpression ( ) const
inline

Definition at line 552 of file CH_Manager.h.

CH_ExprLanguage CH_Manager::getDefaultExprLanguage ( )
inline

Definition at line 1032 of file CH_Manager.h.

static fpreal CH_Manager::getDefaultFPS ( )
static
static fpreal CH_Manager::getDefaultLength ( fpreal  fps)
static
static fpreal CH_Manager::getDefaultLengthFrames ( fpreal  fps)
static
const char* CH_Manager::getDefaultRotationExpression ( ) const
inline

Definition at line 561 of file CH_Manager.h.

fpreal CH_Manager::getDefaultSlope ( ) const
inline

Definition at line 569 of file CH_Manager.h.

const char* CH_Manager::getDefaultSplitExpression ( ) const
inline

Definition at line 576 of file CH_Manager.h.

const CH_Channel* CH_Manager::getEvalChannel ( int  thread) const
inline

Definition at line 1448 of file CH_Manager.h.

DEP_ContextOptionsReadHandle CH_Manager::getEvalChannelContextOptions ( int  thread) const
inline

Definition at line 1458 of file CH_Manager.h.

const DEP_ContextOptionsStack* CH_Manager::getEvalChannelContextOptionsStack ( int  thread) const
inline

Definition at line 1455 of file CH_Manager.h.

const char* CH_Manager::getEvalChannelName ( int  thread) const
inline

Definition at line 1452 of file CH_Manager.h.

CH_Collection* CH_Manager::getEvalCollection ( int  thread) const
inline

Definition at line 1418 of file CH_Manager.h.

const CH_Segment* CH_Manager::getEvalSegment ( int  thread) const
inline

Definition at line 1450 of file CH_Manager.h.

fpreal CH_Manager::getEvaluateTime ( int  thread) const
inline

Functions for obtaining and setting the current evaluation time.

Examples:
expr/globalvar.C.

Definition at line 1463 of file CH_Manager.h.

fpreal CH_Manager::getEvaluateTime ( ) const
inline

The following function only remains for backwards compatibility of HDK users. Calls to this function should be replaced with one of the following forms: getEvaluateTime(context.getThread()) -> inside cooking code path getEvaluateTime(thread) -> in expression functions CHgetEvalTime() -> else without thread variable

Definition at line 1477 of file CH_Manager.h.

CH_Channel* CH_Manager::getExternalChannel ( const char *  collection,
const char *  name 
) const

Returns an external channel given a collection and a channel name.

CH_Collection* CH_Manager::getExternalCollection ( const UT_StringHolder name) const

Return a pointer to the external collection, or nullptr if the associated collection doesn't exist/hasn't been added

const UT_StringMap<UT_UniquePtr<CH_Collection> >& CH_Manager::getExternalCollections ( ) const
inline

Definition at line 1074 of file CH_Manager.h.

static bool CH_Manager::getFileType ( const char *  filename,
int raw,
int binary 
)
static
bool CH_Manager::getFollowScopedChannelReferences ( ) const
inline

Definition at line 1597 of file CH_Manager.h.

int CH_Manager::getFrame ( fpreal  t) const
inline

Definition at line 1244 of file CH_Manager.h.

CH_Bookmark* CH_Manager::getFramedBookmark ( ) const

If there is an actively framed bookmark (sample range == bookmark range), returns the index of that bookmark, otherwise, returns -1

int CH_Manager::getFramedBookmarkIndex ( ) const
fpreal CH_Manager::getFrameTolerance ( ) const
inline

Definition at line 1227 of file CH_Manager.h.

fpreal CH_Manager::getGlobalEnd ( ) const
inline

Definition at line 1211 of file CH_Manager.h.

int CH_Manager::getGlobalEndFrame ( ) const
inline
Examples:
DM/DM_ObjectPathHook.C.

Definition at line 1214 of file CH_Manager.h.

void CH_Manager::getGlobalParamAnyScopeF ( const char *  token,
CH_Collection scope,
fpreal result,
fpreal  def,
int  thread,
bool  add_dependencies 
)

The AnyScope variants will start at the given scope and work upwards until a global parameter is found. If none is found, they will act like getGlobalParamF on the root scope.

void CH_Manager::getGlobalParamAnyScopeS ( const char *  token,
CH_Collection scope,
UT_String result,
const char *  def,
int  thread,
bool  add_dependencies 
)
void CH_Manager::getGlobalParamF ( const char *  token,
CH_Collection scope,
fpreal result,
fpreal  def,
int  thread,
bool  add_dependencies 
)
void CH_Manager::getGlobalParamS ( const char *  token,
CH_Collection scope,
UT_String result,
const char *  def,
int  thread,
bool  add_dependencies 
)
CH_ScopedChannels& CH_Manager::getGlobalScopedChannels ( )
inline

Definition at line 1042 of file CH_Manager.h.

const CH_ScopedChannels& CH_Manager::getGlobalScopedChannels ( ) const
inline

Definition at line 1044 of file CH_Manager.h.

fpreal CH_Manager::getGlobalStart ( ) const
inline

Definition at line 1210 of file CH_Manager.h.

int CH_Manager::getGlobalStartFrame ( ) const
inline
Examples:
DM/DM_ObjectPathHook.C.

Definition at line 1212 of file CH_Manager.h.

int CH_Manager::getHoldFlag ( ) const
inline

Definition at line 1366 of file CH_Manager.h.

int CH_Manager::getHoldLastKey ( ) const
inline

Definition at line 581 of file CH_Manager.h.

bool CH_Manager::getIgnoreUpdateScopeFlag ( ) const
inline

Definition at line 1721 of file CH_Manager.h.

int CH_Manager::getIntegerFrameFlag ( ) const
inline

Definition at line 1310 of file CH_Manager.h.

bool CH_Manager::getIsAtFrame ( fpreal  t) const
inline

Definition at line 1294 of file CH_Manager.h.

bool CH_Manager::getIsSettingGlobalParam ( ) const
inline

Definition at line 910 of file CH_Manager.h.

bool CH_Manager::getIsSettingGuideParam ( ) const
inline

Definition at line 948 of file CH_Manager.h.

static CH_KeyState CH_Manager::getKeyState ( fpreal  gtime,
const CH_ChannelList channels,
bool  loose = false 
)
static
CH_Bookmark* CH_Manager::getLeastRecentBookmark ( ) const
CH_LocalVariable* CH_Manager::getLocalVariableTable ( ) const
CH_Bookmark* CH_Manager::getMostRecentBookmark ( ) const
int CH_Manager::getNBookmarks ( ) const
inline

Definition at line 1153 of file CH_Manager.h.

int CH_Manager::getNTimeGroups ( ) const
inline

Definition at line 1088 of file CH_Manager.h.

fpreal CH_Manager::getNumSamples ( ) const
inline

Definition at line 1201 of file CH_Manager.h.

int CH_Manager::getNumScopedChanRefs ( )
inline

Definition at line 608 of file CH_Manager.h.

void CH_Manager::getPendingChannels ( CH_ChannelList channels) const
int CH_Manager::getRawInterpolation ( )
inline

Definition at line 1223 of file CH_Manager.h.

bool CH_Manager::getRealTimeDisableSkip ( ) const
inline

Definition at line 1354 of file CH_Manager.h.

fpreal CH_Manager::getRealTimeFactor ( ) const
inline

Definition at line 1352 of file CH_Manager.h.

int CH_Manager::getRealTimeFlag ( ) const
inline

Definition at line 1350 of file CH_Manager.h.

int CH_Manager::getRestrictRangeFlag ( ) const
inline

Definition at line 1313 of file CH_Manager.h.

CH_Collection* CH_Manager::getRootCollection ( ) const
inline

Definition at line 1434 of file CH_Manager.h.

fpreal CH_Manager::getSample ( fpreal  t) const
inline
fpreal CH_Manager::getSampleDelta ( fpreal  time_delta) const
inline

Definition at line 1254 of file CH_Manager.h.

void CH_Manager::getSampleRange ( fpreal start,
fpreal end 
)
inline

Definition at line 1359 of file CH_Manager.h.

fpreal CH_Manager::getSampleRaw ( fpreal  t) const
inline

Definition at line 1234 of file CH_Manager.h.

fpreal CH_Manager::getSamplesPerSec ( ) const
inline
Examples:
SOP/SOP_PrimVOP.C.

Definition at line 1203 of file CH_Manager.h.

fpreal CH_Manager::getSampleStep ( ) const
inline

Definition at line 1356 of file CH_Manager.h.

void CH_Manager::getScopedChannels ( CH_ChannelList channels,
bool  sorted = false 
)
void CH_Manager::getScopedChannelsKeyFrames ( UT_IntArray frames,
int  minframe,
int  maxframe 
)
void CH_Manager::getScopedChanRefs ( CH_ChannelRefList chanrefs,
unsigned  mask = 0,
bool  sorted = false 
) const
fpreal CH_Manager::getSecsPerSample ( ) const
inline

Definition at line 1205 of file CH_Manager.h.

CH_GroupList CH_Manager::getSelectedGroups ( )
void CH_Manager::getSelectedScopedChanRefs ( CH_ChannelRefList chanrefs,
bool  sorted = false,
int  operate_on = CH_SELECTED 
)
int CH_Manager::getShowAnimBarFlag ( ) const
inline

Definition at line 1334 of file CH_Manager.h.

int CH_Manager::getShowAudioFlag ( ) const
inline

Definition at line 1322 of file CH_Manager.h.

int CH_Manager::getShowBookmarksFlag ( ) const
inline

Definition at line 1328 of file CH_Manager.h.

int CH_Manager::getShowKeysFlag ( ) const
inline

Definition at line 1325 of file CH_Manager.h.

int CH_Manager::getShowRangeFlag ( ) const
inline

Definition at line 1316 of file CH_Manager.h.

int CH_Manager::getShowSimCacheFlag ( ) const
inline

Definition at line 1331 of file CH_Manager.h.

int CH_Manager::getShowTicksFlag ( ) const
inline

Definition at line 1319 of file CH_Manager.h.

static int CH_Manager::getSimpleSegmentTypeFromExpression ( const char *  expr)
static
fpreal CH_Manager::getSnapSample ( fpreal  frame) const
inline

Definition at line 1272 of file CH_Manager.h.

fpreal CH_Manager::getSnapSubsample ( fpreal  frame) const
inline

Snaps a frame to aligns with the sample step (taking the start frame into account)

Definition at line 1280 of file CH_Manager.h.

fpreal CH_Manager::getSnapToFrameDelta ( fpreal  base_time,
fpreal  time_delta 
) const
fpreal CH_Manager::getSnapToFrameTime ( fpreal  t) const
inline

Definition at line 1259 of file CH_Manager.h.

fpreal CH_Manager::getSnapToSubframeTime ( fpreal  t) const
inline

Definition at line 1265 of file CH_Manager.h.

fpreal CH_Manager::getTime ( fpreal  sample) const
inline
Examples:
SOP/SOP_SParticle.C, and SOP/SOP_TimeCompare.C.

Definition at line 1229 of file CH_Manager.h.

void CH_Manager::getTimeCode ( char *  buf,
fpreal  t 
)
fpreal CH_Manager::getTimeCodeOffset ( fpreal  ) const
inline

Definition at line 1308 of file CH_Manager.h.

fpreal CH_Manager::getTimeDelta ( fpreal  sample_delta) const
inline

Definition at line 1249 of file CH_Manager.h.

CH_TimeGroup* CH_Manager::getTimeGroup ( int  i)
inline

Definition at line 1089 of file CH_Manager.h.

const CH_TimeGroup* CH_Manager::getTimeGroup ( int  i) const
inline

Definition at line 1090 of file CH_Manager.h.

CH_TimeGroup* CH_Manager::getTimeGroup ( const char *  name)
const CH_TimeGroup* CH_Manager::getTimeGroup ( const char *  name) const
int CH_Manager::getTimeGroupIdx ( const char *  name) const
fpreal CH_Manager::getTolerance ( ) const
inline

Definition at line 1226 of file CH_Manager.h.

CH_Group* CH_Manager::getTopGroup ( ) const
fpreal CH_Manager::getUnitLength ( ) const
inline

Definition at line 1340 of file CH_Manager.h.

fpreal CH_Manager::getUnitMass ( ) const
inline

Definition at line 1342 of file CH_Manager.h.

virtual bool CH_Manager::getVariableString ( const char *  name,
UT_String value,
int time_depend,
int  thread 
)
virtual

Reimplemented in CMD_Manager.

bool CH_Manager::getVariableValue ( UT_String str,
int  i,
int  thread 
) const
bool CH_Manager::getVariableValue ( fpreal val,
int  i,
int  thread 
) const
bool CH_Manager::getVariableValue ( int val,
int  i,
int  thread 
) const
* to get _Base exint CH_Manager::globExternalChannels ( const UT_StringHolder pattern,
CH_ChannelList chans 
)
bool CH_Manager::hasExternalCollection ( const CH_Collection collection) const
bool CH_Manager::hasPendingChannels ( ) const
void CH_Manager::initExpressionLibrary ( )
protected
void CH_Manager::initLibraryGlue ( )
protected
bool CH_Manager::isAutomaticContextOption ( const UT_StringHolder opt) const
bool CH_Manager::isAutomaticContextOptionOverridden ( const UT_StringHolder opt) const
bool CH_Manager::isChannelDisplayed ( CH_Channel chp) const
bool CH_Manager::isChannelDisplayed ( const CH_ChannelRef chref) const
bool CH_Manager::isChannelDisplayed ( const char *  full_chan_path) const
bool CH_Manager::isChannelScoped ( CH_Channel chp) const
bool CH_Manager::isChannelScoped ( const char *  full_chan_path) const
bool CH_Manager::isChannelScoped ( const CH_ChannelRef chref) const
bool CH_Manager::isChannelSelected ( const CH_ChannelRef chref) const
bool CH_Manager::isChannelSelected ( const char *  full_chan_path) const
virtual bool CH_Manager::isChanRefValid ( const CH_ChannelRef chref) const
virtual

Reimplemented in OP_CommandManager.

bool CH_Manager::isGlobalScopedChannels ( CH_ScopedChannelsBase p)
inline

Definition at line 1038 of file CH_Manager.h.

bool CH_Manager::isLayerDisplayed ( CH_Channel chp) const
bool CH_Manager::isLayerDisplayed ( const CH_ChannelRef chref) const
bool CH_Manager::isLayerDisplayed ( const char *  full_chan_path) const
bool CH_Manager::isLayerScoped ( CH_Channel chp) const
bool CH_Manager::isLayerScoped ( const char *  full_chan_path) const
bool CH_Manager::isLayerScoped ( const CH_ChannelRef chref) const
bool CH_Manager::isLayerSelected ( const CH_ChannelRef chref) const
bool CH_Manager::isLayerSelected ( const char *  full_chan_path) const
virtual bool CH_Manager::isOwnerExposed ( const CH_ChannelRef r) const
virtual

Use this method to determine if the owner of the channel reference is exposed or not.

Reimplemented in OP_CommandManager.

bool CH_Manager::loadBookmarks ( UT_JSONParser w,
bool  remove_existing = true 
)
bool CH_Manager::loadChannelOptions ( const char *  filename)
int CH_Manager::loadChannels ( const char *  filename,
const char *  src_pattern,
const char *  dest_pattern,
bool  use_range,
const fpreal tstart,
const fpreal tend,
CH_CollectionList parents,
bool  delete_keys = false,
CH_ChannelRefList displayed_parms = nullptr 
)
bool CH_Manager::loadDefaultContextOptions ( UT_IStream is)
CH_Group* CH_Manager::loadGroup ( UT_IStream is)
static void CH_Manager::lookupExpression ( const char *  name,
UT_String val,
int  thread 
)
static
static void CH_Manager::lookupExpressionNoThread ( const char *  name,
UT_String val 
)
static
static void CH_Manager::lookupVariable ( const char *  name,
UT_String val,
int  thread 
)
static
static void CH_Manager::lookupVariableNoThread ( const char *  name,
UT_String val 
)
static
static bool CH_Manager::makeGroupNameValid ( UT_String path)
static
static bool CH_Manager::makeGroupPathValid ( UT_String path)
static
void CH_Manager::mergeWithGroup ( CH_Group source,
CH_Group target,
CollisionBehaviour  cb 
)
void CH_Manager::moveIntoGroup ( CH_Group source,
CH_Group target,
CollisionBehaviour  cb,
const char *  new_name = nullptr 
)
int CH_Manager::niceFrameSeparation ( fpreal  initial_sep,
int  minimum_sep = 1 
) const
fpreal CH_Manager::niceNumber ( fpreal  num,
int  digits = 6 
)
inlinestatic

Utility function to make a floating point number "nice" - i.e. only / use N decimal places after the decimal point. Should only be used for frames/samples (not time in seconds).

Definition at line 2117 of file CH_Manager.h.

void CH_Manager::parseUnitsString ( const char *  units,
fpreal distexp,
fpreal massexp 
) const
void CH_Manager::pinAllScopedChannels ( bool  propagate = true)
void CH_Manager::pinAllScopedLayers ( bool  propagate = true)
void CH_Manager::pinChannels ( const CH_ChannelRefList chanrefs,
bool  propagate = true 
)
void CH_Manager::pinLayers ( const CH_ChannelRefList chanrefs,
bool  propagate = true 
)
void CH_Manager::pinSelectedChannels ( bool  propagate = true,
int  operate_on = CH_SELECTED 
)
void CH_Manager::pinSelectedLayers ( bool  propagate = true,
int  operate_on = CH_LAYER_SELECTED 
)
void CH_Manager::popRopCookContextOptions ( )
void CH_Manager::preserveCollectionKeyframes ( CH_Collection grp,
fpreal  old_fps 
)

Updates start and end time of collections to preserve key frames based on the previous fps

static bool CH_Manager::printFileInfo ( std::ostream &  os,
const char *  filename,
CH_Collection load_coll,
bool  print_segments = true 
)
static
void CH_Manager::pushRopCookContextOptions ( )
void CH_Manager::pushRopCookContextOptions ( bool  ropcook,
fpreal  fstart,
fpreal  fend,
fpreal  finc,
const UT_StringHolder ropname,
const UT_StringHolder roppath 
)
static bool CH_Manager::readCHNFileHeader ( UT_IStream is,
bool  quiet,
fpreal32 version,
int binary,
bool &  is_fp64,
fpreal64 tstart,
fpreal64 tend 
)
static
void CH_Manager::removeDefaultContextOption ( const UT_StringHolder opt,
bool  create_undo 
)
void CH_Manager::removeDefaultContextOptionCallback ( int  id)
int CH_Manager::removeGlobalParamOwner ( CH_Collection owner)
void CH_Manager::removeParamDependency ( CH_Collection coll)
void CH_Manager::removePendingChannel ( CH_Channel chp)
void CH_Manager::removeReferencesToNodeId ( int  node_id)

This method will remove all references that this manager knows about channels belonging to node 'node_id'. After this method, scoped channels belonging to node_id will be removed, as will such channels in channel groups.

void CH_Manager::renameGroup ( CH_Group group,
const char *  newname 
)
void CH_Manager::renameTimeGroup ( CH_TimeGroup group,
const char *  newname,
bool  force = false 
)
void CH_Manager::resetChannelOptions ( bool  notify = true)
void CH_Manager::resetPlayback ( )
void CH_Manager::resetRopCookContextOptions ( )
virtual bool CH_Manager::resolveChanRefExport ( const CH_ChannelRef r,
CH_ChannelRef out_export 
)
virtual

Reimplemented in OP_CommandManager.

bool CH_Manager::saveBookmarks ( UT_JSONWriter w,
bool  include_temporary = false 
)
bool CH_Manager::saveBookmarks ( UT_JSONWriter w,
const UT_Array< CH_Bookmark * > &  bookmarks 
)
bool CH_Manager::saveChannelOptions ( const char *  filename)
int CH_Manager::saveChannels ( const char *  filename,
bool  binary,
bool  compiled,
const CH_ChannelList channels,
bool  displayed = false 
) const
bool CH_Manager::saveDefaultContextOptions ( std::ostream &  os) const
void CH_Manager::saveGroup ( CH_Group g,
std::ostream &  os,
int  binary 
)
fpreal CH_Manager::scaleFromMKS ( const char *  tounits) const
fpreal CH_Manager::scaleToMKS ( const char *  fromunits) const
bool CH_Manager::scanForVariableInString ( const char *  variable,
const char *  string 
) const

Return true if the variable exists in the given string. The variable may be in the form "$NAME" or "NAME". If expand_expressions is true, any back-tick expressions will be expanded and the result scanned for the variable.

void CH_Manager::scopeChanged ( unsigned  flags,
bool  propagate = true 
)
void CH_Manager::scopeChannel ( const CH_ChannelRef chref,
bool  on_off 
)
void CH_Manager::scopeChannel ( const char *  full_chan_path,
bool  on_off 
)
bool CH_Manager::scopeChannelInternal ( const CH_Channel chp,
bool  on_off 
)
bool CH_Manager::scopeChannelInternal ( const CH_ChannelRef chref,
bool  on_off 
)
void CH_Manager::scopeExternalCollection ( CH_Collection collection,
bool  on_off = true 
)

Scope an existing external collection. Must have been previously added to the channel manager.

void CH_Manager::scopeLayer ( const CH_ChannelRef chref,
bool  on_off 
)
void CH_Manager::scopeLayer ( const char *  full_chan_path,
bool  on_off 
)
bool CH_Manager::scopeLayerInternal ( CH_Channel chp,
bool  on_off 
)
bool CH_Manager::scopeLayerInternal ( const CH_ChannelRef chref,
bool  on_off 
)
void CH_Manager::selectAllScopedChannels ( bool  propagate = true)
void CH_Manager::selectAllScopedLayers ( bool  propagate = true)
void CH_Manager::selectChannel ( const CH_ChannelRef chref,
bool  propagate = true 
)
void CH_Manager::selectChannel ( const char *  full_chan_path,
bool  propagate = true 
)
void CH_Manager::selectLayer ( const CH_ChannelRef chref,
bool  propagate = true 
)
void CH_Manager::selectLayer ( const char *  full_chan_path,
bool  propagate = true 
)
void CH_Manager::setAlwaysCommitKeyChange ( bool  onoff)
inline

Definition at line 589 of file CH_Manager.h.

void CH_Manager::setAudioLevel ( fpreal  lvl)
inline

Definition at line 1338 of file CH_Manager.h.

void CH_Manager::setAutoKeyTuples ( bool  b)
inline

Definition at line 1579 of file CH_Manager.h.

void CH_Manager::setAutoScopeIncludeAnimated ( bool  b)
inline

Definition at line 1593 of file CH_Manager.h.

void CH_Manager::setAutoScopeIncludeChild ( bool  b)
inline

Definition at line 1643 of file CH_Manager.h.

void CH_Manager::setAutoScopeIncludeConstraints ( bool  b)
inline

Definition at line 1650 of file CH_Manager.h.

void CH_Manager::setAutoScopeOnChannelCreate ( bool  b)
inline

Definition at line 1586 of file CH_Manager.h.

void CH_Manager::setAutoSlope ( SlopeMode  m)
inline

Definition at line 563 of file CH_Manager.h.

void CH_Manager::setAutoSplit ( bool  onoff)
void CH_Manager::setChanCreateKeyExpression ( const char *  s)
inline

Definition at line 585 of file CH_Manager.h.

void CH_Manager::setChannelChanged ( CH_ChannelChanged mgr)
void CH_Manager::setChannelColorManager ( CH_ChannelColorManager mgr)
void CH_Manager::setChannelFlags ( const CH_ChannelRef chref,
unsigned  flags,
bool  on_off,
bool  propagate = true 
)
void CH_Manager::setChopMotionSamples ( int  n,
bool  notify = true 
)
virtual void CH_Manager::setContext ( )
virtual

Reimplemented in CMD_Manager.

void CH_Manager::setDefaultContextOption ( const UT_StringHolder opt,
const UT_StringHolder value,
bool  create_undo 
)
void CH_Manager::setDefaultContextOption ( const UT_StringHolder opt,
fpreal64  value,
bool  create_undo 
)
void CH_Manager::setDefaultContextOptionUiConfig ( const UT_StringHolder opt,
const UT_StringHolder ui_config 
)
void CH_Manager::setDefaultExpression ( const char *  s,
bool  notify = false 
)
void CH_Manager::setDefaultExprLanguage ( CH_ExprLanguage  language)
inline

Definition at line 1034 of file CH_Manager.h.

void CH_Manager::setDefaultRotationExpression ( const char *  s)
inline

Definition at line 556 of file CH_Manager.h.

void CH_Manager::setDefaultSlope ( fpreal  slope)
inline

Definition at line 567 of file CH_Manager.h.

void CH_Manager::setDefaultSplitExpression ( const char *  expr)
void CH_Manager::setEvalCollection ( CH_Collection g,
int  thread 
)
inline

Definition at line 1397 of file CH_Manager.h.

void CH_Manager::setEvaluateTime ( fpreal  time,
int  thread 
)
inline

Functions for obtaining and setting the current evaluation time.

Definition at line 1465 of file CH_Manager.h.

void CH_Manager::setEvaluateTime ( SYS_Flicks  fl,
int  thread 
)
inline

Functions for obtaining and setting the current evaluation time.

Definition at line 1467 of file CH_Manager.h.

void CH_Manager::setFollowScopedChannelReferences ( bool  b)
inline

Definition at line 1599 of file CH_Manager.h.

int CH_Manager::setGlobalFloatParam ( const char *  token,
fpreal  val,
CH_Collection *&  owner 
)
void CH_Manager::setGlobalStart ( fpreal  start,
bool  notify = true 
)

Set the start time directly. End time will be adjusted according to the sample count and fps

int CH_Manager::setGlobalStringParam ( const char *  token,
const char *  strval,
CH_Collection *&  owner 
)
void CH_Manager::setGlobalTime ( fpreal  start,
fpreal  end,
bool  notify = true 
)
void CH_Manager::setHoldFlag ( int  flag)
inline

Definition at line 1367 of file CH_Manager.h.

void CH_Manager::setHoldLastKey ( bool  onoff)
inline

Definition at line 579 of file CH_Manager.h.

void CH_Manager::setIgnoreUpdateScopeFlag ( bool  onoff)
inline

Definition at line 1723 of file CH_Manager.h.

void CH_Manager::setIntegerFrameFlag ( int  flag,
bool  notify = true 
)
void CH_Manager::setLeastRecentBookmark ( CH_Bookmark bookmark)

Marks the given bookmark as least recently used, bumping it to the start of the most-recently-used array

void CH_Manager::setMostRecentBookmark ( CH_Bookmark bookmark)

Marks the given bookmark as most recently used, bumping it to the end of the most-recently-used array

void CH_Manager::setRawInterpolation ( int  state)
inline

Definition at line 1222 of file CH_Manager.h.

void CH_Manager::setRawNumSamples ( int  n,
bool  notify = true 
)
void CH_Manager::setRawSamplesPerSec ( fpreal  fps,
bool  notify = true 
)
void CH_Manager::setRealTimeDisableSkip ( bool  b,
bool  notify = true 
)
void CH_Manager::setRealTimeFactor ( fpreal  f,
bool  notify = true 
)
void CH_Manager::setRealTimeFlag ( int  flag,
bool  notify = true 
)
void CH_Manager::setRestrictRangeFlag ( int  flag,
bool  notify = true 
)
void CH_Manager::setRootCollection ( CH_Collection root)
inline

Definition at line 1432 of file CH_Manager.h.

void CH_Manager::setSampleRange ( fpreal  start,
fpreal  end,
bool  notify = true 
)
void CH_Manager::setSamplesPerSec ( fpreal  fps,
bool  notify = true 
)
void CH_Manager::setSampleStep ( fpreal  s,
bool  notify = true 
)
void CH_Manager::setShowAnimBarFlag ( int  flag,
bool  notify = true 
)
void CH_Manager::setShowAudioFlag ( int  flag,
bool  notify = true 
)
void CH_Manager::setShowBookmarksFlag ( int  flag,
bool  notify = true 
)
void CH_Manager::setShowKeysFlag ( int  flag,
bool  notify = true 
)
void CH_Manager::setShowRangeFlag ( int  flag,
bool  notify = true 
)
void CH_Manager::setShowSimCacheFlag ( int  flag,
bool  notify = true 
)
void CH_Manager::setShowTicksFlag ( int  flag,
bool  notify = true 
)
int CH_Manager::setTimeCode ( const char *  buf,
fpreal t 
)
void CH_Manager::setTimeCodeOffset ( fpreal  t)
inline

Definition at line 1307 of file CH_Manager.h.

void CH_Manager::setTolerance ( fpreal  tol)
protected
void CH_Manager::setUnitLength ( fpreal  unitlength)
inline

Definition at line 1341 of file CH_Manager.h.

void CH_Manager::setUnitMass ( fpreal  unitmass)
inline

Definition at line 1343 of file CH_Manager.h.

void CH_Manager::shiftCollections ( CH_Collection grp,
fpreal  time_delta 
)

Shifts all collections by the given time_delta.

bool CH_Manager::shouldShowFakeAccelHandles ( ) const
inline

Definition at line 554 of file CH_Manager.h.

static bool CH_Manager::skipCHNFileHeaderForCollection ( UT_IStream is,
bool &  is_fp64 
)
static
int CH_Manager::sortBookmark ( CH_Bookmark bookmark,
bool  notify = true 
)

Moves the given bookmark to be sorted within the bookmark array. Assumes that the given bookmark is already in the array, and that all other bookmarks are already sorted

Parameters
bookmarkBookmark to be sorted notify If true, and the bookmark changed, sets myBookmarksMicroNode to dirty
void CH_Manager::stretchCollections ( CH_Collection from,
fpreal  ostart,
fpreal  oend 
)
void CH_Manager::timeGroupsChanged ( )
void CH_Manager::togglePinAllScopedChannels ( )
void CH_Manager::togglePinAllScopedLayers ( )
void CH_Manager::togglePinScopedChannels ( const CH_ChannelRefList chanrefs)
void CH_Manager::togglePinScopedLayers ( const CH_ChannelRefList chanrefs)
void CH_Manager::triggerChannelChanged ( )
void CH_Manager::undisplayChannel ( const CH_ChannelRef chref,
bool  propagate = true 
)
void CH_Manager::undisplayChannel ( const char *  full_chan_path,
bool  propagate = true 
)
void CH_Manager::undisplayLayer ( const CH_ChannelRef chref,
bool  propagate = true 
)
void CH_Manager::undisplayLayer ( const char *  full_chan_path,
bool  propagate = true 
)
void CH_Manager::unpinAllScopedChannels ( bool  propagate = true)
void CH_Manager::unpinAllScopedLayers ( bool  propagate = true)
void CH_Manager::unpinChannels ( const CH_ChannelRefList chanrefs,
bool  propagate = true 
)
void CH_Manager::unpinLayers ( const CH_ChannelRefList chanrefs,
bool  propagate = true 
)
void CH_Manager::unpinSelectedChannels ( bool  propagate = true,
int  operate_on = CH_SELECTED 
)
void CH_Manager::unpinSelectedLayers ( bool  propagate = true,
int  operate_on = CH_LAYER_SELECTED 
)
void CH_Manager::updateCurrentGroup ( CH_Group group,
void by,
bool  propagate = true 
)
void CH_Manager::updateGroupSelection ( const CH_GroupList groups,
void by,
bool  propagate = true 
)
void CH_Manager::updateGroupSelectionFromScoped ( void by,
bool  propagate = true 
)
void CH_Manager::updateRopCookContextOptions ( bool  ropcook,
fpreal  fstart,
fpreal  fend,
fpreal  finc,
const UT_StringHolder ropname,
const UT_StringHolder roppath 
)

Friends And Related Function Documentation

friend class CH_ScopeUndo
friend

Definition at line 1936 of file CH_Manager.h.

Definition at line 1933 of file CH_Manager.h.

Definition at line 1934 of file CH_Manager.h.

friend class CH_UndoScopeChannels
friend

Definition at line 1935 of file CH_Manager.h.

Member Data Documentation

constexpr int CH_Manager::CH_SCOPE_FILTERED = 1
static

Definition at line 519 of file CH_Manager.h.

constexpr int CH_Manager::CH_SCOPE_REPLACED = 0
static

Definition at line 518 of file CH_Manager.h.

* to get CH_Manager::everything

Appends channels the channel list when the full path matches the pattern. The pattern must have a '/' to separate the collection matching and the channel name matching. Use "

Definition at line 1067 of file CH_Manager.h.


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