Getting Started

Scripting can be  powerful tool in your arsenal for dealing with 3D art production.  Whether you are looking for a way to automate some parts of your workflow or develop more advanced toolkits and plugins, scripting can offer something for everyone.  With the iClone Python API, one has access to the powerful low level implementations hidden within iClone, while abstracting its complexity to a manageable level.

Why Python ?

Python is a general-purpose language, which means it can be used to build just about anything - a process made easy with the right tools and code libraries. Professionally, Python is great for backend web development, data analysis, artificial intelligence, and scientific computing. Many developers have also used Python to build productivity tools, games, and desktop apps, so there are plenty of resources to help you learn how to create those as well.

Python is easy to pick up for experienced programmers coming from other languages and easy to learn for beginners and novices.  Which can also explain its wide-spread support with 3D software with the likes of Autodesk 3dsMax, Autodesk Maya, Maxon Cinema4d, Blender, etc.

Python in iClone

Make sure to use iClone version 7.4 or above and locate the Script entry in the menu which provides the following 2 functions:

  1. Load Python - load your py file (Python file) into iClone.
  2. Console Log - dialogue to print all the informations come from Python.

console_

iClone Conventions

Keep the following conventions in mind when dealing with the iClone environment:

World Axis: Z up, -Y forward, Right-handed Coordinate system

Rotational System:  Quaternion, Matrix3 or Euler Angle ( Radians )

Scale Units: 1 equals to 100% scale.

Time Units:  1 equals to 1 millisecond and 1,000 equals to 1 second.