Class CinemachineImpulseSource

An event-driven class that broadcasts an impulse signal to listeners.

This is the base class for custom impulse sources. It contains an impulse definition, where the characteristics of the impulse signal are defined.

API methods are fined for actually broadcasting the impulse. Call these methods from your custom code, or hook them up to game events in the Editor.

Inheritance

Object

CinemachineImpulseSource

CinemachineCollisionImpulseSource

Namespace: Cinemachine

Syntax

[DocumentationSorting(DocumentationSortingAttribute.Level.UserRef)]
public class CinemachineImpulseSource : MonoBehaviour

Fields

m_ImpulseDefinition

This defines the complete impulse signal that will be broadcast.

Declaration

public CinemachineImpulseDefinition m_ImpulseDefinition

Field Value

Type	Description
CinemachineImpulseDefinition

Methods

GenerateImpulse()

Broadcast the Impulse Signal onto the appropriate channels, with default velocity = (0, -1, 0), and a default position which is this transform's location.

Declaration

public void GenerateImpulse()

GenerateImpulse(Vector3)

Broadcast the Impulse Signal onto the appropriate channels, using a custom impact velocity, and this transfom's position.

Declaration

public void GenerateImpulse(Vector3 velocity)

Parameters

Type	Name	Description
Vector3	velocity	The impact magnitude and direction

GenerateImpulseAt(Vector3, Vector3)

Broadcast the Impulse Signal onto the appropriate channels, using a custom position and impact velocity

Declaration

public void GenerateImpulseAt(Vector3 position, Vector3 velocity)

Parameters

Type	Name	Description
Vector3	position	The world-space position from which the impulse will emanate
Vector3	velocity	The impact magnitude and direction