Group layer

GroupLayerNode is a type of layer that can contain other layers. It is used to group layers together to organize the layerstack.

Examples

import substance_painter as sp

# Get the currently displayed Stack
stack = sp.textureset.get_active_stack()

# Get top position of the Stack
position_stack_top = sp.layerstack.InsertPosition.from_textureset_stack(stack)

# Insert Group layer
my_group_layer = sp.layerstack.insert_group(position_stack_top)
my_group_layer.set_name("My Group Layer")

# Insert Paint layer inside the Group layer
insert_position = sp.layerstack.InsertPosition.inside_node(
    my_group_layer, sp.layerstack.NodeStack.Substack)
my_paint_layer = sp.layerstack.insert_paint(insert_position)

# Insert Fill layer inside the Group layer
my_fill_layer = sp.layerstack.insert_fill(insert_position)
my_fill_layer.set_name("My Fill Layer")

# Expand the Group layer
if (my_group_layer.is_collapsed()):
    my_group_layer.set_collapsed(False)

# Select the Group layer
sp.layerstack.set_selected_nodes([my_group_layer])

Functions and classes

substance_painter.layerstack.insert_group(position: InsertPosition) -> GroupLayerNode substance_painter.layerstack.insert_group

Insert a group layer.

Parameters:

position (InsertPosition) – The insert position must be either inside
a GroupLayerNode with NodeStack.Substack
or above/below a LayerNode.

Raises:

ValueError – If insertion failed due to an invalid position.
See InsertPosition.

Returns: The inserted node.

Return type: GroupLayerNode

class substance_painter.layerstack.GroupLayerNode(uid) substance_painter.layerstack.GroupLayerNode

Bases: LayerNode

A node allowing manipulation of a Group layer of the Layer Stack.

sub_layers() -> List[LayerNode] substance_painter.layerstack.GroupLayerNode.sub_layers

Query sub layers of this node. Only get the direct children, ordered like in the layer
stack.

Returns: The sub layers of this node.

Return type: List[LayerNode]

is_collapsed() -> bool substance_painter.layerstack.GroupLayerNode.is_collapsed

Query if the group is in collapsed state.

Returns: Whether this group is collapsed.

Return type: bool

set_collapsed(collapsed: bool) substance_painter.layerstack.GroupLayerNode.set_collapsed

Set the collapsed state of the group.

Parameters: collapsed (bool) – Whether to collapse the group.