Class CinemachineFreeLookModifier.NoiseModifier

Builtin modifier for noise components such as CinemachineBasicMultiChannelPerlin. Applies scaling to amplitude and frequency.

Inheritance

object

CinemachineFreeLookModifier.Modifier

CinemachineFreeLookModifier.ComponentModifier<CinemachineFreeLookModifier.IModifiableNoise>

CinemachineFreeLookModifier.NoiseModifier

Inherited Members

CinemachineFreeLookModifier.ComponentModifier<CinemachineFreeLookModifier.IModifiableNoise>.CachedComponent

CinemachineFreeLookModifier.ComponentModifier<CinemachineFreeLookModifier.IModifiableNoise>.HasRequiredComponent

CinemachineFreeLookModifier.ComponentModifier<CinemachineFreeLookModifier.IModifiableNoise>.CachedComponentType

CinemachineFreeLookModifier.ComponentModifier<CinemachineFreeLookModifier.IModifiableNoise>.RefreshCache(CinemachineVirtualCameraBase)

CinemachineFreeLookModifier.Modifier.Validate(CinemachineVirtualCameraBase)

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.NoiseModifier : CinemachineFreeLookModifier.ComponentModifier<CinemachineFreeLookModifier.IModifiableNoise>

Fields

Noise

Values for the top and bottom rigs

Declaration

public CinemachineFreeLookModifier.TopBottomRigs<CinemachineFreeLookModifier.NoiseModifier.NoiseSettings> Noise

Field Value

Type	Description
CinemachineFreeLookModifier.TopBottomRigs<CinemachineFreeLookModifier.NoiseModifier.NoiseSettings>

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

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

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

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)