c4d.modules.takesystem.BaseTake¶

class c4d.modules.takesystem.BaseTake¶: Represents a Take of the Take System.

It stores BaseOverride objects that define how a specific entity is changed in a Take.

Warning

This type cannot be instantiated.

New in version R17.032.

Methods Signatures

`BaseTake.IsMain(self)`	Checks if the Take is the Main Take.
`BaseTake.SearchHierarchy(self, op)`	Checks if the Take is a child of op.
`BaseTake.GetOverrides(self)`	Retrieves the Override nodes owned by the Take.
`BaseTake.GetOverrideGroups(self)`	Retrieves the Override Groups nodes owned by the Take.
`BaseTake.FindOrAddOverrideParam(self, takeData, node, ...)`	Searches if parameter with descID is Overridden. If not adds a new Override with passed overrideValue for the Take.
`BaseTake.OverrideNode(self, takeData, node, ...)`	Overrides all parameters of passed node in the Take.
`BaseTake.AutoTake(self, takeData, node, undo)`	Compares nodes and automatically generates overrides for different parameters in the Take.
`BaseTake.DeleteOverride(self, takeData, node, ...)`	Deletes a single parameter Override for node with descID.
`BaseTake.FindOverride(self, takeData, node)`	Searches if node is overridden in the Take.
`BaseTake.FindOverrideInHierarchy(self, takeData, node, ...)`	Searches if node parameter with descID is overridden in the Take or in a parent.
`BaseTake.AddOverrideGroup(self)`	Adds a new Override Group to the Take.
`BaseTake.GetFirstOverrideGroup(self)`	Gets the first Override Group in the Take.
`BaseTake.DeleteOverrideGroup(self, takeData, og)`	Deletes an Override Group from the Take.
`BaseTake.GetCamera(self, takeData)`	Gets the camera for the Take.
`BaseTake.GetEffectiveCamera(self, takeData)`	Gets the camera used by the Take even if it comes from a parent Take.
`BaseTake.SetCamera(self, takeData, camera)`	Sets the camera for the Take.
`BaseTake.GetRenderData(self, takeData)`	Gets the render data for the Take.
`BaseTake.GetEffectiveRenderData(self, takeData)`	Gets the render data used by the Take even if it comes from a parent Take.
`BaseTake.SetRenderData(self, takeData, rData)`	Sets the RenderData for the Take.
`BaseTake.IsChecked(self)`	Gets the mark status of the Take used for rendering and export operations.
`BaseTake.SetChecked(self, status)`	Sets the mark status of the Take used for rendering and export operations.
`BaseTake.Reset(self)`	Resets all sub-structures and Overrides for the Take.

Inheritance

Parent Class:

c4d.BaseList2D

Methods Documentation

BaseTake.IsMain(self)¶

Checks if the Take is the Main Take.

Return type: bool
Returns: True if the Take is the Main Take, otherwise False.

BaseTake.SearchHierarchy(self, op)¶

Checks if the Take is a child of op.

Parameters: op (c4d.modules.takesystem.BaseTake) – The Take to search within his hierarchy.
Return type: bool
Returns: True if the Take is child of op, otherwise False.

BaseTake.GetOverrides(self)¶

Retrieves the Override nodes owned by the Take.

Return type: list of BaseOverride
Returns: The Override nodes.

BaseTake.GetOverrideGroups(self)¶

Retrieves the Override Groups nodes owned by the Take.

Return type: list of BaseOverrideGroup
Returns: The Override Groups nodes.

BaseTake.FindOrAddOverrideParam(self, takeData, node, descID, overrideValue, backupValue=None, deleteAnim=False)¶

Searches if parameter with descID is Overridden. If not adds a new Override with passed overrideValue for the Take.

If the BaseOverride node does not exist the function automatically allocates and inserts it, plus takes care to backup data properly in parent or Main Take.

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 scene node to override.
descID (c4d.DescID) – The parameter to override.
overrideValue (any) – The initial value to set in the Overrides for the Take.
backupValue (any) – Optionally provide the backup value for the Main/parent Take. Mandatory to set this for parameters not from the GUI.
deleteAnim (bool) – If True and original parameter in the scene is animated the animation will be removed in the resulting Override.

Return type

c4d.modules.takesystem.BaseOverride

Returns

The found or newly created Override node.

BaseTake.OverrideNode(self, takeData, node, deleteAnim)¶

Overrides all parameters of passed node in the Take.

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 scene node to override.
deleteAnim (bool) – If True and original parameter in the scene is animated the animation will be removed in the resulting Override.

Return type

c4d.modules.takesystem.BaseOverride

Returns

The newly created Override node.

BaseTake.AutoTake(self, takeData, node, undo)¶

Compares nodes and automatically generates overrides for different parameters in the Take.

Parameters

takeData (c4d.modules.takesystem.TakeData) – The Take System context.
node (c4d.BaseList2D) – The scene node to override.
undo (c4d.BaseList2D) – The node to compare with.

BaseTake.DeleteOverride(self, takeData, node, descID)¶

Deletes a single parameter Override for node with descID.

If the Override results empty (no more overridden parameters) then it will be deleted too.

Parameters

takeData (c4d.modules.takesystem.TakeData) – The Take System context.
node (c4d.BaseList2D) – The scene node to delete the parameter for.
descID (c4d.DescID) – The parameter Override to be deleted.

BaseTake.FindOverride(self, takeData, node)¶

Searches if node is overridden in the Take.

Parameters

takeData (c4d.modules.takesystem.TakeData) – The Take System context.
node (c4d.BaseList2D) – The scene node to search the Override for.

Return type

c4d.modules.takesystem.BaseOverride

Returns

The Override if found, otherwise None.

BaseTake.FindOverrideInHierarchy(self, takeData, node, descID)¶

Searches if node parameter with descID is overridden in the Take or in a parent.

Parameters

takeData (c4d.modules.takesystem.TakeData) – The Take System context.
node (c4d.BaseList2D) – The node to search the Override for.
descID (c4d.DescID) – The parameter to search for.

Return type

tuple(BaseOverride, BaseTake)

Returns

The Override if found and the Take that owns it.

BaseTake.AddOverrideGroup(self)¶

Adds a new Override Group to the Take.

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

Return type: c4d.modules.takesystem.BaseOverrideGroup
Returns: The added Override Group.

BaseTake.GetFirstOverrideGroup(self)¶

Gets the first Override Group in the Take.

Return type: c4d.modules.takesystem.BaseOverrideGroup
Returns: The first Override Group, or None if there is none.

BaseTake.DeleteOverrideGroup(self, takeData, og)¶

Deletes an Override Group from the Take.

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.
og (c4d.modules.takesystem.BaseOverrideGroup) – The Override Group to be deleted.

BaseTake.GetCamera(self, takeData)¶

Gets the camera for the Take.

Note

Can return the default camera.

Parameters: takeData (c4d.modules.takesystem.TakeData) – The Take System context.
Return type: c4d.BaseObject
Returns: The camera assigned to the Take, or None if the Take uses the camera from a parent Take.

BaseTake.GetEffectiveCamera(self, takeData)¶

Gets the camera used by the Take even if it comes from a parent Take.

Note

Can return the default camera.

Parameters: takeData (c4d.modules.takesystem.TakeData) – The Take System context.
Return type: tuple(BaseObject, BaseTake)
Returns: The camera used by the Take and the Take it comes from.

BaseTake.SetCamera(self, takeData, camera)¶

Sets the camera for the Take.

Note

Can be the default camera.

Parameters

takeData (c4d.modules.takesystem.TakeData) – The Take System context.
camera (c4d.BaseObject) – The camera to set, or None to reset and use one from a parent Take.

BaseTake.GetRenderData(self, takeData)¶

Gets the render data for the Take.

Parameters: takeData (c4d.modules.takesystem.TakeData) – The Take System context.
Return type: c4d.documents.RenderData
Returns: The RenderData assigned to the Take, or None if the Take uses the RenderData from a parent Take.

BaseTake.GetEffectiveRenderData(self, takeData)¶

Gets the render data used by the Take even if it comes from a parent Take.

Parameters: takeData (c4d.modules.takesystem.TakeData) – The Take System context.
Return type: tuple(RenderData, BaseTake)
Returns: The render data used by the Take and the Take it comes from.

BaseTake.SetRenderData(self, takeData, rData)¶

Sets the RenderData for the Take.

Parameters

takeData (c4d.modules.takesystem.TakeData) – The Take System context.
rData (c4d.documents.RenderData) – The render data to set, or None to reset and use one from a parent Take.

BaseTake.IsChecked(self)¶

Gets the mark status of the Take used for rendering and export operations.

Return type: tuple(RenderData, BaseTake)
Returns: True if the Take is marked, otherwise False.

BaseTake.SetChecked(self, status)¶

Sets the mark status of the Take used for rendering and export operations.

Parameters: status (bool) – If True the Take is marked, otherwise the mark is removed.

BaseTake.Reset(self)¶: Resets all sub-structures and Overrides for the Take.

Warning

All data not in the current state of the document are deleted.