SkinLayerStudio API (Beta) / API Reference / Skin

quick_skin_human()

Download Markdown

Builds weights in one step from the human map. You do not pick bone names yourself.

The order is fixed. It lays a base coat on the whole body, carves parts such as arms, legs, and hands, mirrors left and right, then groups the hands and climbs the chain. Undo is a single step.

Omit parts and only the parts turned on in the current human map are built. mirror=True is the default, so building the left side also fills the right. False does not add the opposite side and does not mirror.

If layers already made by Human have been edited, they are not overwritten. error is human_stack_dirty. If there are no parts, error is no_parts. Falloff, resolution, and the Trial lock are the same as quick_skin.

On failure, the layers go back to how they were before the call.

Signature

skin.quick_skin_human(
    falloff=None,
    resolution=None,
    max_influences=4,
    parts=None,
    mirror=True,
) -> result
Argument Meaning
parts Part names to build. Omit them to use the parts turned on in the map.
mirror Whether to fill both sides. Default True.
falloff resolution max_influences Same as quick_skin.

Example

result = api.skin().quick_skin_human()
print(result.ok, result.error)

To paint only a few arm bones, with no body parts, use bones on quick_skin.

💬

Need help with the API?

Open a support ticket or join the community discussion.

Contact Support