View source for IC Python API:Camera Dolly Zoom

{{TOC}}
{{Parent|IC_Python_API:RL_Python_Samples|RL Python Samples}}

== Demo Video ==


== Description ==

Dolly Zoom is an in-camera effect that utilizes perspective distortion to make the background appear as if it’s changing its size relative to the subject.   The visual appearance for the viewer is that either the background suddenly grows in size and detail to overwhelm the foreground, or the foreground becomes immense and dominates the previous setting, depending on which way the dolly zoom is executed.  This script simulates the Dolly Zoom effect by animating the camera's Focal Length and positioning according to the current camera settings and the desired Focal Length.  Automatic Depth of Field on the target object is an optional setting.

{{clear}}

== Course Prerequisites ==

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

*[[ iC_Python_API:Object_Type | Object Type ]]
*[[ iC_Python_API:Message_Box | Message Box ]]
*[[ iC_Python_API:Item_Lister | Item Lister ]]
*[[ iC_Python_API:Dialog_Callbacks | Dialog Callbacks ]]
*[[ iC_Python_API:Local_Move | Local Move ]]

== Takeaway Lessons ==

*Calculate the dolly zoom effect with a simple formula.
*Locally translate an object in code in spite of the world-space transformation system.


== Required Files ==

*Camera Dolly Zoom Python script
*iClone scene with selectable props or characters, preferably in a setting filled with background objects.


== Usage Instructions ==

#Clone or download the Reallusion/iClone GitHub.
#Copy '''Camera_Dolly_Zoom''' folder into the iClone install directory > '''...\Bin64\OpenPlugin'''.
#Load the script into the project from the menu: '''Plugins > Python Samples > Camera Dolly Zoom'''.
#Create a new camera and pick an item in the scene.
#Adjust the settings and press the '''Key Dolly Zoom''' button.

== Code Flow ==

#The current viewing camera is the currently driven camera.
#The current selection is the DOF target, the first item in multiple selection is designated as the target.
#Adjust the parameters such as Auto-Distance and Auto-Range toggle and multiplier. 
#The z-distance between the target prop from the current viewing camera is calculated.
#DOF key is created taking into account the depth distance value and the parameter settings.
#The created DOF key is set on the current viewing camera in near real-time.

[[File:Ic_python_api_auto_focus_01.png]]

=== APIs Used ===

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

<div style="column-count:4; -moz-column-count:4; -webkit-column-count:4">
* [[ IC_Python_API:RLPy_RMatrix4 | RLPy.RMatrix4() ]]
* [[ IC_Python_API:RLPy_RPyTimerCallback#__init__ | RLPy.RPyTimerCallback.__init__() ]]
* [[ IC_Python_API:RLPy_RDialogCallback#__init__ | RLPy.RDialogCallback.__init__() ]]
* [[ IC_Python_API:RLPy_RScene#GetCurrentCamera | RLPy.RScene.GetCurrentCamera() ]]
* [[ IC_Python_API:RLPy_RGlobal#GetTime | RLPy.RGlobal.GetTime() ]]
* [[ IC_Python_API:RLPy_RScene#GetSelectedObjects | RLPy.RScene.GetSelectedObjects() ]]
* [[ IC_Python_API:RLPy_RGlobal#SetTime | RLPy.RGlobal.SetTime() ]]
* [[ IC_Python_API:RLPy_RTime | RLPy.RTime() ]]
* [[ IC_Python_API:RLPy_RUi#ShowMessageBox | RLPy.RUi.ShowMessageBox() ]]
* [[ IC_Python_API:RLPy_RGlobal#GetFps | RLPy.RGlobal.GetFps() ]]
* [[ IC_Python_API:RLPy_RTime#GetFrameIndex | RLPy.RTime.GetFrameIndex() ]]
* [[ IC_Python_API:RLPy_RVector3 | RLPy.RVector3() ]]
* [[ IC_Python_API:RLPy_RVariant | RLPy.RVariant() ]]
* [[ IC_Python_API:RLPy_RKey | RLPy.RKey() ]]
* [[ IC_Python_API:RLPy_RGlobal#Play | RLPy.RGlobal.Play() ]]
* [[ IC_Python_API:RLPy_RUi#CreateRDialog | RLPy.RUi.CreateRDialog() ]]
* [[ IC_Python_API:RLPy_RPyTimer | RLPy.RPyTimer() ]]
* [[ IC_Python_API:RLPy_RUi#GetMainWindow | RLPy.RUi.GetMainWindow() ]]
* [[ IC_Python_API:RLPy_RUi#AddMenu | RLPy.RUi.AddMenu() ]]
</div>