#include <lib_takesystem.h>

Inheritance diagram for BaseOverride:

[legend]

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
BaseOverride *	GetNext () const

BaseOverride *	GetPred () const

BaseOverride *	GetUp () const

BaseOverride *	GetDown () const

BaseOverride *	GetDownLast () const

Miscellaneous
Bool	IsOverriddenParam (const DescID &descID) const

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)

maxon::Result< GeData >	GetOverrideParam (const DescID &dataID) const

maxon::Result< void >	SetOverrideParam (const DescID &dataID, const GeData &d)

Additional Inherited Members
Public Member Functions inherited from BaseList2D
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)

const Char *	GetViewportRenderId (VIEWPORT_RENDER_ID typeId) const

BaseList2D *	GetNext ()

const BaseList2D *	GetNext () const

BaseList2D *	GetPred ()

const BaseList2D *	GetPred () const

BaseContainer	GetData ()

void	SetData (const BaseContainer &bc, Bool add=true)

const BaseContainer &	GetDataInstanceRef () const

BaseContainer &	GetDataInstanceRef ()

const BaseContainer *	GetDataInstance () const

BaseContainer *	GetDataInstance ()

String	GetName () const

void	SetName (const maxon::String &name, Bool setDirty=true)

String	GetBubbleHelp ()

Bool	TransferGoal (BaseList2D *dst, Bool undolink)

Bool	TransferMarker (BaseList2D *dst) const

Bool	CopyDynamicDescriptionFrom (const BaseList2D *src)

Bool	Scale (Float scale)

Bool	Edit ()

void	GetIcon (IconData *dat)

GeListHead *	GetNLARoot (Bool create)

BaseList2D *	AnimationLayerRemap (BaseObject **layer=nullptr)

String	GetTypeName () const

BaseList2D *	GetMain () const

void	InsertTrackSorted (CTrack *track)

Bool	AddEventNotification (BaseList2D bl, NOTIFY_EVENT eventid, NOTIFY_EVENT_FLAG flags, const BaseContainer data)

Bool	RemoveEventNotification (const BaseDocument doc, BaseList2D bl, NOTIFY_EVENT eventid)

Bool	FindEventNotification (const BaseDocument doc, BaseList2D bl, NOTIFY_EVENT eventid)

Bool	SetDescIDState (const DescID &id, DESCIDSTATE descidstate)

DESCIDSTATE	GetDescIDState (const DescID &id, Bool tolerant) const

GeListHead *	GetOverrideRoot (Bool create)

BaseOverride *	GetFirstOverride ()

GeListHead *	GetShaderRepositoryRoot (Bool create)

GeListHead *	GetHiddenShaderRoot (Bool create)

maxon::NimbusForwardRef	GetNimbusRef (const maxon::Id &spaceId) const

maxon::Result< maxon::NimbusForwardRef >	PrivateGetOrCreateNimbusRef (const maxon::Id &spaceId)

void	RemoveNimbusRef (const maxon::Id &spaceId)

maxon::Result< maxon::HashMap< maxon::Id, maxon::NimbusForwardRef > >	GetAllNimbusRefs () const

Bool	IsNodeBased () const

maxon::Result< Bool >	GetAccessedObjects (METHOD_ID method, AccessedObjectsCallback &access) const

maxon::Result< Bool >	GetAccessedObjectsRec (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, Bool withSiblings, Bool withChildren, AccessedObjectsCallback &access) const

maxon::Result< Bool >	GetAccessedObjectsOfHierarchy (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const

maxon::Result< Bool >	GetAccessedObjectsOfChildren (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const

maxon::Result< Bool >	GetAccessedObjectsOfFirstChildHierarchy (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const

maxon::Result< maxon::GenericData >	GroupChanges ()

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 (const 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) const

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 (const BaseDocument *doc)

const LayerObject *	GetLayerObject (const BaseDocument *doc) const

Bool	SetLayerObject (const LayerObject *layer)

const LayerData *	GetLayerData (const BaseDocument *doc, Bool rawdata=false) const

Bool	SetLayerData (BaseDocument *doc, const LayerData &data)

GeListHead *	GetCTrackRoot (Bool create)

const GeListHead *	GetCTrackRoot () const

CTrack *	GetFirstCTrack ()

const CTrack *	GetFirstCTrack () const

CTrack *	FindCTrack (const DescID &id)

const CTrack *	FindCTrack (const DescID &id) const

Public Member Functions inherited from GeListNode
GeListNode *	GetNext ()

const GeListNode *	GetNext () const

GeListNode *	GetPred ()

const GeListNode *	GetPred () const

GeListNode *	GetDown ()

const GeListNode *	GetDown () const

GeListNode *	GetUp ()

const GeListNode *	GetUp () const

GeListNode *	GetDownLast ()

const GeListNode *	GetDownLast () const

void	InsertBefore (GeListNode *bl)

void	InsertAfter (GeListNode *bl)

void	InsertUnder (GeListNode *bl)

void	InsertUnderLast (GeListNode *bl)

void	Remove ()

void	FlushChilds ()

void	MoveChildrenTo (GeListNode *dest)

GeListHead *	GetListHead ()

const GeListHead *	GetListHead () const

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 ()

const GeListNode *	GetCustomData () const

const BaseDocument *	GetDocument () const

BaseDocument *	GetDocument ()

maxon::Result< Bool >	GetBranchInfo (const maxon::ValueReceiver< const BranchInfo & > &info, GETBRANCHINFO flags) const

Bool	IsDocumentRelated () const

Int32	GetInfo () const

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	Message (Int32 type, void *data=nullptr)

Bool	MultiMessage (MULTIMSG_ROUTE flags, Int32 type, void *data)

C4DAtom *	GetClone (COPYFLAGS flags, AliasTrans *trn) const

Bool	CopyTo (C4DAtom dst, COPYFLAGS flags, AliasTrans trn) const

Bool	Read (HyperFile *hf, Int32 id, Int32 level)

Bool	Write (HyperFile *hf) const

Bool	ReadObject (HyperFile *hf, Bool readheader)

Bool	WriteObject (HyperFile *hf) const

Bool	GetDescription (Description *description, DESCFLAGS_DESC flags) const

Bool	GetParameter (const DescID &id, GeData &t_data, DESCFLAGS_GET flags) const

Bool	SetParameter (const DescID &id, const GeData &t_data, DESCFLAGS_SET flags)

DynamicDescription *	GetDynamicDescriptionWritable ()

const DynamicDescription *	GetDynamicDescription () const

Bool	CopyDynamicDescriptionFrom (const BaseList2D *src)

Bool	GetEnabling (const DescID &id, const GeData &t_data, DESCFLAGS_ENABLE flags, const BaseContainer *itemdesc) const

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

Constructor & Destructor Documentation

◆ BaseOverride()

BaseOverride ( )

private

◆ ~BaseOverride()

~BaseOverride ( )

private

Member Function Documentation

◆ GetNext()

BaseOverride* GetNext ( ) 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 ( ) 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 ( ) 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 ( ) 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 ( ) 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 ) const

Checks if the parameter at descID is overridden.

Parameters

[in] descID The 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] takeData The 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]	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.

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] result The 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]	takeData	The Take System context. The caller owns the pointed TakeData.
[in]	descID	The DescID of the edited parameter.

◆ GetOverrideParam()

maxon::Result<GeData> GetOverrideParam ( const DescID & dataID ) const

Gets the value that is overridded at ID pIdx.

Parameters

[in] dataID ID of the overridden data.

Returns: The data at the given index.

◆ SetOverrideParam()

maxon::Result<void> SetOverrideParam	(	const DescID &	dataID,
		const GeData &	d
	)

Sets the value that is overridded at index pIdx.

Parameters

[in]	dataID	ID of the overridden data.
[in]	d	New value to set. return OK on success.

Detailed Description

Private Member Functions

Navigation

Miscellaneous

Additional Inherited Members

Constructor & Destructor Documentation

◆ BaseOverride()

◆ ~BaseOverride()

Member Function Documentation

◆ GetNext()

◆ GetPred()

◆ GetUp()

◆ GetDown()

◆ GetDownLast()

◆ IsOverriddenParam()

◆ GetSceneNode()

◆ GetOwnerTake()

◆ IsInGroup()

◆ GetAllOverrideDescID()

◆ UpdateSceneNode()

◆ GetOverrideParam()

◆ SetOverrideParam()