c4d.modules.sculpting.SculptLayerBase

class c4d.modules.sculpting.SculptLayerBase

New in version R15.037.

Parent Class:

Children Classes:

Overview

Layer Management

SculptLayerBase.IsLocked()

Check if the layer is currently locked on the sculpt object.

SculptLayerBase.IsVisible()

Check if the layer is currently visible on the sculpt object.

SculptLayerBase.Select()

Select the layer.

SculptLayerBase.SetLocked()

Set the locked status of the layer on the sculpt object.

SculptLayerBase.SetVisible()

Set the visibility of this layer on the sculpt object.

Strength Control

SculptLayerBase.GetStrength()

Get the currents strength of the layer.

SculptLayerBase.SetStrength()

Set the strength of the layer on the sculpt object.

Members

Layer Management

SculptLayerBase.IsLocked(self)

Check if the layer is currently locked on the sculpt object.

Return type

bool

Returns

True if locked, False if unlocked.

SculptLayerBase.IsVisible(self)

Check if the layer is currently visible on the sculpt object.

Return type

bool

Returns

True if visible, False if invisible.

SculptLayerBase.Select(self)

Select the layer.

Note

This will only work if the subdivision level is at the same level as this layer.

Return type

bool

Returns

True if the layer was selected, otherwise False.

SculptLayerBase.SetLocked(self, state)

Set the locked status of the layer on the sculpt object.

Parameters

state (bool) – The locked state.

SculptLayerBase.SetVisible(self, state)

Set the visibility of this layer on the sculpt object.

Parameters

state (bool) – The visibility state.

Strength Control

SculptLayerBase.GetStrength(self)

Get the currents strength of the layer.

Return type

float

Returns

The strength value.

SculptLayerBase.SetStrength(self, strength)

Set the strength of the layer on the sculpt object.

Parameters

strength (float) – The strength value to set.