BipedPlus API (Beta)
/
API Reference
/
Rig
inspect()
Download MarkdownReads the rig. Does not change it.
Signature
rig.inspect() -> dict
No arguments.
Return
{
"success": True,
"message": "",
"data": { ... },
}
data and rig.data are the same dict.
| Key | Meaning |
|---|---|
com namespace info top_grp |
Rig names |
has_rig |
True when INFO or the top group exists |
height_cm |
Height, or None |
biped_style |
Style, or None |
spine_count neck_count leg_links |
Structure |
arm_twist_seg leg_twist_seg |
Segments |
extras |
Installed extra names, or [] |
license_version |
Cached license, or None |
Values the scene could not provide stay None.
Example
from os_bipedPlus import openAPI
api = openAPI()
rig = api.scan()
info = rig.inspect()
print(info["data"]["leg_twist_seg"], info["data"]["extras"])