Class CinemachineImpulseListener

An extension for Cinemachine Virtual Camera which post-processes the final position of the virtual camera. It listens for CinemachineImpulse signals on the specified channels, and moves the camera in response to them.

Inheritance
Object
CinemachineExtension
CinemachineImpulseListener
Inherited Members
Namespace: Cinemachine
Syntax
public class CinemachineImpulseListener : CinemachineExtension

Fields

m_ApplyAfter

When to apply the impulse reaction. Default is Noise.
Modify this if necessary to influence the ordering of extension effects

Declaration
public CinemachineCore.Stage m_ApplyAfter
Field Value
Type Description
CinemachineCore.Stage

m_ChannelMask

Impulse events on channels not included in the mask will be ignored.

Declaration
public int m_ChannelMask
Field Value
Type Description
Int32

m_Gain

Gain to apply to the Impulse signal.

Declaration
public float m_Gain
Field Value
Type Description
Single

m_Use2DDistance

Enable this to perform distance calculation in 2D (ignore Z).

Declaration
public bool m_Use2DDistance
Field Value
Type Description
Boolean

Methods

PostPipelineStageCallback(CinemachineVirtualCameraBase, CinemachineCore.Stage, ref CameraState, Single)

React to any detected impulses

Declaration
protected override void PostPipelineStageCallback(CinemachineVirtualCameraBase vcam, CinemachineCore.Stage stage, ref CameraState state, float deltaTime)
Parameters
Type Name Description
CinemachineVirtualCameraBase vcam

The virtual camera being processed
CinemachineCore.Stage stage

The current pipeline stage
CameraState state

The current virtual camera state
Single deltaTime

The current applicable deltaTime
Overrides