IC Python API:Uses and Capabilities
From Reallusion Wiki!
- Main article: iClone Python API.
The iClone Python API helps you to extend and customize iClone, and more easily integrate it into a Python-based pipeline. It provides a bridge between iClone and Python libraries and Python tools. The Python SDK is built on top of the iClone C++ SDK, and you can access a subset of the iClone API from Python scripts and execute them in iClone.
The iClone Python API can do the following:
| Character | Prop | Camera | Light | |||
|---|---|---|---|---|---|---|
| Std(G5, CC, etc.) | Non-Std | Non-Human | ||||
| Transformation (RTS) | 7.4 | 7.4 | 7.4 | 7.4 | 7.4 | 7.4 |
| Facial Expression | 7.4 Mo-cap Module | 7.4 Mo-cap Module | - | - | - | - |
| Morph Animation | 7.4 Experimental | 7.4 Experimental | 7.4 Experimental | 7.4 Experimental | - | |
| Material | 7.4 Experimental | 7.4 Experimental | 7.4 Experimental | 7.4 Experimental | 7.4 Experimental | |
| Parameters | - | - | - | - | 7.4 Experimental | 7.4 Experimental |
Limitations
As the iClone Python API continues to evolve, limitations may expand or contract over time. Below are lists of iClone Python API's currently known limitations. This list is not exhaustive.
Inoperable Assets
The following items can not be manipulated and acted upon with Python scripting:
- SpeedTrees
- Substance Materials
- Textures Images
- Constraints: Path, Spring, LookAt, Physics, etc.
- Physics (Soft & Rigid)
- IK end-effectors (control attached props instead to drive IK reach)
- Mesh level components: vertices, edges, faces, etc.
- Preview camera
Unsupported Operations
The following operations are not available via Python scripting:
- Saving iClone formats: iProjects, iAvatars, iProps, etc.
- Pixel operations: multiply, add, overlay, etc.
- Image processing: Brightness, Hue, Saturation, Sharpen, Soften, Blend, etc.
- Render parameter settings (Project settings can not be changed)
- Facial lip-sync keying
- Preference settings
- Attach/Detach: changing object parent-child relation
- Align motion/character root alignment
- Modeling operations: manipulation of mesh components
