Difference between revisions of "IC Python API:Smooth Camera Follow"

From Reallusion Wiki!
Jump to: navigation, search
m (Required Files)
m (Code Flow)
(8 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
{{Parent|IC_Python_API:RL_Python_Samples|RL Python Samples}}
 
{{Parent|IC_Python_API:RL_Python_Samples|RL Python Samples}}
  
== Smooth Camera Follow ==
+
== Demo Video ==
 
+
=== Demo Video ===
+
  
 
{{#evt:
 
{{#evt:
Line 11: Line 9:
 
}}
 
}}
  
=== Description ===
+
== Description ==
  
 
This script lets the user pick a camera/view and a prop/target to follow.  The camera will always be facing the direction of the target prop with delay as an adjustable factor. The Offset values creates a distance between the view and the target.  Use the Delay value to create a lag between the view and the target.
 
This script lets the user pick a camera/view and a prop/target to follow.  The camera will always be facing the direction of the target prop with delay as an adjustable factor. The Offset values creates a distance between the view and the target.  Use the Delay value to create a lag between the view and the target.
Line 17: Line 15:
 
{{Single_Illustration|Smooth_Camera_Follow_Diagram.png|As the target prop starts to move, the camera will begin to follow with a specified delay.  However, the camera's facing direction will always be locked onto the prop's pivot point no matter how fast the prop is moving.}}
 
{{Single_Illustration|Smooth_Camera_Follow_Diagram.png|As the target prop starts to move, the camera will begin to follow with a specified delay.  However, the camera's facing direction will always be locked onto the prop's pivot point no matter how fast the prop is moving.}}
  
=== Course Prerequisites ===
+
== Course Prerequisites ==
  
You should be familiar with the following fundamental articles before you proceed.
+
You should be familiarize yourself with the following fundamental articles before you proceed:
  
 
*[[ iC_Python_API:List_All_Props | List All Props ]]
 
*[[ iC_Python_API:List_All_Props | List All Props ]]
 
*[[ iC_Python_API:Look_At | Look At ]]
 
*[[ iC_Python_API:Look_At | Look At ]]
 
*[[ iC_Python_API:Transformation_Key | Transformation Key]]
 
*[[ iC_Python_API:Transformation_Key | Transformation Key]]
 +
*[[ iC_Python_API:Linear_Interpolation| Linear Interpolation]]
 +
*[[ iC_Python_API:Float_Slider| Float Slider ]]
 +
 +
== Learn How to ==
  
=== Learn How to ===
 
 
* Drive the motion of the camera according to the animation of a prop.
 
* Drive the motion of the camera according to the animation of a prop.
 
* Populate drop down menus/combo boxes with elements from the scene.
 
* Populate drop down menus/combo boxes with elements from the scene.
  
=== Required Files ===
+
== Required Files ==
 
+
You can download the plugin from the [https://marketplace.reallusion.com/smooth-camera-follow Reallusion Marketplace]. 
+
To acquire and view the source code, please visit the [https://github.com/reallusion/iClone/tree/master/SmoothCameraFollow Reallusion GitHub Page].
+
  
 
* iClone scene with camera and animated prop
 
* iClone scene with camera and animated prop
Line 38: Line 36:
 
* Extensions Python script
 
* Extensions Python script
  
=== Steps to Take ===
+
You can download this plugin from the [https://marketplace.reallusion.com/smooth-camera-follow Reallusion Marketplace]. 
 +
To acquire and view the source code, please visit [https://github.com/reallusion/iClone/tree/master/SmoothCameraFollow Reallusion GitHub].
 +
 
 +
== Steps to Take ==
  
 
# Clone or download the Reallusion/iClone GitHub.
 
# Clone or download the Reallusion/iClone GitHub.
Line 45: Line 46:
 
# Follow the instructions in the subsequent dialog window.
 
# Follow the instructions in the subsequent dialog window.
  
=== Code Flow ===
+
== Code Flow ==
  
 
Given a target prop and a target camera, the script will also require the inputs for the camera movement delay and offset position from the target prop.  The code creates a new movement animation for the camera transformations by applying keys in the timeline.  The final result is a camera that smoothly follows the target prop at the designated offset position with a certain degree of lag time decided by the user.
 
Given a target prop and a target camera, the script will also require the inputs for the camera movement delay and offset position from the target prop.  The code creates a new movement animation for the camera transformations by applying keys in the timeline.  The final result is a camera that smoothly follows the target prop at the designated offset position with a certain degree of lag time decided by the user.
  
{{Single_Illustration|Camera_WIKI_Code_Route.png}}
+
[[File:Camera_WIKI_Code_Route.png]]
 +
 
 +
== APIs Used ==
  
=== Modules Used ===
 
 
You can research the following references for the modules deployed in this code.
 
You can research the following references for the modules deployed in this code.
==== main.py ====
+
 
 +
=== main.py ===
 
<div style="column-count:4; -moz-column-count:4; -webkit-column-count:4">
 
<div style="column-count:4; -moz-column-count:4; -webkit-column-count:4">
 
* [[ IC_Python_API:RLPy_RMatrix3 | RLPy.RMatrix3() ]]
 
* [[ IC_Python_API:RLPy_RMatrix3 | RLPy.RMatrix3() ]]
Line 68: Line 71:
 
* [[ IC_Python_API:RLPy_RVector3 | RLPy.RVector3() ]]
 
* [[ IC_Python_API:RLPy_RVector3 | RLPy.RVector3() ]]
 
</div>
 
</div>
==== Extensions.py ====
+
 
 +
=== Extensions.py ===
 +
 
 
<div style="column-count:4; -moz-column-count:4; -webkit-column-count:4">
 
<div style="column-count:4; -moz-column-count:4; -webkit-column-count:4">
 
* [[ IC_Python_API:RLPy_RMath#Abs | RLPy.RMath.Abs() ]]
 
* [[ IC_Python_API:RLPy_RMath#Abs | RLPy.RMath.Abs() ]]

Revision as of 00:53, 28 June 2019

Main article: RL Python Samples.

Demo Video

Description

This script lets the user pick a camera/view and a prop/target to follow. The camera will always be facing the direction of the target prop with delay as an adjustable factor. The Offset values creates a distance between the view and the target. Use the Delay value to create a lag between the view and the target.

As the target prop starts to move, the camera will begin to follow with a specified delay. However, the camera's facing direction will always be locked onto the prop's pivot point no matter how fast the prop is moving.

Course Prerequisites

You should be familiarize yourself with the following fundamental articles before you proceed:

Learn How to

  • Drive the motion of the camera according to the animation of a prop.
  • Populate drop down menus/combo boxes with elements from the scene.

Required Files

  • iClone scene with camera and animated prop
  • Smooth Camera Follow Python script
  • Extensions Python script

You can download this plugin from the Reallusion Marketplace. To acquire and view the source code, please visit Reallusion GitHub.

Steps to Take

  1. Clone or download the Reallusion/iClone GitHub.
  2. Copy SmoothCameraFollow folder into the iClone install directory > ...\Bin64\OpenPlugin.
  3. Load the script into the project from the menu: Plugins > Python Samples > Smooth Camera Follow.
  4. Follow the instructions in the subsequent dialog window.

Code Flow

Given a target prop and a target camera, the script will also require the inputs for the camera movement delay and offset position from the target prop. The code creates a new movement animation for the camera transformations by applying keys in the timeline. The final result is a camera that smoothly follows the target prop at the designated offset position with a certain degree of lag time decided by the user.

Camera WIKI Code Route.png

APIs Used

You can research the following references for the modules deployed in this code.

main.py

Extensions.py