BaseOverride Class Reference Library » Take System Library

#include <lib_takesystem.h>

Inheritance diagram for BaseOverride:

详细描述

An Override holds the settings for a specific object in a Take .

另请参阅
The BaseOverride Manual overview article.

私有成员函数

  BaseOverride ()
  ~BaseOverride ()

导航

BaseOverride GetNext () const
BaseOverride GetPred () const
BaseOverride GetUp () const
BaseOverride GetDown () const
BaseOverride GetDownLast () const

杂项

Bool   IsOverriddenParam (const DescID &descID)
BaseList2D GetSceneNode ()
BaseTake GetOwnerTake ( TakeData *takeData)
Bool   IsInGroup ( TakeData *takeData, BaseOverrideGroup *&resGroup)
Bool   GetAllOverrideDescID ( maxon::BaseArray < DescID > &result)
void  UpdateSceneNode ( TakeData *takeData, const DescID &descID)

Additional Inherited Members

-  Public Member Functions inherited from BaseList2D
const Char GetViewportRenderId ( VIEWPORT_RENDER_ID typeId) const
BaseList2D GetNext ()
BaseList2D GetPred ()
void  SetBit ( Int32 mask)
Bool   GetBit ( Int32 mask) const
void  DelBit ( Int32 mask)
void  ToggleBit ( Int32 mask)
Int32   GetAllBits () const
void  SetAllBits ( Int32 bits)
void  SetBitEx ( Int32 mask, Int32 flags)
BaseContainer   GetData ()
void  SetData (const BaseContainer &bc, Bool add=true)
const BaseContainer GetDataInstance () const
BaseContainer GetDataInstance ()
const BaseContainer GetDataInstanceRef () const
BaseContainer GetDataInstanceRef ()
String   GetName () const
void  SetName (const maxon::String &name)
String   GetBubbleHelp ()
Bool   TransferGoal ( BaseList2D *dst, Bool undolink)
Bool   TransferMarker ( BaseList2D *dst) const
Bool   比例 ( Float scale)
Bool   编辑 ()
void  GetIcon ( IconData *dat)
GeListHead GetNLARoot ()
BaseList2D AnimationLayerRemap ( BaseObject **layer=nullptr)
String   GetTypeName ()
BaseList2D GetMain () const
void  InsertTrackSorted ( CTrack *track)
Bool   AddEventNotification ( BaseList2D *bl, NOTIFY_EVENT eventid, NOTIFY_EVENT_FLAG flags, const BaseContainer *data)
Bool   RemoveEventNotification ( BaseDocument *doc, BaseList2D *bl, NOTIFY_EVENT eventid)
Bool   FindEventNotification ( BaseDocument *doc, BaseList2D *bl, NOTIFY_EVENT eventid)
Bool   SetDescIDState (const DescID &id, DESCIDSTATE descidstate)
DESCIDSTATE   GetDescIDState (const DescID &id, Bool tolerant) const
GeListHead GetOverrideRoot ()
BaseOverride GetFirstOverride ()
GeListHead GetShaderRepositoryRoot ()
GeListHead GetHiddenShaderRoot ()
maxon::NimbusInterface *  GetNimbusRef (const maxon::Id &spaceId) const
maxon::Result < maxon::NimbusInterface * >  GetOrCreateNimbusRef (const maxon::Id &spaceId)
void  RemoveNimbusRef (const maxon::Id &spaceId)
maxon::Result < maxon::HashMap < maxon::Id , maxon::ForwardRef < maxon::NimbusRef > > >  GetAllNimbusRefs () const
Bool   IsNodeBased () const
void  GetMarkerStampEx ( UInt32 *l1, UInt32 *l2)
const GeMarker GetMarker () const
void  SetMarker (const GeMarker &m)
Bool   AddUniqueID ( Int32 appid, const Char *const mem, Int bytes)
Bool   FindUniqueID ( Int32 appid, const Char *&mem, Int &bytes) const
Int32   GetUniqueIDCount () const
Bool   GetUniqueIDIndex ( Int32 idx, Int32 &id, const Char *&mem, Int &bytes) const
Bool   SetAnimatedParameter ( CTrack *track, const DescID &id, const GeData &t_data1, const GeData &t_data2, Float mix, DESCFLAGS_SET flags)
Bool   GetAnimatedParameter (const DescID &id, GeData &t_data1, GeData &t_data2, Float &mix, DESCFLAGS_GET flags)
BaseShader GetFirstShader () const
void  InsertShader ( BaseShader *shader, BaseShader *pred=nullptr)
void  ClearKeyframeSelection ()
Bool   FindKeyframeSelection (const DescID &id)
Bool   SetKeyframeSelection (const DescID &id, Bool selection)
Bool   KeyframeSelectionContent ()
LayerObject GetLayerObject ( BaseDocument *doc)
Bool   SetLayerObject ( LayerObject *layer)
const LayerData GetLayerData ( BaseDocument *doc, Bool rawdata=false)
Bool   SetLayerData ( BaseDocument *doc, const LayerData &data)
GeListHead GetCTrackRoot ()
CTrack GetFirstCTrack ()
CTrack FindCTrack (const DescID &id)
-  Public Member Functions inherited from GeListNode
GeListNode GetNext ()
GeListNode GetPred ()
GeListNode GetDown ()
GeListNode GetUp ()
GeListNode GetDownLast ()
void  InsertBefore ( GeListNode *bl)
void  InsertAfter ( GeListNode *bl)
void  InsertUnder ( GeListNode *bl)
void  InsertUnderLast ( GeListNode *bl)
void  移除 ()
GeListHead GetListHead ()
Int32   GetNodeID ( Int32 index=0) const
template<typename CAST >
const CAST *  GetNodeData ( Int32 index=0) const
template<typename CAST >
CAST *  GetNodeData ( Int32 index=0)
void  SetCustomData ( GeListNode *node)
GeListNode GetCustomData ()
BaseDocument GetDocument ()
Int32   GetBranchInfo ( BranchInfo *info, Int32 max, GETBRANCHINFO flags)
Bool   IsDocumentRelated ()
Int32   GetInfo ()
Bool   GetNBit ( NBIT bit) const
UInt32   GetNBitMask ( Int32 index) const
Bool   ChangeNBit ( NBIT bit, NBITCONTROL bitmode)
-  Public Member Functions inherited from C4DAtom
Int32   GetType () const
Int32   GetRealType () const
Int32   GetDiskType () const
Bool   IsInstanceOf ( Int32 id) const
Int32   GetClassification () const
Bool   消息 ( Int32 type, void *data=nullptr)
Bool   MultiMessage ( MULTIMSG_ROUTE flags, Int32 type, void *data)
C4DAtom GetClone ( COPYFLAGS flags, AliasTrans *trn)
Bool   CopyTo ( C4DAtom *dst, COPYFLAGS flags, AliasTrans *trn)
Bool   读取 ( HyperFile *hf, Int32 id, Int32 level)
Bool   Write ( HyperFile *hf)
Bool   ReadObject ( HyperFile *hf, Bool readheader)
Bool   WriteObject ( HyperFile *hf)
Bool   GetDescription ( 描述 *description, DESCFLAGS_DESC flags)
Bool   GetParameter (const DescID &id, GeData &t_data, DESCFLAGS_GET flags)
Bool   SetParameter (const DescID &id, const GeData &t_data, DESCFLAGS_SET flags)
DynamicDescription GetDynamicDescription ()
Bool   GetEnabling (const DescID &id, const GeData &t_data, DESCFLAGS_ENABLE flags, const BaseContainer *itemdesc)
Bool   TranslateDescID (const DescID &id, DescID &res_id, C4DAtom *&res_at)
UInt32   GetDirty ( DIRTYFLAGS flags) const
void  SetDirty ( DIRTYFLAGS flags)
UInt32   GetHDirty ( HDIRTYFLAGS mask) const
void  SetHDirty ( HDIRTYFLAGS mask)
-  Static Public Member Functions inherited from BaseList2D
static BaseList2D Alloc ( Int32 type)
static void  Free ( BaseList2D *&bl)
-  Static Public Attributes inherited from BaseList2D
static const Int32   SETBIT_FLAG_NODIRTY
static const Int32   SETBIT_FLAG_REMOVE

构造函数 & 析构函数文档编制

◆  BaseOverride()

BaseOverride () private

◆  ~BaseOverride()

~ BaseOverride () private

成员函数文档编制

◆  GetNext()

BaseOverride * GetNext ( ) const

Gets the next Override in the list. Convenience version of GeListNode::GetNext() returning a BaseOverride *.

返回
The next Override, or nullptr if there is none. Cinema 4D owns the pointed BaseOverride .

◆  GetPred()

BaseOverride * GetPred ( ) const

Gets the previous Override in the list. Convenience version of GeListNode::GetPred() returning a BaseOverride *.

返回
The previous Override, or nullptr if there is none. Cinema 4D owns the pointed BaseOverride .

◆  GetUp()

BaseOverride * GetUp ( ) const

Gets the parent Override of the list node. Convenience version of GeListNode::GetUp() returning a BaseOverride *.

返回
The parent Override, or nullptr if there is none. Cinema 4D owns the pointed BaseOverride .

◆  GetDown()

BaseOverride * GetDown ( ) const

Gets the first child Override of the list node. Convenience version of GeListNode::GetDown() returning a BaseOverride *.

返回
The first child Override, or nullptr if there is none. Cinema 4D owns the pointed BaseOverride .

◆  GetDownLast()

BaseOverride * GetDownLast ( ) const

Gets the last child Override of the list node. Convenience version of GeListNode::GetDownLast() returning a BaseOverride *.

返回
The last child Override, or nullptr if there is none. Cinema 4D owns the pointed BaseOverride .

◆  IsOverriddenParam()

Bool IsOverriddenParam ( const DescID descID )

Checks if the parameter at descID is overridden.

参数
[in] descID The parameter to be checked.
返回
true if parameter is overridden, otherwise false .

◆  GetSceneNode()

BaseList2D * GetSceneNode ( )

Returns a pointer to the original scene node connected to the Override node.

返回
A pointer to the original scene node, or nullptr if any error.

◆  GetOwnerTake()

BaseTake * GetOwnerTake ( TakeData takeData )

Gets a pointer to the Take that owns the Override.

参数
[in] takeData The Take System context. The caller owns the pointed TakeData .
返回
A pointer to the Take for this Override, or nullptr if any error. Cinema 4D owns the pointed BaseTake .

◆  IsInGroup()

Bool IsInGroup ( TakeData takeData ,
BaseOverrideGroup *&  resGroup  
)

Checks if the Override is also part of an Override Group, and if yes fills resGroup .

参数
[in] takeData The Take System context. The caller owns the pointed TakeData .
[out] resGroup The assigned BaseOverrideGroup . nullptr if the function returns false . Cinema 4D owns the pointed BaseOverrideGroup .
返回
true if the Override is part of an Override Group, otherwise false .

◆  GetAllOverrideDescID()

Bool GetAllOverrideDescID ( maxon::BaseArray < DescID > &  result )

Retrieves the DescID of all parameters in the Override.

注意
Sub-descriptions are included if overridden.
参数
[out] result The array to be filled.
返回
true if successful, otherwise false .

◆  UpdateSceneNode()

void UpdateSceneNode ( TakeData takeData ,
const DescID descID  
)

Updates the scene node whenever data is directly changed on the base Override (for example with SetParameter ).
This ensures the scene node is properly updated if the Override affects the current document state.

注意
An undo step is added automatically if the call is added from the main (GUI) thread and global undo is allowed (see TakeData::GetUndoState / TakeData::SetUndoState ).
参数
[in] takeData The Take System context. The caller owns the pointed TakeData .
[in] descID The DescID of the edited parameter.