BaseOverride Class Reference

#include <lib_takesystem.h>

Inheritance diagram for BaseOverride:

Detailed Description

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

See also
The BaseOverride Manual overview article.

Private Member Functions

 BaseOverride ()
 
 ~BaseOverride ()
 

Navigation

BaseOverrideGetNext () const
 
BaseOverrideGetPred () const
 
BaseOverrideGetUp () const
 
BaseOverrideGetDown () const
 
BaseOverrideGetDownLast () const
 

Miscellaneous

Bool IsOverriddenParam (const DescID &descID)
 
BaseList2DGetSceneNode ()
 
BaseTakeGetOwnerTake (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
BaseList2DGetNext (void)
 
BaseList2DGetPred (void)
 
void SetBit (Int32 mask)
 
Bool GetBit (Int32 mask) const
 
void DelBit (Int32 mask)
 
void ToggleBit (Int32 mask)
 
Int32 GetAllBits (void) const
 
void SetAllBits (Int32 bits)
 
BaseContainer GetData (void)
 
void SetData (const BaseContainer &bc, Bool add=true)
 
const BaseContainerGetDataInstance (void) const
 
BaseContainerGetDataInstance (void)
 
const BaseContainerGetDataInstanceRef (void) const
 
BaseContainerGetDataInstanceRef (void)
 
const StringGetName (void) const
 
void SetName (const String &name)
 
String GetBubbleHelp (void)
 
Bool TransferGoal (BaseList2D *dst, Bool undolink)
 
Bool TransferMarker (BaseList2D *dst) const
 
Bool Scale (Float scale)
 
Bool Edit (void)
 
void GetIcon (IconData *dat)
 
GeListHeadGetNLARoot (void)
 
BaseList2DAnimationLayerRemap (BaseObject **layer=nullptr)
 
const StringGetTypeName (void)
 
BaseList2DGetMain (void) 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
 
GeListHeadGetOverrideRoot (void)
 
BaseOverrideGetFirstOverride (void)
 
GeListHeadGetShaderRepositoryRoot (void)
 
void GetMarkerStampEx (UInt32 *l1, UInt32 *l2)
 
const GeMarkerGetMarker (void) 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)
 
BaseShaderGetFirstShader () const
 
void InsertShader (BaseShader *shader, BaseShader *pred=nullptr)
 
void ClearKeyframeSelection ()
 
Bool FindKeyframeSelection (const DescID &id)
 
Bool SetKeyframeSelection (const DescID &id, Bool selection)
 
Bool KeyframeSelectionContent ()
 
LayerObjectGetLayerObject (BaseDocument *doc)
 
Bool SetLayerObject (LayerObject *layer)
 
const LayerDataGetLayerData (BaseDocument *doc, Bool rawdata=false)
 
Bool SetLayerData (BaseDocument *doc, const LayerData &data)
 
GeListHeadGetCTrackRoot (void)
 
CTrackGetFirstCTrack (void)
 
CTrackFindCTrack (const DescID &id)
 
- Public Member Functions inherited from GeListNode
GeListNodeGetNext (void)
 
GeListNodeGetPred (void)
 
GeListNodeGetDown (void)
 
GeListNodeGetUp (void)
 
GeListNodeGetDownLast (void)
 
void InsertBefore (GeListNode *bl)
 
void InsertAfter (GeListNode *bl)
 
void InsertUnder (GeListNode *bl)
 
void InsertUnderLast (GeListNode *bl)
 
void Remove (void)
 
GeListHeadGetListHead (void)
 
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)
 
GeListNodeGetCustomData (void)
 
BaseDocumentGetDocument (void)
 
Int32 GetBranchInfo (BranchInfo *info, Int32 max, GETBRANCHINFO flags)
 
Bool IsDocumentRelated (void)
 
Int32 GetInfo (void)
 
Bool GetNBit (NBIT bit) const
 
Bool ChangeNBit (NBIT bit, NBITCONTROL bitmode)
 
- Public Member Functions inherited from C4DAtom
Int32 GetType (void) const
 
Int32 GetRealType (void) const
 
Int32 GetDiskType (void) const
 
Bool IsInstanceOf (Int32 id) const
 
Int32 GetClassification (void) const
 
Bool Message (Int32 type, void *data=nullptr)
 
Bool MultiMessage (MULTIMSG_ROUTE flags, Int32 type, void *data)
 
C4DAtomGetClone (COPYFLAGS flags, AliasTrans *trn)
 
Bool CopyTo (C4DAtom *dst, COPYFLAGS flags, AliasTrans *trn)
 
Bool Read (HyperFile *hf, Int32 id, Int32 level)
 
Bool Write (HyperFile *hf)
 
Bool ReadObject (HyperFile *hf, Bool readheader)
 
Bool WriteObject (HyperFile *hf)
 
Bool GetDescription (Description *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)
 
DynamicDescriptionGetDynamicDescription ()
 
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 BaseList2DAlloc (Int32 type)
 
static void Free (BaseList2D *&bl)
 

Constructor & Destructor Documentation

§ BaseOverride()

BaseOverride ( )
private

§ ~BaseOverride()

~BaseOverride ( )
private

Member Function Documentation

§ GetNext()

BaseOverride* GetNext ( void  ) const

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

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

§ GetPred()

BaseOverride* GetPred ( void  ) const

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

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

§ GetUp()

BaseOverride* GetUp ( void  ) const

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

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

§ GetDown()

BaseOverride* GetDown ( void  ) const

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

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

§ GetDownLast()

BaseOverride* GetDownLast ( void  ) const

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

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

Parameters
[in]descIDThe parameter to be checked.
Returns
true if parameter is overridden, otherwise false.

§ GetSceneNode()

BaseList2D* GetSceneNode ( )

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

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

Parameters
[in]takeDataThe Take System context. The caller owns the pointed TakeData.
Returns
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.

Parameters
[in]takeDataThe Take System context. The caller owns the pointed TakeData.
[out]resGroupThe assigned BaseOverrideGroup. nullptr if the function returns false. Cinema 4D owns the pointed BaseOverrideGroup.
Returns
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.

Note
Sub-descriptions are included if overridden.
Parameters
[out]resultThe array to be filled.
Returns
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.

Note
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).
Parameters
[in]takeDataThe Take System context. The caller owns the pointed TakeData.
[in]descIDThe DescID of the edited parameter.