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

CinemachineFreeLookModifier.Modifier.CachedComponentType

CinemachineFreeLookModifier.Modifier.HasRequiredComponent

CinemachineFreeLookModifier.Modifier.RefreshCache(CinemachineVirtualCameraBase)

CinemachineFreeLookModifier.Modifier.AfterPipeline(CinemachineVirtualCameraBase, ref CameraState, float, float)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Cinemachine

Assembly: Unity.Cinemachine.dll

Syntax

public class CinemachineFreeLookModifier.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

Settings for top orbit

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, float, float)

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

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
float	deltaTime	current applicable deltaTime
float	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

CinemachineFreeLookModifier.Modifier.BeforePipeline(CinemachineVirtualCameraBase, ref CameraState, float, float)

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

CinemachineFreeLookModifier.Modifier.Reset(CinemachineVirtualCameraBase)

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

CinemachineFreeLookModifier.Modifier.Validate(CinemachineVirtualCameraBase)