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
Implements
Inherited Members
Namespace: Unity.Cinemachine
Assembly: solution.dll
Syntax
[AddComponentMenu("Cinemachine/Procedural/Noise/Cinemachine Basic Multi Channel Perlin")]
[DisallowMultipleComponent]
[CameraPipeline(CinemachineCore.Stage.Noise)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.cinemachine@3.0/manual/CinemachineBasicMultiChannelPerlin.html")]
public class CinemachineBasicMultiChannelPerlin : CinemachineComponentBase, CinemachineFreeLookModifier.IModifiableNoise
Fields
Name | Description |
---|---|
AmplitudeGain | Gain to apply to the amplitudes defined in the settings asset. |
FrequencyGain | Scale factor to apply to the frequencies defined in the settings asset. |
NoiseProfile | Serialized property for referencing a NoiseSettings asset |
PivotOffset | When rotating the camera, offset the camera's pivot position by this much (camera space) |
Properties
Name | Description |
---|---|
IsValid | True if the component is valid, i.e. it has a noise definition and is enabled. |
Stage | Get the Cinemachine Pipeline stage that this component implements. Always returns the Noise stage |
Methods
Name | Description |
---|---|
MutateCameraState(ref CameraState, float) | Applies noise to the Correction channel of the CameraState if the delta time is greater than 0. Otherwise, does nothing. |
ReSeed() | Generate a new random seed |