IC8 Python API:RLPy RCameraDofData

From Reallusion Wiki!
Jump to: navigation, search

Contents

Description

RCameraDofData is used to store the DOF related settings for the camera. https://manual.reallusion.com/iClone_7/ENU/Content/iClone_7/Pro_7.4/10_Scene/Camera/The_Concept_of_DOF.htm See also: RICamera

Constructor & Destructor

__init__ (self)

Create a camera Depth of Field settings data structure.

Member Functions

GetCenterColorWeight (self)

Returns the center color weight.

Sample code

Demonstrates calls to `RLPy.RCameraDofData.GetCenterColorWeight`, `RLPy.RCameraDofData.GetEnable`, `RLPy.RCameraDofData.SetCenterColorWeight`, and `RLPy.RCameraDofData.SetEnable` using the example's inputs. 

import RLPy

def run_script():
    dof_data = RLPy.RCameraDofData()
    dof_data.SetEnable(True)
    dof_data.SetCenterColorWeight(0.625)
    return (
        dof_data.GetEnable(),
        dof_data.GetCenterColorWeight(),
    )

GetEdgeDecayPower (self)

Get the power of the edge decay for the camera DOF.

Sample code

Calls `RLPy.RCameraDofData.GetEdgeDecayPower` with the inputs shown in the example. 

def run_script():
    import RLPy
    new_data = RLPy.RCameraDofData()
    new_data.SetEdgeDecayPower(20)
    print( new_data.GetEdgeDecayPower() )

GetEnable (self)

Get the active state of the camera DOF.

Sample code

Demonstrates calls to `RLPy.RCameraDofData.GetCenterColorWeight`, `RLPy.RCameraDofData.GetEnable`, `RLPy.RCameraDofData.SetCenterColorWeight`, and `RLPy.RCameraDofData.SetEnable` using the example's inputs. 

import RLPy

def run_script():
    dof_data = RLPy.RCameraDofData()
    dof_data.SetEnable(True)
    dof_data.SetCenterColorWeight(0.625)
    return (
        dof_data.GetEnable(),
        dof_data.GetCenterColorWeight(),
    )

GetFarBlurScale (self)

Get the camera DOF Far Blur Scale.

Sample code

Calls `RLPy.RCameraDofData.GetFarBlurScale` with the inputs shown in the example. 

def run_script():
    import RLPy
    new_data = RLPy.RCameraDofData()
    new_data.SetFarBlurScale(3)
    print( new_data.GetFarBlurScale() )

GetFarTransitionRegion (self)

Get the camera DOF Far Transition Region.

Sample code

Calls `RLPy.RCameraDofData.GetFarTransitionRegion` with the inputs shown in the example. 

def run_script():
    import RLPy
    new_data = RLPy.RCameraDofData()
    new_data.SetFarTransitionRegion(5)
    print( new_data.GetFarTransitionRegion() )

GetFocus (self)

Get the camera DOF Focus value.

Sample code

Calls `RLPy.RCameraDofData.GetFocus` with the inputs shown in the example. 

def run_script():
    import RLPy
    new_data = RLPy.RCameraDofData()
    new_data.SetFocus(20)
    print( new_data.GetFocus() )

GetMinBlendDistance (self)

Get the camera DOF's Min Blend Distance.

Sample code

Calls `RLPy.RCameraDofData.GetMinBlendDistance` with the inputs shown in the example. 

def run_script():
    import RLPy
    new_data = RLPy.RCameraDofData()
    new_data.SetMinBlendDistance(0.2)
    print( new_data.GetMinBlendDistance() )

GetNearBlurScale (self)

Get the camera DOF Near Blur.

Sample code

Calls `RLPy.RCameraDofData.GetNearBlurScale` with the inputs shown in the example. 

def run_script():
    import RLPy
    new_data = RLPy.RCameraDofData()
    new_data.SetNearBlurScale(2)
    print( new_data.GetNearBlurScale() )

GetNearTransitionRegion (self)

Get the camera DOF Near Transition Region.

Sample code

Calls `RLPy.RCameraDofData.GetNearTransitionRegion` with the inputs shown in the example. 

def run_script():
    import RLPy
    new_data = RLPy.RCameraDofData()
    new_data.SetNearTransitionRegion(5)
    print( new_data.GetNearTransitionRegion() )

GetRange (self)

Get the camera DOF range value.

Sample code

Calls `RLPy.RCameraDofData.GetRange` with the inputs shown in the example. 

def run_script():
    import RLPy
    new_data = RLPy.RCameraDofData()
    new_data.SetRange(20)
    print( new_data.GetRange() )

SetCenterColorWeight (self, fCenterColorWeight)

Set the camera DOF's Center Color Weight.

Parameters

  • fCenterColorWeight

Sample code

Demonstrates calls to `RLPy.RCameraDofData.GetCenterColorWeight`, `RLPy.RCameraDofData.GetEnable`, `RLPy.RCameraDofData.SetCenterColorWeight`, and `RLPy.RCameraDofData.SetEnable` using the example's inputs. 

import RLPy

def run_script():
    dof_data = RLPy.RCameraDofData()
    dof_data.SetEnable(True)
    dof_data.SetCenterColorWeight(0.625)
    return (
        dof_data.GetEnable(),
        dof_data.GetCenterColorWeight(),
    )

Sample code

Calls `RLPy.RCameraDofData.SetCenterColorWeight` with the inputs shown in the example. 

def run_script():
    import RLPy
    new_data = RLPy.RCameraDofData()
    new_data.SetCenterColorWeight(20)

SetEdgeDecayPower (self, fEdgeDecayPower)

Set the power of the edge decay for the camera DOF.

Parameters

  • fEdgeDecayPower

Sample code

Calls `RLPy.RCameraDofData.GetEdgeDecayPower` with the inputs shown in the example. 

def run_script():
    import RLPy
    new_data = RLPy.RCameraDofData()
    new_data.SetEdgeDecayPower(20)
    print( new_data.GetEdgeDecayPower() )

Sample code

Calls `RLPy.RCameraDofData.SetEdgeDecayPower` with the inputs shown in the example. 

def run_script():
    import RLPy
    new_data = RLPy.RCameraDofData()
    new_data.SetEdgeDecayPower(20)

SetEnable (self, bEnable)

Whether or not to activate the DOF funcationalities.

Parameters

  • bEnable

Sample code

Demonstrates calls to `RLPy.RCameraDofData.GetCenterColorWeight`, `RLPy.RCameraDofData.GetEnable`, `RLPy.RCameraDofData.SetCenterColorWeight`, and `RLPy.RCameraDofData.SetEnable` using the example's inputs. 

import RLPy

def run_script():
    dof_data = RLPy.RCameraDofData()
    dof_data.SetEnable(True)
    dof_data.SetCenterColorWeight(0.625)
    return (
        dof_data.GetEnable(),
        dof_data.GetCenterColorWeight(),
    )

Sample code

Calls `RLPy.RCameraDofData.SetEnable` with the inputs shown in the example. 

def run_script():
    import RLPy
    data = RLPy.RCameraDofData()
    data.SetEnable( False )
    data.SetEnable( True )

SetFarBlurScale (self, fFarBlurScale)

Set the camera DOF Far Blur Scale.

Parameters

  • fFarBlurScale

Sample code

Calls `RLPy.RCameraDofData.GetFarBlurScale` with the inputs shown in the example. 

def run_script():
    import RLPy
    new_data = RLPy.RCameraDofData()
    new_data.SetFarBlurScale(3)
    print( new_data.GetFarBlurScale() )

Sample code

Calls `RLPy.RCameraDofData.SetFarBlurScale` with the inputs shown in the example. 

def run_script():
    import RLPy
    new_data = RLPy.RCameraDofData()
    new_data.SetFarBlurScale(3)

SetFarTransitionRegion (self, fFarTransitionRegion)

Get the DOF Far Transition Region.

Parameters

  • fFarTransitionRegion

Sample code

Calls `RLPy.RCameraDofData.GetFarTransitionRegion` with the inputs shown in the example. 

def run_script():
    import RLPy
    new_data = RLPy.RCameraDofData()
    new_data.SetFarTransitionRegion(5)
    print( new_data.GetFarTransitionRegion() )

Sample code

Calls `RLPy.RCameraDofData.SetFarTransitionRegion` with the inputs shown in the example. 

def run_script():
    import RLPy
    new_data = RLPy.RCameraDofData()
    new_data.SetFarTransitionRegion(100)

SetFocus (self, fFocusData)

Set the camera DOF focus value.

Parameters

  • fFocusData

Sample code

Calls `RLPy.RCameraDofData.GetFocus` with the inputs shown in the example. 

def run_script():
    import RLPy
    new_data = RLPy.RCameraDofData()
    new_data.SetFocus(20)
    print( new_data.GetFocus() )

Sample code

Calls `RLPy.RCameraDofData.SetFocus` with the inputs shown in the example. 

def run_script():
    import RLPy
    new_data = RLPy.RCameraDofData()
    new_data.SetFocus(20)

SetMinBlendDistance (self, fMinBlendDistance)

Set the camera DOF Min Blend Distance.

Parameters

  • fMinBlendDistance

Sample code

Calls `RLPy.RCameraDofData.GetMinBlendDistance` with the inputs shown in the example. 

def run_script():
    import RLPy
    new_data = RLPy.RCameraDofData()
    new_data.SetMinBlendDistance(0.2)
    print( new_data.GetMinBlendDistance() )

Sample code

Calls `RLPy.RCameraDofData.SetMinBlendDistance` with the inputs shown in the example. 

def run_script():
    import RLPy
    new_data = RLPy.RCameraDofData()
    new_data.SetMinBlendDistance(0.2)

SetNearBlurScale (self, fNearBlurScale)

Get the camera DOF Near Blur.

Parameters

  • fNearBlurScale

Sample code

Calls `RLPy.RCameraDofData.SetNearBlurScale` with the inputs shown in the example. 

def run_script():
    import RLPy
    new_data = RLPy.RCameraDofData()
    new_data.SetNearBlurScale(2)

Sample code

Calls `RLPy.RCameraDofData.GetNearBlurScale` with the inputs shown in the example. 

def run_script():
    import RLPy
    new_data = RLPy.RCameraDofData()
    new_data.SetNearBlurScale(2)
    print( new_data.GetNearBlurScale() )

SetNearTransitionRegion (self, fNearTransitionRegion)

Get the camera DOF Near Transition Region.

Parameters

  • fNearTransitionRegion

Sample code

Calls `RLPy.RCameraDofData.SetNearTransitionRegion` with the inputs shown in the example. 

def run_script():
    import RLPy
    new_data = RLPy.RCameraDofData()
    new_data.SetNearTransitionRegion(5)

Sample code

Calls `RLPy.RCameraDofData.GetNearTransitionRegion` with the inputs shown in the example. 

def run_script():
    import RLPy
    new_data = RLPy.RCameraDofData()
    new_data.SetNearTransitionRegion(5)
    print( new_data.GetNearTransitionRegion() )

SetRange (self, fRangeData)

Set the camera DOF range value.

Parameters

  • fRangeData

Sample code

Calls `RLPy.RCameraDofData.SetRange` with the inputs shown in the example. 

def run_script():
    import RLPy
    new_data = RLPy.RCameraDofData()
    new_data.SetRange(20)

Sample code

Calls `RLPy.RCameraDofData.GetRange` with the inputs shown in the example. 

def run_script():
    import RLPy
    new_data = RLPy.RCameraDofData()
    new_data.SetRange(20)
    print( new_data.GetRange() )

Properties

thisown

Indicates whether this SWIG proxy owns the underlying C++ object.

Retrieved from "http://wiki.reallusion.com/index.php?title=IC8_Python_API:RLPy_RCameraDofData&oldid=6114"