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
System.Object
CinemachineExtension
CinemachineImpulseListener
Inherited Members
Namespace: Cinemachine
Syntax
[DocumentationSorting(DocumentationSortingAttribute.Level.UserRef)]
public class CinemachineImpulseListener : CinemachineExtension

Fields

m_ChannelMask

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

Declaration
public int m_ChannelMask
Field Value
Type Description
System.Int32

m_Gain

Gain to apply to the Impulse signal.

Declaration
public float m_Gain
Field Value
Type Description
System.Single

m_Use2DDistance

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

Declaration
public bool m_Use2DDistance
Field Value
Type Description
System.Boolean

Methods

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

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