Class CinemachineCollisionImpulseSource

Generate an Impulse Event this object's Collider collides with something or its trigger zone is entered.

This component should be attached to a GameObject with a Collider or a Collider2D. Objects colliding with this (or entering its trigger zone if it's a trigger) will be filtered according to the layer and tag settings defined here, and if they pass the filter, they will cause an impulse event to be generated.

Inheritance

Object

Object

Component

Behaviour

MonoBehaviour

CinemachineImpulseSource

CinemachineCollisionImpulseSource

Inherited Members

CinemachineImpulseSource.m_ImpulseDefinition

CinemachineImpulseSource.GenerateImpulseAt(Vector3, Vector3)

CinemachineImpulseSource.GenerateImpulse(Vector3)

CinemachineImpulseSource.GenerateImpulse()

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(String, Single)

MonoBehaviour.InvokeRepeating(String, Single, Single)

MonoBehaviour.CancelInvoke(String)

MonoBehaviour.IsInvoking(String)

MonoBehaviour.StartCoroutine(String)

MonoBehaviour.StartCoroutine(String, Object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(String)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(Object)

MonoBehaviour.useGUILayout

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, Component)

Component.TryGetComponent<T>(T)

Component.GetComponent(String)

Component.GetComponentInChildren(Type, Boolean)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(Boolean)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, Boolean)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(Boolean)

Component.GetComponentsInChildren<T>(Boolean, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, Boolean)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(Boolean)

Component.GetComponentsInParent<T>(Boolean, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.CompareTag(String)

Component.SendMessageUpwards(String, Object, SendMessageOptions)

Component.SendMessageUpwards(String, Object)

Component.SendMessageUpwards(String)

Component.SendMessageUpwards(String, SendMessageOptions)

Component.SendMessage(String, Object)

Component.SendMessage(String)

Component.SendMessage(String, Object, SendMessageOptions)

Component.SendMessage(String, SendMessageOptions)

Component.BroadcastMessage(String, Object, SendMessageOptions)

Component.BroadcastMessage(String, Object)

Component.BroadcastMessage(String)

Component.BroadcastMessage(String, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Component.rigidbody

Component.rigidbody2D

Component.camera

Component.light

Component.animation

Component.constantForce

Component.renderer

Component.audio

Component.networkView

Component.collider

Component.collider2D

Component.hingeJoint

Component.particleSystem

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(Object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, Boolean)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, Boolean)

Object.Destroy(Object, Single)

Object.Destroy(Object)

Object.DestroyImmediate(Object, Boolean)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, Boolean)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, Single)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)

Object.FindObjectOfType<T>()

UnityEngine.Object.FindObjectOfType<T>(System.Boolean)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindObjectOfType(Type, Boolean)

Object.ToString()

Object.name

Object.hideFlags

Namespace: Cinemachine

Syntax

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

Fields

m_IgnoreTag

No Impulse evemts will be generated for collisions with objects having these tags

Declaration

[Tooltip("No Impulse evemts will be generated for collisions with objects having these tags")]
public string m_IgnoreTag

Field Value

Type	Description
String

m_LayerMask

Only collisions with objects on these layers will generate Impulse events.

Declaration

[Header("Trigger Object Filter")]
[Tooltip("Only collisions with objects on these layers will generate Impulse events")]
public LayerMask m_LayerMask

Field Value

Type	Description
LayerMask

m_ScaleImpactWithMass

If checked, signal amplitude will be multiplied by the mass of the impacting object

Declaration

[Tooltip("If checked, signal amplitude will be multiplied by the mass of the impacting object")]
public bool m_ScaleImpactWithMass

Field Value

Type	Description
Boolean

m_ScaleImpactWithSpeed

If checked, signal amplitude will be multiplied by the speed of the impacting object

Declaration

[Tooltip("If checked, signal amplitude will be multiplied by the speed of the impacting object")]
public bool m_ScaleImpactWithSpeed

Field Value

Type	Description
Boolean

m_UseImpactDirection

If checked, signal direction will be affected by the direction of impact

Declaration

[Header("How To Generate The Impulse")]
[Tooltip("If checked, signal direction will be affected by the direction of impact")]
public bool m_UseImpactDirection

Field Value

Type	Description
Boolean