Class CinemachineFreeLookModifier.LensModifier

Builtin modifier for camera lens. Applies the lens at the start of the camera pipeline.

Inheritance
Object
CinemachineFreeLookModifier.Modifier
CinemachineFreeLookModifier.LensModifier
Inherited Members
Namespace: Unity.Cinemachine
Syntax
public class LensModifier : CinemachineFreeLookModifier.Modifier

Fields

Bottom

Settings for bottom orbit

Declaration
[Tooltip("Value to take at the bottom of the axis range")]
public LensSettings Bottom
Field Value
Type Description
LensSettings

Top

Values for the top and bottom rigs

Declaration
[Tooltip("Value to take at the top of the axis range")]
public LensSettings Top
Field Value
Type Description
LensSettings

Methods

BeforePipeline(CinemachineVirtualCameraBase, ref CameraState, Single, Single)

Called from extension's PrePipelineMutateCameraState(). Perform any necessary actions to modify relevant camera settings. Original camera settings should be restored in .

Declaration
public override void BeforePipeline(CinemachineVirtualCameraBase vcam, ref CameraState state, float deltaTime, float modifierValue)
Parameters
Type Name Description
CinemachineVirtualCameraBase vcam

vcam owner
CameraState state

current vcam state. May be modified in this function
Single deltaTime

current applicable deltaTime
Single modifierValue

The normalized value of the modifier variable.
This is the FreeLook's vertical axis. Ranges from -1 to 1, where 0 is center rig.
Overrides

Reset(CinemachineVirtualCameraBase)

Called when the modifier is created. Initialize fields with appropriate values.

Declaration
public override void Reset(CinemachineVirtualCameraBase vcam)
Parameters
Type Name Description
CinemachineVirtualCameraBase vcam

the virtual camera owner
Overrides

Validate(CinemachineVirtualCameraBase)

Called from OnValidate to validate this component

Declaration
public override void Validate(CinemachineVirtualCameraBase vcam)
Parameters
Type Name Description
CinemachineVirtualCameraBase vcam

the virtual camera owner
Overrides