Class Collider

A base class for all colliders.

System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
[Tooltip("A base class for all colliders.")]
public abstract class Collider : PhysicsColliderActor, ITransformable, ISceneObject

Constructors

Collider()

Initializes a new instance of the Collider.

Declaration
protected Collider()

Properties

Center

Gets or sets the center of the collider, measured in the object's local space.

Declaration
[EditorOrder(10)]
[EditorDisplay("Collider", null)]
[Unmanaged]
[Tooltip("The center of the collider, measured in the object's local space.")]
public Vector3 Center { get; set; }
Property Value
Vector3

ContactOffset

Gets or sets the contact offset.

Declaration
[EditorOrder(1)]
[Limit(0F, 100F, 1F)]
[EditorDisplay("Collider", null)]
[Unmanaged]
[Tooltip("The contact offset.")]
public float ContactOffset { get; set; }
Property Value
System.Single

Remarks

Colliders whose distance is less than the sum of their ContactOffset values will generate contacts. The contact offset must be positive. Contact offset allows the collision detection system to predictively enforce the contact constraint even when the objects are slightly separated.

IsAttached

Determines whether this collider is attached to the body.

Declaration
[Unmanaged]
[Tooltip("Determines whether this collider is attached to the body.")]
public bool IsAttached { get; }
Property Value
System.Boolean

IsTrigger

Gets or sets the 'IsTrigger' flag.

Declaration
[EditorOrder(0)]
[EditorDisplay("Collider", null)]
[Unmanaged]
[Tooltip("The 'IsTrigger' flag.")]
public bool IsTrigger { get; set; }
Property Value
System.Boolean

Remarks

A trigger doesn't register a collision with an incoming Rigidbody. Instead, it sends OnTriggerEnter, OnTriggerExit and OnTriggerStay message when a rigidbody enters or exits the trigger volume.

Material

The physical material used to define the collider physical properties.

Declaration
[EditorOrder(2)]
[AssetReference(typeof(PhysicalMaterial), true)]
[EditorDisplay("Collider", null)]
[Unmanaged]
[Tooltip("The physical material used to define the collider physical properties.")]
public JsonAsset Material { get; set; }
Property Value
JsonAsset

Methods

ClosestPoint(Vector3, out Vector3)

Gets a point on the collider that is closest to a given location. Can be used to find a hit location or position to apply explosion force or any other special effects.

Declaration
[Unmanaged]
public void ClosestPoint(Vector3 position, out Vector3 result)
Parameters
Vector3 position

The position to find the closest point to it.
Vector3 result

The result point on the collider that is closest to the specified location.

ComputePenetration(Collider, Collider, out Vector3, out Single)

Computes minimum translational distance between two geometry objects. Translating the first collider by direction * distance will separate the colliders apart if the function returned true. Otherwise, direction and distance are not defined. The one of the colliders has to be BoxCollider, SphereCollider CapsuleCollider or a convex MeshCollider. The other one can be any type. If objects do not overlap, the function can not compute the distance and returns false.

Declaration
[Unmanaged]
public static bool ComputePenetration(Collider colliderA, Collider colliderB, out Vector3 direction, out float distance)
Parameters
Collider colliderA

The first collider.
Collider colliderB

The second collider.
Vector3 direction

The computed direction along which the translation required to separate the colliders apart is minimal. Valid only if function returns true.
System.Single distance

The penetration distance along direction that is required to separate the colliders apart. Valid only if function returns true.
Returns
System.Boolean

True if the distance has successfully been computed, i.e. if objects do overlap, otherwise false.

RayCast(Vector3, Vector3, out RayCastHit, Single)

Performs a raycast against this collider, returns results in a RaycastHit structure.

Declaration
[Unmanaged]
public bool RayCast(Vector3 origin, Vector3 direction, out RayCastHit hitInfo, float maxDistance = 3.40282347E+38F)
Parameters
Vector3 origin

The origin of the ray.
Vector3 direction

The normalized direction of the ray.
RayCastHit hitInfo

The result hit information. Valid only when method returns true.
System.Single maxDistance

The maximum distance the ray should check for collisions.
Returns
System.Boolean

True if ray hits an object, otherwise false.

RayCast(Vector3, Vector3, out Single, Single)

Performs a raycast against this collider shape.

Declaration
[Unmanaged]
public bool RayCast(Vector3 origin, Vector3 direction, out float resultHitDistance, float maxDistance = 3.40282347E+38F)
Parameters
Vector3 origin

The origin of the ray.
Vector3 direction

The normalized direction of the ray.
System.Single resultHitDistance

The raycast result hit position distance from the ray origin. Valid only if raycast hits anything.
System.Single maxDistance

The maximum distance the ray should check for collisions.
Returns
System.Boolean

True if ray hits an object, otherwise false.

Events

CollisionEnter

Occurs when a collision start gets registered for this collider (it collides with something).

Declaration
public event CollisionDelegate CollisionEnter
Event Type
CollisionDelegate

CollisionExit

Occurs when a collision end gets registered for this collider (it ends colliding with something).

Declaration
public event CollisionDelegate CollisionExit
Event Type
CollisionDelegate

TriggerEnter

Occurs when a trigger touching start gets registered for this collider (the other collider enters it and triggers the event).

Declaration
public event TriggerDelegate TriggerEnter
Event Type
TriggerDelegate

TriggerExit

Occurs when a trigger touching end gets registered for this collider (the other collider enters it and triggers the event).

Declaration
public event TriggerDelegate TriggerExit
Event Type
TriggerDelegate

Extension Methods

See Also