IC Python API:Hand Gestures Puppeteering
- Main article: Various Lessons.
Demo Video
Descripton
The ability to customize and create new tools to facilitate character animation is one of the main draws of the iClone Python API. This example demonstrates the use of an intuitive graphical user interface to drive the hand gestures of a character. Once the script is applied, a Hand Gestures Puppeteering dialog window will appear with 6 quadrant gesture controls. The user can drag the dot within the interface to blend the hand gestures in midst of the 6 quadrants making for a smooth transition every time.
Convenient hotkeys are provided so the mouse can remain pre-occupied with controlling the blend position:
- [P] starts and stops the preview mode. Under this mode, the user can test out various blend styles without having to actually record the motion into the timeline.
- [Space] starts and stops the recording. Use this to record the motions to the timeline to preserve it for playback.
- [B] for switching between the two blend modes, see below for more information.
Two blending options are available:
- 2-Point Blend allows for blending of the nearest two points to the control point.
- Multi-Point Blend allows for blending of all 6 quadrants from any position within the control wheel.
Course Prerequisites
You should familiarize yourself with the following fundamental articles before you proceed:
| Link | Purpose |
|---|---|
| Using Temp Data | Learn to read/write temporary data. |
| Embedding QML | A soft introduction to creating QML ui and embedding it into iClone. |
Takeaway Lessons
- Simulate Mocap device to control Character motion.
- Create UI using QML.
Required Files
- Hand Gestures Python script -included in Python samples (main.py)
- Hand Rig Python script (handrigger.py)
- User interface Python script (KeyData.py)
- Bone data required by the hand rigger script (BoneData.py)
- User interface markup language file for QT (resource/qml folder)
You can download this plugin from the Reallusion Marketplace. To acquire and view the source code, please visit Reallusion GitHub.
Usage Instructions
- Inside iClone, load a standard or non-standard character.
- Initiate the Hand Gestures Puppeteering script (Plugins > Python Samples > Hand Gestures Puppeteering).
- Press [P] to start the preview process; Which does not record actual animation.
- Drag the dot within the Hand Gestures Puppeteering window and watch as the hands begin to move and blend between the 6 different poses.
- Switch between 2-Point and Multi-Point Blend to try out the different blending options by pressing [B] so you won't need to let go of the mouse button.
- Hit the space-bar at any point to start recording the animation in the timeline.
- Finish the recording by pressing the space-bar again and play the timeline to review the recorded animation.
APIs Used
You can research the following references for the APIs deployed in this code.
main.py
- RLPy.RPyTimerCallback.__init__()
- RLPy.RGlobal.GetTime()
- RLPy.RGlobal.GetEndTime()
- RLPy.RGlobal.SetTime()
- RLPy.RUi.CreateRDialog()
- RLPy.RUi.GetMainWindow()
- RLPy.RUi.AddMenu()
- RLPy.RUi.AddHotKey()
- RLPy.RPyTimer()
- RLPy.REventHandler.UnregisterCallbacks()
- RLPy.RUi.RemoveHotKey()
- RLPy.RDialogCallback.__init__()
- RLPy.REventCallback.__init__()
- RLPy.REventHandler.RegisterCallback()
- RLPy.RUi.OpenFileDialog()
- RLPy.RScene.GetSelectedObjects()
- RLPy.RGlobal.IsPlaying()
- RLPy.RGlobal.Pause()
- RLPy.RGlobal.Play()
- RLPy.RUi.SaveFileDialog()
- RLPy.RUi.ShowMessageBox()
