BaseOverrideGroup Class Reference

#include <c4d_baseoverridegroup.h>

Inheritance diagram for BaseOverrideGroup:

Public Types

typedef BaseList2D SUPER
 
- Public Types inherited from BaseList2D
typedef GeListNode SUPER
 
- Public Types inherited from GeListNode
typedef PrivateChunk SUPER
 

Public Member Functions

virtual Bool IsInstanceOf (cineware::Int32 id) const
 
- Public Member Functions inherited from BaseList2D
 BaseList2D ()
 
virtual ~BaseList2D ()
 
BaseList2D * GetNext ()
 
BaseList2D * GetPred ()
 
NodeData * GetNodeData ()
 
void SetNodeData (NodeData *data)
 
void SetBit (Int32 mask)
 
Bool GetBit (Int32 mask)
 
void DelBit (Int32 mask)
 
void ToggleBit (Int32 mask)
 
Int32 GetAllBits ()
 
void SetAllBits (Int32 bits)
 
BaseContainer GetData ()
 
BaseContainer * GetDataInstance ()
 
BaseContainer & GetDataInstanceRef ()
 
const String & GetName ()
 
void SetName (const String &new_name)
 
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
 
BaseShader * GetFirstShader ()
 
Bool InsertShader (BaseShader *shader, BaseShader *pred=nullptr)
 
Bool InsertShaderLast (BaseShader *shader)
 
RootCTrack * GetCTrackRoot ()
 
CTrack * GetFirstCTrack ()
 
CTrack * FindCTrack (const DescID &id)
 
Bool AppendCTrack (CTrack *t)
 
void InsertTrackSorted (CTrack *track)
 
virtual Int32 GetType () const
 
virtual Int32 GetDiskType () const
 
LayerObject * GetLayerObject ()
 
void SetLayerObject (LayerObject *layer)
 
const LayerData * GetLayerData (BaseDocument *doc, Bool rawdata=false)
 
Bool SetLayerData (BaseDocument *doc, const LayerData &data)
 
virtual BaseList2D * GetClone (COPYFLAGS flags, AliasTrans *trans)
 
DynamicDescription * GetDynamicDescription ()
 
virtual Bool IsBaseList ()
 
virtual void Remove ()
 
Bool SetDescIDState (const DescID &id, DESCIDSTATE descidstate)
 
DESCIDSTATE GetDescIDState (const DescID &id, Bool tolerant) const
 
RootPluginNode * GetOverrideRoot ()
 
BaseOverride * GetFirstOverride ()
 
virtual Bool TranslateDescID (const DescID &id, DescID &res_id, GeListNode *&res_at)
 
- Public Member Functions inherited from GeListNode
 GeListNode ()
 
 ~GeListNode ()
 
virtual Bool GetNBit (Int32 bit) const
 
virtual Bool ChangeNBit (NBIT bit, NBITCONTROL bitmode)
 
BaseDocument * GetDocument ()
 
virtual Int32 GetInfo ()
 
GeListNode * GetPred ()
 
GeListNode * GetNext ()
 
GeListNode * GetUp ()
 
GeListNode * GetDown ()
 
GeListNode * GetDownLast ()
 
void InsertBefore (GeListNode *op)
 
void InsertAfter (GeListNode *op)
 
void Remove ()
 
void InsertUnder (GeListNode *op)
 
void InsertUnderLast (GeListNode *op)
 
RootList2D * GetListHead ()
 
Int32 GetNodeID (Int32 index=0) const
 
- Public Member Functions inherited from PrivateChunk
 PrivateChunk ()
 
Bool ReadChunk (HyperFile *hf, Bool keepin=false, Bool noheader=false)
 
virtual Bool IsListHead ()
 
Bool ReadObject (HyperFile *hf, Bool readheader)
 
Bool WriteObject (HyperFile *hf, Int32 type)
 
Bool CopyTo (PrivateChunk *dest, COPYFLAGS flags, AliasTrans *trans)
 
Bool GetParameter (Int32 id, GeData &data)
 
Bool SetParameter (Int32 id, const GeData &data)
 
Bool GetParameter (const DescID &id, GeData &data)
 
Bool SetParameter (const DescID &id, const GeData &data)
 
virtual Int32 GetChunkLevel ()
 
- Public Member Functions inherited from GeTempPublicNode2D< PrivateChunk >
PrivateChunk * GetNext () const
 
PrivateChunk * GetPrev () const
 
void InsertBefore (PrivateChunk *n)
 
void InsertAfter (PrivateChunk *n)
 
void Remove ()
 

Navigation

BaseOverrideGroup * GetNext ()
 
BaseOverrideGroup * GetPred ()
 

Visibility Modes

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

Miscellaneous

BaseTag * GetTag (Int32 type)
 
BaseTake * GetTake ()
 
Bool Find (TakeData *takeData, BaseObject *op)
 

Additional Inherited Members

- Protected Member Functions inherited from BaseList2D
void SetID (Int32 id)
 
virtual Bool HandleSubChunk (HyperFile *hf, Int32 id, Int32 level)
 
virtual Bool Write (HyperFile *hf)
 
virtual Bool GetDParameter (const DescID &id, GeData &data)
 
virtual Bool SetDParameter (const DescID &id, const GeData &data)
 
virtual Bool CopyToX (PrivateChunk *dest, COPYFLAGS flags, AliasTrans *trans)
 
virtual Int32 GetInstanceType () const
 
- Protected Attributes inherited from BaseList2D
Int32 m_id
 
RootShader mp_rootshader
 
RootShader mp_rootshader_hidden
 
RootShader root_shader_repository
 
Int32 l_bitfeld
 
RootCTrack mp_rootctrack
 
RootPluginNode root_override
 
NotifyList * notify_events
 
DescIdStore * keyframestore
 
DescIdStore * propstore
 
BaseContainer m_bc
 
NodeData * m_data
 
- Protected Attributes inherited from GeListNode
GeAliasGoal m_xgoal
 
UInt32 m_bits [4]
 
RootList2D * t_rootlist_parent
 
RootList2D * m_children
 
BaseDocument * parent_doc
 
void * unknownData
 
Int unknownDataSize
 
Int32 unknownDataLevel
 
Int32 pluginID
 

Detailed Description

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

See also
The Take System Overview articles in the C++ SDK documentation.
Since
17.008

Member Typedef Documentation

◆ SUPER

typedef BaseList2D SUPER

Member Function Documentation

◆ IsInstanceOf()

virtual Bool IsInstanceOf ( cineware::Int32  id) const
virtual

Reimplemented from BaseList2D.

◆ GetNext()

BaseOverrideGroup* GetNext ( )

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

Returns
The next Override group, or nullptr if there is none. Cineware SDK owns the pointed BaseOverrideGroup.

◆ GetPred()

BaseOverrideGroup* GetPred ( )

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

Returns
The previous Override group, or nullptr if there is none. Cineware SDK owns the pointed BaseOverrideGroup.

◆ GetEditorMode()

Int32 GetEditorMode ( )

Returns the editor visibility mode for the Override Group.

Returns
The editor mode.

◆ GetRenderMode()

Int32 GetRenderMode ( )

Returns the render visibility mode for the Override Group.

Returns
The render mode.

◆ SetEditorMode()

void SetEditorMode ( Int32  mode)

Sets the editor visibility mode for the Override Group.

Parameters
[in]modeThe editor mode to set.

◆ SetRenderMode()

void SetRenderMode ( Int32  mode)

Sets the render visibility mode for the Override Group.

Parameters
[in]modeThe render mode to set.

◆ GetTag()

BaseTag* GetTag ( Int32  type)

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

Parameters
[in]typeThe tag type to search for.
Returns
The tag if found, otherwise nullptr.

◆ GetTake()

BaseTake* GetTake ( )

Returns the Take that owns the Override Group.

Returns
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.

Parameters
[in]takeDataThe Take System context. The caller owns the pointed TakeData.
[in]opThe object to check. The caller owns the pointed BaseObject.
Returns
true if the object is included in the Override Group, otherwise false.