Class CinemachineFreeLookModifier.PositionDampingModifier

Builtin FreeLook modifier for positional damping. Modifies positional damping at the start of the camera pipeline.

Inheritance
object
CinemachineFreeLookModifier.Modifier
CinemachineFreeLookModifier.ComponentModifier<CinemachineFreeLookModifier.IModifiablePositionDamping>
CinemachineFreeLookModifier.PositionDampingModifier
Inherited Members
Namespace: Unity.Cinemachine
Assembly: Unity.Cinemachine.dll
Syntax
public class CinemachineFreeLookModifier.PositionDampingModifier : CinemachineFreeLookModifier.ComponentModifier<CinemachineFreeLookModifier.IModifiablePositionDamping>

Fields

Damping

Values for the top and bottom rigs

Declaration
public CinemachineFreeLookModifier.TopBottomRigs<Vector3> Damping
Field Value
Type Description
CinemachineFreeLookModifier.TopBottomRigs<Vector3>

Methods

AfterPipeline(CinemachineVirtualCameraBase, ref CameraState, float, float)

Called from extension's PostPipelineStageCallback(Finalize). Perform any necessary actions to state, and restore any camera parameters changed in BeforePipeline(CinemachineVirtualCameraBase, ref CameraState, float, float).

Declaration
public override void AfterPipeline(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

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(CinemachineVirtualCameraBase, ref CameraState, float, float).

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

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