Class Collision

Contains a collision information passed to the OnCollisionEnter and OnCollisionExit events.

System.Object
Collision
System.Collections.IEnumerable
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
public sealed class Collision : IEnumerable

Properties

Contacts

The contacts locations.

Declaration
public ContactPoint[] Contacts { get; }
Property Value
ContactPoint[]

Impulse

The total impulse applied to this contact pair to resolve the collision.

Declaration
public Vector3 Impulse { get; }
Property Value
Vector3

Remarks

The total impulse is obtained by summing up impulses applied at all contact points in this collision pair.

OtherActor

The second collider (other instance).

Declaration
public Actor OtherActor { get; }
Property Value
Actor

OtherCollider

The second collider (other instance). It may be null if this actor is not the Collider (eg. Terrain).

Declaration
public Collider OtherCollider { get; }
Property Value
Collider

OtherVelocity

The linear velocity of the second colliding object (other instance).

Declaration
public Vector3 OtherVelocity { get; }
Property Value
Vector3

RelativeVelocity

The relative linear velocity of the two colliding objects.

Declaration
public Vector3 RelativeVelocity { get; }
Property Value
Vector3

Remarks

Can be used to detect stronger collisions.

ThisActor

The first collider (this instance).

Declaration
public Actor ThisActor { get; }
Property Value
Actor

ThisCollider

The first collider (this instance). It may be null if this actor is not the Collider (eg. Terrain).

Declaration
public Collider ThisCollider { get; }
Property Value
Collider

ThisVelocity

The linear velocity of the first colliding object (this instance).

Declaration
public Vector3 ThisVelocity { get; }
Property Value
Vector3

Methods

GetEnumerator()

Gets the contact points enumerator

Declaration
public IEnumerator GetEnumerator()
Returns
System.Collections.IEnumerator

The contact points enumerator.
Implements
System.Collections.IEnumerable.GetEnumerator()

Extension Methods