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
Capabilities
As the iClone Python API continues to evolve, additional capabilities will be added over time. Below are lists of iClone Python API's current capabilities categorized by version number. The lists below are by no means exhaustive.
This includes *.iProjects, *.iAvatars, *.iProps, and any number of supported file formats readable and writable by iClone.
Animate Props
RTS (Rotate, Translate, Scale) prop transformations, including playing their animation clips.
Animate Characters
Play motion clips and rotate joints of a character in FK mode (Forward Kinetic).
Morph Animation
Drive morph sliders and key morph slider values in the timeline.
Add audio to objects
Add or remove audio tracks to props and characters that can playback in real-time.
Adjust Materials
Adjust strength contributions per texture channel, UV settings, diffuse color, ambient color, opacity values, etc.
Camera Controls
Adjust focal length, angle of view, near and far clipping planes, etc. on any camera in the scene.
Light Controls
Control settings for direction, spot and point lights. Such as range, angle, falloff, attenuation, etc.
Device Input
Drive animations and object parameters with the keyboard, mice, joystick, etc.
TCP/IP
Drive animations and object parameters remotely with IOT (Internet of Things) from other computers, cell-phones, etc. Or, have iClone drive IOT with smart network connectivity for lights, doors, etc.
Get Events
Setup callbacks for iClone run-time events such as on load, on selection, on parameter value change, on set timer, etc. Useful for tasks that need to trigger following an event like adding newly created items into a list tree, deploying automatic settings on load, or driving corrective morph targets when certain combinations of morphs are activated.
Render Project
Write batch render scripts and specify target directories for output.
Custom UI Design
Use iClone's native UI classes, or extend beyond it with QT's Pyside2 to create buttons, forms, dropdowns, modal windows, etc.
Animation Keys
Set timeline keys for various motion clips. Animate props, characters, lights, etc. via scripting.
Fixed incorrect transform rotations for RIObject, RIAvatar, RIProp, RILight, RICamera.
RINode::WorldTransform
New WorldTransform for RINode; No need for the user to write a function to retrieve it.
Rkey
New RKey can be used to carry additional data such as Time, TransitionType, and TransitionStrength.
Material Component
Fixed kTime > kKey for the MaterialComponent; Besides setting the frame time, one can also set the Transition Type and Strength.
LoadImageToTexture
Ability to load texture images to any channel within a material accessible via Mesh > Material Name.
RIHikEffectorComponent
Established framework for the RIHikEffoectorComponent API and test case is provided (not yet implemented).
Ignore API
Fixed RAudio:SetAudioPtr and RScene:SetScenePtr not being ignored (currently the online documentation also has this problem).
RApplication class
New RApplication class can retreive registry related data and API version number. Test case has been added.
RIObject::SetParent(RIObject/RINode)
All classes that derive from RIObject also inherit the SetParent member function.
RIObject::LinkTo(RIObject, RTime)
All classes that derive from RIObject also inherit the LinkTo member function.
RIObject::Unlink(RTime)
All classes that derive from RIObject also inherit the Unlink member function.
RIFaceComponent::GetKey( args... )
Used to retrieve the current time's Facial Expression, Eye, and Head key values. Usage: RIFaceComponent::GetKey(RTime, Head, LeftEye, RightEye, Morph, Custom, Bone, Weight)
RIFaceComponent::AddClip(RTime)
Adds a default Facial clip at the designated point in time.
RIFaceComponent::AddEyeKey()
Create a EyeKey under the Facial Layer.
RIFaceComponent::AddHeadKey()
Create a HeadKey under the Facial Layer.
RIFaceComponent::AddExpressionKey()
Create a ExpressionKey under the Facial Layer.
RIFaceComponent::AddVisemeKey()
Create a LipsKey under the Viseme layer.
RIObject::SetName(std::wstring)
Used to change the name of an object.
RIObject::GetPivot()
All classes that derive from RIObject also inherit the GetPivot member function.
RIObject::SetPivot()
Provides a way to retrieve the pivot point of a prop.
RIObject::GetBounds()
All classes that derive from RIObject also inherit the GetBounds member function.
<RIObjectPtr> CICFileIO::LoadObject( strPath ): Function that can load objects, and directly get the loaded objects, currently only the types that inherit RIObject can use this API
RlVisemeComponent
RlVisemeComponent::AddVisemesClip( RO::RTime kTime, const std::wstring& nClipName, RO::RTime kTimeLength ): Used to create Viseme Clip.
RIProp
RIProp::SetDummy( bIsDummy): Used to set whether Prop is Dummy.
RIProp
<bool> RIProp::IsDummy(): Used to check if Prop is Dummy.
RIMorphComponent
std::vector< std::wstring > RIMorphComponent::GetMorphNames(): Get all morph names for the specified mesh.
RIObject
RIObject::Clone(): Used to copy the object.
RIObject
RIObject::IsSelected(): Confirm whether the object is selected in the scene.
RemoveVisemesClip
RemoveVisemesClip( RO::RTime kTime ): Remove a viseme Clip at the specified time.
RlVisemeComponent
RlVisemeComponent::RemoveVisemesKey( RO::RTime kTime ): Remove a viseme key at the specified point in time.
RlVisemeComponent
RlVisemeComponent::GetVisemeMorphWeights(): Used to get the weight of each Morph of viseme.
RlVisemeComponent
RlVisemeComponent::GetVisemeBones(): Used to get the Bone used by Viseme.
RlVisemeComponent
RlVisemeComponent::GetVisemeKeys(): Used to get the time of all Viseme keys, and return RTime as an array.
RlVisemeComponent
RlVisemeComponent::GetVisemeKey( RO::RTime kTime, RO::EVisemeID& eVisemeID, float& fWeight ): Used to get the VisemeID and Weight of Viseme at a specified point in time.
Added judging whether the output Fbx comes with a sell / export license (for internal API).
Modify RFileIO::ExportFbxFile
When exporting Fbx, judge whether it has a sell / export license
RISkeletonComponent::ConvertToOriginalBoneAxis()
Turn the current Pose into the axis of the original skeleton (NonStd characters only).
Modify RICCamera::GetFocalLength
Correction If it is judged that the control (CameraFovClipControl / CCameraFovKeyControl) is wrong, the focal length is calculated based on the FrustumFov in the current camera.
RGlobal.TrialVersionRemainingTimes( args... )
Can check the remaining number of trails (some Trial will be useful, ex 3DX). Usage: RGlobal.TrialVersionRemainingTimes( const std::wstring& strBinPath, unsigned int uProductID, const std::wstring& strProductFold,const std::wstring& strRegRoot,unsigned int uTimeNo )
Set Function can now be used. Originally all SetEnable, SetFocus, etc. were hidden functions.
RLPy.RICamera
New <RStatus> AddDofKey( RKey, RCameraDofData ): The key used to download the Camera Dof, the Preview Camera cannot be downloaded (not Pause).
RLPy.RICamera
New <int> GetNearClippingPlane(): Get the near clipping plane of the camera
RLPy.RICamera
New <RStatus> SetNearClippingPlane( int nNearPlane ): Set the near clipping plane of the camera to nNearPlane
RLPy.RICamera
New <int> GetFarClippingPlane(): Get the far clipping plane of the camera
RLPy.RICamera
New <RStatus> SetFarClippingPlane( int nFarPlane ): Set the far clipping plane of the camera to nFarPlane
RLPy.RIObject
Update(): RTS & Geronetry to update all Child bone & Mesh of this object
RLPy.RINode
Update(): Transform to update all Childe Nodes
RLPy.ELinkObjectAlignType
AlignType referenced when adding Link objects
Modify RIObject::LinkTo( args... )
Modified RIObject::LinkTo( std::shared_ptr< RIObject > spTargetObject, RO::ELinkObjectAlignType eAlignType, RTime kTime ): Link objects often pass AlignType to determine the Position / Rotation of the Target object.
RLPy.RIClip.SetLength()
Fixed RLPy.RIClip.SetLength(): that now even the props from the Prop SetParent group can correctly modify the Clip Length of each Child Prop
RLPy.RScene
Modified GetProps(): Restricted to get only the outermost Props on the scene (excluding the meaning of Props children)
RLPy.RScene
Modified FindObjects( RO::EObjectType eType ): Restricted to get only the outermost Props on the scene (excluding the meaning of Props children)
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:
Particle FX (iClone & PopcornFX)
SpeedTrees
Substance Materials
Textures Images
Constraints: Path, Spring, LookAt, Link, 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)
