c4d.modules.takesystem.BaseOverrideGroup¶

class c4d.modules.takesystem.BaseOverrideGroup¶: An Override Group manages the values of multiple objects in a Take.

Warning

This type cannot be instantiated.

New in version R17.032.

Parent Class:

c4d.BaseList2D

Overview¶

`BaseOverrideGroup.GetObjectsInGroup`	Retrieves all the objects in the group.
`BaseOverrideGroup.AddToGroup`	Adds node to the Override Group. If node is already part of another group it will be automatically removed first.
`BaseOverrideGroup.RemoveFromGroup`	Removes node from the Override Group.
`BaseOverrideGroup.AddTag`	Adds a new tag of the given type to the Override Group if it is not already there.
`BaseOverrideGroup.RemoveTag`	Removes the tag of the given type from the Override Group.
`BaseOverrideGroup.GetEditorMode`	Returns the editor visibility mode for the Override Group.
`BaseOverrideGroup.GetRenderMode`	Returns the render visibility mode for the Override Group.
`BaseOverrideGroup.SetEditorMode`	Sets the editor visibility mode for the Override Group.
`BaseOverrideGroup.SetRenderMode`	Sets the render visibility mode for the Override Group.
`BaseOverrideGroup.GetTag`	Searches for a tag of the given type attached to the Override Group.
`BaseOverrideGroup.GetTake`	Returns the Take that owns the Override Group.
`BaseOverrideGroup.Find`	Checks if an object is included in the Override Group.

Members¶

BaseOverrideGroup.GetObjectsInGroup(self)¶

Retrieves all the objects in the group.

Return type: List[c4d.BaseList2D]
Returns: The objects in the group.

BaseOverrideGroup.AddToGroup(self, takeData, node)¶

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

Warning

The node to add must be a real scene node. Adding BaseOverride nodes is forbidden.

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

takeData (c4d.modules.takesystem.TakeData) – The Take System context.
node (c4d.BaseList2D) – The node to add.

BaseOverrideGroup.RemoveFromGroup(self, takeData, node)¶

Removes node from the Override Group.

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

takeData (c4d.modules.takesystem.TakeData) – The Take System context.
node (c4d.BaseList2D) – The node to remove. If it is not part of the group the function returns.

BaseOverrideGroup.AddTag(self, takeData, type, mat)¶

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

Warning

Only tags registered with the flag TAG_ADDTOTAKEGROUP are accepted by the group.

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

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

The tag type to be added. If the tag is already in the group the function returns.

If Ttexture the material can be assigned to mat.
mat (Optional[c4d.modules.takesystem.TakeData]) – The optional material (can be None) if passed type is Ttexture.

Return type

c4d.BaseTag

Returns

The tag. The added one if created by the function or the one already in the group.

BaseOverrideGroup.RemoveTag(self, takeData, type)¶

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

Parameters

takeData (c4d.modules.takesystem.TakeData) – The Take System context.
type (int) – The tag type to be removed. If it is not in the Group the function returns.

BaseOverrideGroup.GetEditorMode(self)¶

Returns the editor visibility mode for the Override Group.

Return type

int

Returns

The editor mode:

MODE_ON	The object is enabled regardless of the state of any parent object.
MODE_OFF	The object is disabled regardless of the state of any parent object.
MODE_UNDEF	The object is enabled by default, but the state of any parent object is used if it is enabled or disabled.

BaseOverrideGroup.GetRenderMode(self)¶

Returns the render visibility mode for the Override Group.

Return type

int

Returns

The render mode:

MODE_ON	The object is enabled regardless of the state of any parent object.
MODE_OFF	The object is disabled regardless of the state of any parent object.
MODE_UNDEF	The object is enabled by default, but the state of any parent object is used if it is enabled or disabled.

BaseOverrideGroup.SetEditorMode(self, mode)¶

Sets the editor visibility mode for the Override Group.

Parameters

type (int) –

The editor mode to set:

MODE_ON	The object is enabled regardless of the state of any parent object.
MODE_OFF	The object is disabled regardless of the state of any parent object.
MODE_UNDEF	The object is enabled by default, but the state of any parent object is used if it is enabled or disabled.

BaseOverrideGroup.SetRenderMode(self, mode)¶

Sets the render visibility mode for the Override Group.

Parameters

type (int) –

The render mode to set:

MODE_ON	The object is enabled regardless of the state of any parent object.
MODE_OFF	The object is disabled regardless of the state of any parent object.
MODE_UNDEF	The object is enabled by default, but the state of any parent object is used if it is enabled or disabled.

BaseOverrideGroup.GetTag(self, type)¶

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

Parameters: type (int) – The tag type to search for.
Return type: Optional[c4d.BaseTag]
Returns: The tag if found, otherwise None.

BaseOverrideGroup.GetTake(self)¶

Returns the Take that owns the Override Group.

Return type: c4d.modules.takesystem.BaseTake
Returns: The Take for the Override Group.

BaseOverrideGroup.Find(self, takeData, op)¶

Checks if an object is included in the Override Group.

Parameters

takeData (c4d.modules.takesystem.TakeData) – The Take System context.
op (c4d.BaseObject) – The object to check.

Return type

bool

Returns

True if the object is included in the Override Group, otherwise False.