scan()

Download Markdown

Measures the mesh and suggests a falloff and a resolution for Quick Skin. It does not paint weights.

This is the same call as Calculate recommended values in the window. If there is no mesh, ok is False and error is no_mesh.

To use the suggested numbers as they are, omit falloff and resolution on quick_skin.

skin.scan() -> result

Field	Meaning
`ok`	Whether it measured the mesh.
`height_cm`	Longest side of the mesh.
`falloff`	Suggested softness. Closer to 0 is softer. Closer to 1 is stiffer.
`resolution`	Suggested grid. One of 64, 128, 256, 512.
`vert_count`	Vertex count.
`bone_count`	Bone count.
`error`	Why it failed.

info = api.skin().scan()
if info.ok:
    print(info.height_cm, info.falloff, info.resolution)

💬

Need help with the API?

Open a support ticket or join the community discussion.