Class CinemachineBasicMultiChannelPerlin

As a part of the Cinemachine Pipeline implementing the Noise stage, this component adds Perlin Noise to the Camera state, in the Correction channel of the CameraState.

The noise is created by using a predefined noise profile asset. This defines the shape of the noise over time. You can scale this in amplitude or in time, to produce a large family of different noises using the same profile.

Inheritance
MonoBehaviour
CinemachineComponentBase
CinemachineBasicMultiChannelPerlin
Inherited Members
Namespace: Cinemachine
Syntax
[DocumentationSorting(DocumentationSortingAttribute.Level.UserRef)]
public class CinemachineBasicMultiChannelPerlin : CinemachineComponentBase

Fields

m_AmplitudeGain

Gain to apply to the amplitudes defined in the settings asset.

Declaration
public float m_AmplitudeGain
Field Value
Type Description
System.Single

m_FrequencyGain

Scale factor to apply to the frequencies defined in the settings asset.

Declaration
public float m_FrequencyGain
Field Value
Type Description
System.Single

m_NoiseProfile

Serialized property for referencing a NoiseSettings asset

Declaration
public NoiseSettings m_NoiseProfile
Field Value
Type Description
NoiseSettings

Properties

IsValid

True if the component is valid, i.e. it has a noise definition and is enabled.

Declaration
public override bool IsValid { get; }
Property Value
Type Description
System.Boolean
Overrides

Stage

Get the Cinemachine Pipeline stage that this component implements. Always returns the Noise stage

Declaration
public override CinemachineCore.Stage Stage { get; }
Property Value
Type Description
CinemachineCore.Stage
Overrides

Methods

MutateCameraState(ref CameraState, Single)

Applies noise to the Correction channel of the CameraState if the delta time is greater than 0. Otherwise, does nothing.

Declaration
public override void MutateCameraState(ref CameraState curState, float deltaTime)
Parameters
Type Name Description
CameraState curState

The current camera state
System.Single deltaTime

How much to advance the perlin noise generator. Noise is only applied if this value is greater than or equal to 0
Overrides

See Also