c4d.LayerShaderLayer¶
-
class
c4d.
LayerShaderLayer
¶ Represents a layer in a
LayerShader
.New in version R17.032.
Warning
This type cannot be instantiated.
Methods Signatures
LayerShaderLayer.GetNext(self) |
Gets the next layer. |
LayerShaderLayer.GetType(self) |
Gets the layer type. |
LayerShaderLayer.GetName(self, doc) |
Gets the name of the layer. |
LayerShaderLayer.GetPreview(self) |
Retrieves the preview bitmap. |
LayerShaderLayer.GetParameter(self, id) |
Retrieves layer parameters. |
LayerShaderLayer.SetParameter(self, id, data) |
Sets layer parameters. |
Methods Documentation
-
LayerShaderLayer.
GetNext
(self)¶ Gets the next layer.
Note
Use this method to navigate trough the layers of a layer shader.
Return type: c4d.LayerShaderLayer Returns: The next layer.
-
LayerShaderLayer.
GetType
(self)¶ Gets the layer type.
Return type: int Returns: The layer type: TypeUnknown Unknown layer. TypeFolder Folder. TypeShader Shader. TypeBrightnessContrast Brightness/Contrast. TypeHSL HSL. TypePosterize Posterize. TypeColorize Colorize. TypeClamp Clamp. TypeClip Clip. TypeDistorter Distorter. TypeTransform Transformation.
-
LayerShaderLayer.
GetName
(self, doc)¶ Gets the name of the layer.
Parameters: doc (c4d.documents.BaseDocument) – The document for the operation. Return type: str Returns: The layer name.
-
LayerShaderLayer.
GetPreview
(self)¶ Retrieves the preview bitmap.
Return type: c4d.bitmaps.BaseBitmap Returns: The preview bitmap.
-
LayerShaderLayer.
GetParameter
(self, id)¶ Retrieves layer parameters.
Note
See Layer Shader Library documentation in the C++ SDK for the information on the parameter IDs and types.
Parameters: id (int) – The ID of the parameter to get. Return type: Any Returns: The parameter value.
-
LayerShaderLayer.
SetParameter
(self, id, data)¶ Sets layer parameters.
Note
See Layer Shader Library documentation in the C++ SDK for the information on the parameter IDs and types.
Parameters: - id (int) – The ID of the parameter to set.
- data (any) – The new parameter value.
Return type: bool
Returns: True if the parameter could be set, otherwise False.