c4d.modules.takesystem.BaseOverride

class c4d.modules.takesystem.BaseOverride

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

Warning

This type cannot be instantiated.

New in version R17.032.

Methods Signatures

BaseOverride.IsOverriddenParam()

Checks if the parameter at descID is overridden.

BaseOverride.GetSceneNode()

Retrieves the original scene node connected to the Override node.

BaseOverride.GetOwnerTake()

Gets the Take that owns the Override.

BaseOverride.IsInGroup()

Checks if the Override is also part of an Override Group, and if yes returns the group.

BaseOverride.GetAllOverrideDescID()

Retrieves the DescID of all parameters in the Override.

BaseOverride.UpdateSceneNode()

Updates the scene node whenever data is directly changed on the base Override (for example with C4DAtom.SetParameter()).

Inheritance

Parent Class:

Methods Documentation

BaseOverride.IsOverriddenParam(self, descID)

Checks if the parameter at descID is overridden.

Parameters

descID (c4d.DescID) – The parameter to be checked.

Return type

bool

Returns

True if parameter is overridden, otherwise False.

BaseOverride.GetSceneNode(self)

Retrieves the original scene node connected to the Override node.

Return type

c4d.BaseList2D

Returns

The original scene node.

BaseOverride.GetOwnerTake(self, takeData)

Gets the Take that owns the Override.

Parameters

takeData (c4d.modules.takesystem.TakeData) – The Take System context.

Return type

c4d.modules.takesystem.BaseTake

Returns

The Take for the Override.

BaseOverride.IsInGroup(self, takeData)

Checks if the Override is also part of an Override Group, and if yes returns the group.

Parameters

takeData (c4d.modules.takesystem.TakeData) – The Take System context.

Return type

Tuple[bool, c4d.modules.takesystem.BaseOverrideGroup]

Returns

True if the Override is part of an Override Group, otherwise False.

BaseOverride.GetAllOverrideDescID(self)

Retrieves the DescID of all parameters in the Override.

Note

Sub-descriptions are included if overridden.

Return type

List[c4d.DescID]

Returns

The DescID of all overridden parameters.

BaseOverride.UpdateSceneNode(self, takeData, descID)
Updates the scene node whenever data is directly changed on the base Override (for example with C4DAtom.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