c4d.LayerShaderLayer¶

class c4d.LayerShaderLayer¶: Represents a layer in a LayerShader.

New in version R17.032.

Warning

This type cannot be instantiated.

Overview¶

Layer Inspection
`LayerShaderLayer.GetName()`	Gets the name of the layer.
`LayerShaderLayer.GetPreview()`	Retrieves the preview bitmap.
`LayerShaderLayer.GetType()`	Gets the layer type.
Layer Navigation And Parameters
`LayerShaderLayer.GetNext()`	Gets the next layer.
`LayerShaderLayer.GetParameter()`	Retrieves layer parameters.
`LayerShaderLayer.SetParameter()`	Sets layer parameters.

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.

LayerShaderLayer.GetType(self)¶

Gets the layer type.

Return type

int

Returns

The layer type:

LayerShaderLayer.GetNext(self)¶

Gets the next layer.

Note

Use this method to navigate trough the layers of a layer shader.

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.

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

Return type

bool

Returns

True if the parameter could be set, otherwise False.

Category	Option	Description
Query	Words and phrases	Search is case-insensitive. Put a phrase in quotes for an exact match. Quoted phrases require every word and disable fuzzy matching.
Terms	OR / AND	Choose whether to match any term or require all terms.
Fuzzy	On / Off	Toggle approximate and prefix matches. Quoted phrases always use strict matching.
Results	Sparse / Dense	Sparse groups multiple hits for one entity and hides its owned API members when the class or module itself matches. Dense lists each match separately.
Sort by	Type / Relevance	Group results by entity type then rank within each group, or rank all results by relevance.
Content	All / API / Manuals / Examples / Resources	Search all documentation, API documentation, manuals, the examples index, or the resources index. Code examples embedded in other sections retain their own content area.
Entity	All / Page / Module / Class / Function / Attribute / Description / Node / Symbol / Icon	Page covers results without a specific entity type. Resource entity types are available with All or Resources; API entity types are available with All or API.
Location	All / Text / Code / Name / Signature	Text covers everything outside code, names, and signatures. Name and Signature are available with All or API.