Cinemachine
 | CinemachineBasicMultiChannelPerlin Class |
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 HierarchySystemObject Object
Component
Behaviour
MonoBehaviour
CinemachineCinemachineComponentBase
CinemachineCinemachineBasicMultiChannelPerlin
Component
Behaviour
MonoBehaviour
CinemachineCinemachineComponentBase
CinemachineCinemachineBasicMultiChannelPerlin
Namespace: Cinemachine
Assembly: Cinemachine (in Cinemachine.dll) Version: 2.0.0.0 (2.0.0.0)
Syntax[DocumentationSortingAttribute(8f, DocumentationSortingAttributeLevel.UserRef)] [AddComponentMenu("")] [RequireComponent(typeof(CinemachinePipeline))] [SaveDuringPlayAttribute] public class CinemachineBasicMultiChannelPerlin : CinemachineComponentBase
Cinemachine.CinemachineBasicMultiChannelPerlin = function(); Type.createClass( 'Cinemachine.CinemachineBasicMultiChannelPerlin', Cinemachine.CinemachineComponentBase);
The CinemachineBasicMultiChannelPerlin type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | FollowTarget | Returns the owner vcam's Follow target. (Inherited from CinemachineComponentBase.) |
| IsValid | True if the component is valid, i.e. it has a noise definition and is enabled. (Overrides CinemachineComponentBaseIsValid.) |
| LookAtTarget | Returns the owner vcam's LookAt target. (Inherited from CinemachineComponentBase.) |
| Stage | Get the Cinemachine Pipeline stage that this component implements.
Always returns the Noise stage (Overrides CinemachineComponentBaseStage.) |
| VcamState | Returns the owner vcam's CameraState. (Inherited from CinemachineComponentBase.) |
| VirtualCamera | Get the associated CinemachineVirtualCameraBase (Inherited from CinemachineComponentBase.) |
Methods| Name | Description | |
|---|---|---|
 | MutateCameraState | Applies noise to the Correction channel of the CameraState if the
delta time is greater than 0. Otherwise, does nothing. (Overrides CinemachineComponentBaseMutateCameraState(CameraState, Single).) |
| OnPositionDragged | API for the editor, to process a position drag from the user.
Base class implementation does nothing. (Inherited from CinemachineComponentBase.) |
Fields| Name | Description | |
|---|---|---|
 | m_AmplitudeGain |
Gain to apply to the amplitudes defined in the settings asset.
|
| m_FrequencyGain |
Scale factor to apply to the frequencies defined in the settings asset.
|
| m_NoiseProfile |
Serialized property for referencing a NoiseSettings asset
|
See Also