就业培训     下载中心     Wiki     联络 登录   注册
  1. 首页
  2. C4D R23.110 C++ SDK
私有成员函数 | 所有成员列表

BaseOverrideGroup Class Reference Library » Take System Library

#include <lib_takesystem.h>

Inheritance diagram for BaseOverrideGroup:
Inheritance graph
[ legend ]

详细描述

An Override Group manages the values of multiple objects in a Take .

另请参阅
The BaseOverrideGroup Manual overview article.

私有成员函数

  BaseOverrideGroup ()
  ~BaseOverrideGroup ()

导航

BaseOverrideGroup *  GetNext () const
BaseOverrideGroup *  GetPred () const

杂项

Bool   GetObjectsInGroup ( AtomArray &selection)
void  AddToGroup ( TakeData *takeData, BaseList2D *node)
void  RemoveFromGroup ( TakeData *takeData, BaseList2D *node)
BaseTag *  AddTag ( TakeData *takeData, Int32 type, BaseMaterial *mat)
void  RemoveTag ( TakeData *takeData, Int32 type)
BaseTag *  GetTag ( Int32 type)
BaseTake *  GetTake ()
Bool   Find ( TakeData *takeData, BaseObject *op)

Visibility Modes

Int32   GetEditorMode ()
Int32   GetRenderMode ()
void  SetEditorMode ( Int32 mode)
void  SetRenderMode ( Int32 mode)

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

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

◆  BaseOverrideGroup()

BaseOverrideGroup () private

◆  ~BaseOverrideGroup()

~ BaseOverrideGroup () private

成员函数文档编制

◆  GetNext()

BaseOverrideGroup * GetNext ( ) const

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

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

◆  GetPred()

BaseOverrideGroup * GetPred ( ) const

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

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

◆  GetObjectsInGroup()

Bool GetObjectsInGroup ( AtomArray &  selection )

Retrieves all the objects in the group.

参数
[out] selection The AtomArray to be filled.
返回
true if successful, otherwise false .

◆  AddToGroup()

void AddToGroup ( TakeData *  takeData ,
BaseList2D *  node  
)

Adds node to the Override Group. If node is already part of another group it will be automatically removed first.

警告
The node to add must be a real scene node. Adding BaseOverride nodes is forbidden.
注意
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] node The node to add. The caller owns the pointed BaseList2D .

◆  RemoveFromGroup()

void RemoveFromGroup ( TakeData *  takeData ,
BaseList2D *  node  
)

Removes node from the Override Group.

注意
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] node The node to remove. If node is not part of the group the function returns. The caller owns the pointed node.

◆  AddTag()

BaseTag * AddTag ( TakeData *  takeData ,
Int32   type ,
BaseMaterial *  mat  
)

Adds a new tag of the given type to the Override Group if it is not already there.

警告
Only tags registered with flag TAG_ADDTOTAKEGROUP are accepted by the group.
注意
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] type The tag type to be added. If the tag is already in the group the function returns.
若 Ttexture the material can be assigned to mat .
[in] mat The optional material if passed type is Ttexture .
返回
The tag. The added one if created by the function or the one already in the group.

◆  RemoveTag()

void RemoveTag ( TakeData *  takeData ,
Int32   type  
)

Removes the tag of the given type from the Override Group.

注意
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] type The tag type to be removed. If the tag type is not in the Group the function returns.

◆  GetEditorMode()

Int32 GetEditorMode ( )

Returns the editor visibility mode for the Override Group.

返回
The editor mode: MODE

◆  GetRenderMode()

Int32 GetRenderMode ( )

Returns the render visibility mode for the Override Group.

返回
The render mode: MODE

◆  SetEditorMode()

void SetEditorMode ( Int32   mode )

Sets the editor visibility mode for the Override Group.

参数
[in] mode The editor mode to set: MODE

◆  SetRenderMode()

void SetRenderMode ( Int32   mode )

Sets the render visibility mode for the Override Group.

参数
[in] mode The render mode to set: MODE

◆  GetTag()

BaseTag * GetTag ( Int32   type )

Searches for a tag of the given type attached to the Override Group.

参数
[in] type The tag type to search for.
返回
The tag if found, otherwise nullptr .

◆  GetTake()

BaseTake * GetTake ( )

Returns the Take that owns the Override Group.

返回
The owner Take, or nullptr if any error.

◆  Find()

Bool Find ( TakeData *  takeData ,
BaseObject *  op  
)

Checks if an object is included in the Override Group.

参数
[in] takeData The Take System context. The caller owns the pointed TakeData .
[in] op The object to check. The caller owns the pointed BaseObject .
返回
true if the object is included in the Override Group, otherwise false .