Class CinemachineImpulseDefinition

Definition of an impulse signal that gets propagated to listeners.

Here you provide a Raw Signal source, and define an envelope for time-scaling it to craft the complete Impulse signal shape. Also, you provide here parameters that define how the signal dissipates with spatial distance from the source location. Finally, you specify the Impulse Channel on which the signal will be sent.

An API method is provided here to take these parameters, create an Impulse Event, and broadcast it on the channel.

When creating a custom Impulse Source class, you will have an instance of this class as a field in your custom class. Be sure also to include the [CinemachineImpulseDefinition] attribute on the field, to get the right property drawer for it.

Inheritance

Object

CinemachineImpulseDefinition

Namespace: Cinemachine

Syntax

[DocumentationSorting(DocumentationSortingAttribute.Level.API)]
[Serializable]
public class CinemachineImpulseDefinition

Fields

m_AmplitudeGain

Legacy mode only: Gain to apply to the amplitudes defined in the signal source asset.

Declaration

[Tooltip("Legacy mode only: Gain to apply to the amplitudes defined in the signal source.  1 is normal.  Setting this to 0 completely mutes the signal.")]
public float m_AmplitudeGain

Field Value

Type	Description
Single

m_CustomImpulseShape

A user-defined impulse shape, used only if m_ImpulseShape is Custom. Defines the signal that will be generated. X axis must go from 0...1, and Y axis is the scale that will be applied to the impact velocity.

Declaration

[Tooltip("Defines the custom shape of the impact signal that will be generated.")]
public AnimationCurve m_CustomImpulseShape

Field Value

Type	Description
AnimationCurve

m_DirectionMode

Legacy mode only: How the signal direction behaves as the listener moves away from the origin.

Declaration

[Tooltip("Legacy mode only: How the signal direction behaves as the listener moves away from the origin.")]
public CinemachineImpulseManager.ImpulseEvent.DirectionMode m_DirectionMode

Field Value

Type	Description
CinemachineImpulseManager.ImpulseEvent.DirectionMode

m_DissipationDistance

The signal will have no effect outside this radius surrounding the impact point.

Declaration

[Tooltip("The signal will have no effect outside this radius surrounding the impact point.")]
public float m_DissipationDistance

Field Value

Type	Description
Single

m_DissipationMode

Legacy mode only: This defines how the signal will dissipate with distance beyond the impact radius.

Declaration

[Tooltip("Legacy mode only: This defines how the signal will dissipate with distance beyond the impact radius.")]
public CinemachineImpulseManager.ImpulseEvent.DissipationMode m_DissipationMode

Field Value

Type	Description
CinemachineImpulseManager.ImpulseEvent.DissipationMode

m_DissipationRate

This defines how the widely signal will spread within the effect radius before dissipating with distance from the impact point

Declaration

[Tooltip("This defines how the widely signal will spread within the effect radius before dissipating with distance from the impact point")]
[Range(0F, 1F)]
public float m_DissipationRate

Field Value

Type	Description
Single

m_FrequencyGain

Legacy mode only: Scale factor to apply to the time axis.

Declaration

[Tooltip("Legacy mode only: Scale factor to apply to the time axis.  1 is normal.  Larger magnitudes will make the signal progress more rapidly.")]
public float m_FrequencyGain

Field Value

Type	Description
Single

m_ImpactRadius

Legacy mode only: The signal will have full amplitude in this radius surrounding the impact point.
Beyond that it will dissipate with distance.

Declaration

[Header("Spatial Range")]
[Tooltip("Legacy mode only: The signal will have full amplitude in this radius surrounding the impact point.  Beyond that it will dissipate with distance.")]
public float m_ImpactRadius

Field Value

Type	Description
Single

m_ImpulseChannel

Impulse events generated here will appear on the channels included in the mask.

Declaration

[Tooltip("Impulse events generated here will appear on the channels included in the mask.")]
public int m_ImpulseChannel

Field Value

Type	Description
Int32

m_ImpulseDuration

The time during which the impact signal will occur.
The signal shape will be stretched to fill that time.

Declaration

[Tooltip("The time during which the impact signal will occur.  The signal shape will be stretched to fill that time.")]
public float m_ImpulseDuration

Field Value

Type	Description
Single

m_ImpulseShape

The shape of the impact signal.

Declaration

[Tooltip("Shape of the impact signal")]
public CinemachineImpulseDefinition.ImpulseShapes m_ImpulseShape

Field Value

Type	Description
CinemachineImpulseDefinition.ImpulseShapes

m_ImpulseType

How the impulse travels through space and time.

Declaration

[Tooltip("How the impulse travels through space and time.")]
public CinemachineImpulseDefinition.ImpulseTypes m_ImpulseType

Field Value

Type	Description
CinemachineImpulseDefinition.ImpulseTypes

m_PropagationSpeed

The speed (m/s) at which the impulse propagates through space. High speeds allow listeners to react instantaneously, while slower speeds allow listeners in the scene to react as if to a wave spreading from the source.

Declaration

[Tooltip("The speed (m/s) at which the impulse propagates through space.  High speeds allow listeners to react instantaneously, while slower speeds allow listeners in the scene to react as if to a wave spreading from the source.")]
public float m_PropagationSpeed

Field Value

Type	Description
Single

m_Randomize

Legacy mode only: Randomize the signal start time

Declaration

[Tooltip("Legacy mode only: Randomize the signal start time")]
public bool m_Randomize

Field Value

Type	Description
Boolean

m_RawSignal

Legacy mode only: Defines the signal that will be generated.

Declaration

[Header("Signal Shape")]
[Tooltip("Legacy mode only: Defines the signal that will be generated.")]
[CinemachineEmbeddedAssetProperty(true)]
public SignalSourceAsset m_RawSignal

Field Value

Type	Description
SignalSourceAsset

m_RepeatMode

Legacy mode only: How to fit the signal into the envelope time

Declaration

[Tooltip("Legacy mode only: How to fit the signal into the envelope time")]
public CinemachineImpulseDefinition.RepeatMode m_RepeatMode

Field Value

Type	Description
CinemachineImpulseDefinition.RepeatMode

m_TimeEnvelope

Legacy mode only: This defines the time-envelope of the signal.
The raw signal will be time-scaled to fit in the envelope.

Declaration

[Tooltip("Legacy mode only: This defines the time-envelope of the signal.  The raw signal will be time-scaled to fit in the envelope.")]
public CinemachineImpulseManager.EnvelopeDefinition m_TimeEnvelope

Field Value

Type	Description
CinemachineImpulseManager.EnvelopeDefinition

Methods

CreateAndReturnEvent(Vector3, Vector3)

Generate an impulse event at a location in space, and broadcast it on the appropriate impulse channel

Declaration

public CinemachineImpulseManager.ImpulseEvent CreateAndReturnEvent(Vector3 position, Vector3 velocity)

Parameters

Type	Name	Description
Vector3	position	Event originates at this position in world space
Vector3	velocity	This direction is considered to be "down" for the purposes of the event signal, and the magnitude of the signal will be scaled according to the length of this vector

Returns

Type	Description
CinemachineImpulseManager.ImpulseEvent	The newly-created impulse event. This can be used to dynmically adjust the event settings while the event is active. Note that this event object may be recycled for future events, so the pointer should not be retained for too long.

CreateEvent(Vector3, Vector3)

Generate an impulse event at a location in space, and broadcast it on the appropriate impulse channel

Declaration

public void CreateEvent(Vector3 position, Vector3 velocity)

Parameters

Type	Name	Description
Vector3	position	Event originates at this position in world space
Vector3	velocity	This direction is considered to be "down" for the purposes of the event signal, and the magnitude of the signal will be scaled according to the length of this vector

OnValidate()

Call this from your behaviour's OnValidate to validate the fields here

Declaration

public void OnValidate()