IC Python API:RL Python Samples

From Reallusion Wiki!
Jump to: navigation, search

Main article: iClone Python API.

The following samples demonstrate the use of the iClone Python API for creating simple and useful tools, including the implementation of major APIs exposed in iClone. If you are new to Python scripting or the iClone scripting environment, we recommend that you start off with the novice and fundamental level lessons.

Python of the Month

Python of the Month are monthly to bi-monthly lessons on various topics with the sole purpose of getting you up to speed on the various features of the iClone Python API. Each lesson comes with a plugin script as well as five fundamental lessons that are based on the content within the plugin script.

Release Date Plugin Script Fundamentals I Fundamentals II Fundamentals III Fundamentals IV Fundamentals V
June, 2019 Smooth Camera Follow List All Props 3D Look At Transformation Key Linear Interpolation Float Slider
July, 2019 Audio Driven Progress Bar Animated Material Audio Visualizer File Path Color Picker
August, 2019 Camera Auto-Focus Stopwatch Bounding Info Linked Controls Blurry Vision Align to Camera
November, 2019 Camera Dolly Zoom Object Type Message Box Item Lister Dialog Callbacks Local Move
December, 2019 PopcornFX Sequencer Table View Tree View Plugin Window Loading PFX Loading JSON
February, 2020 Spring Joints Transform Math Rotation Math Error Handling Handling Time Basic Math
March, 2020 Pose Manager List View Icons and Images Serialize Pose Screenshotting Saving JSON

Cells in light yellow are lessons derived from full-fledged paid versions, but they are still useful on their own. For a better understanding on how they integrate into the bigger picture, you might be interested in purchasing the fully-featured scripts from the Reallusion Marketplace. For more information see the Python of Month script article for the corresponding month.

Various Lessons

These lessons come in the form of free plugins. They are classified into different difficulty levels:

  • Novice: Recommended for those who may be new to scripting and are not familiar with the iClone API library.
  • Intermediate: Recommended for those have made an effort of understanding the iClone API and are getting comfortable with Python.
  • Advanced: Recommended for those who have deep knowledge of the iClone API and are proficient with Python.
Difficulty Level Script Description
Novice Batch Render Folder Takes multiple iClone projects within a directory and renders each one to a separate video.
Novice Joint Driven Morph Drive morph targets via real-time rotation of bone joints.
Intermediate Group Manager A utility that creates layer controls for iClone.
Intermediate Musical Keyboard Creates key-press events that can respond in real-time.
Advanced Light Remote Control Implements Internet of Things to drive functions within the iClone application itself.
Advanced Hand Gestures Puppeteering Provides an intuitive graphical user interface to drive the hand gestures of a character.

Sample Code Snippets

These samples are recommended for those who may have working knowledge of the iClone API but would like to digest certain ways of accomplishing specific tasks in piecemeal.