c4d.LayerSet

New in version R13.029.

This data type allows to access the layers of materials.

Definition

class c4d.LayerSet

• LayerSet.__init__()

• LayerSet.Content()

• LayerSet.IsLayerEnabled()

• LayerSet.FindLayerSet()

• LayerSet.GetName()

• LayerSet.GetMode()
• LayerSet.SetMode()

• LayerSet.RemoveLayer()
• LayerSet.AddLayer()
• LayerSet.FlushLayers()

• LayerSet.GetPreviewMode()
• LayerSet.SetPreviewMode()

• LayerSet.CopyTo()

Inheritance

• c4d.CustomDataType
  • c4d.LayerSet

Members

LayerSet.__init__([v])

Parameters: v (LayerSet) – Source layer set for copy constructor. Return type: LayerSet Returns: The layer set instance.

LayerSet.Content()

Check if the set is empty.

Return type: bool Returns: True if the set contains any layer, otherwise False.

LayerSet.IsLayerEnabled(name)

Check if a layer is enabled.

Parameters: name (str) – The layer name to check for. Return type: bool Returns: True if the layer is enabled, otherwise False.

LayerSet.FindLayerSet(name)

Check if a layer is in the set.

Parameters: name (str) – The layer name to check for. Return type: bool Returns: True if the layer is in the set, otherwise False.

LayerSet.GetName()

Get the set’s name.

Return type: str Returns: The name of the set.

LayerSet.GetMode()

Returns the layer set mode.

Return type: int Returns: The mode:

LAYERSETMODE_LAYERS	Layers / Layer Sets.
LAYERSETMODE_LAYERMASKS	Layer Masks.
LAYERSETMODE_ALPHAS	Alpha Channels.
LAYERSETMODE_LAYERALPHA	Layer Alpha.
LAYERSETMODE_DISABLED	Disabled.

LayerSet.SetMode(mode)

Assign a new layer set mode.

Parameters: mode (int) –

The mode:

LAYERSETMODE_LAYERS	Layers / Layer Sets.
LAYERSETMODE_LAYERMASKS	Layer Masks.
LAYERSETMODE_ALPHAS	Alpha Channels.
LAYERSETMODE_LAYERALPHA	Layer Alpha.
LAYERSETMODE_DISABLED	Disabled.

LayerSet.RemoveLayer(layer)

Remove a layer.

Parameters: layer (str) – The layer to remove.

LayerSet.AddLayer(layer)

Add a layer.

Parameters: layer (str) – The layer to add.

LayerSet.FlushLayers()

Flush all layers.

LayerSet.GetPreviewMode()

Return the preview mode.

Return type: int Returns: The preview mode.

LayerSet.SetPreviewMode(s)

Set the preview mode.

Parameters: s (int) – The new preview mode.

LayerSet.CopyTo(dst)

Copies the content from self to dst.

Parameters: dst (LayerSet) – The destination layer set.