Class Collider
A base class for all colliders.
Inheritance
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
public abstract class Collider : PhysicsColliderActor, ISerializableConstructors
Collider()
Properties
Center
Gets or sets the center of the collider, measured in the object's local space.
Declaration
[EditorOrder(10)]
[EditorDisplay("Collider", null)]
[ValueCategory]
[Unmanaged]
public Vector3 Center { get; set; }Property Value
|
Vector3
|
ContactOffset
Gets or sets the contact offset. 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.
Declaration
[EditorOrder(1)]
[Limit(0F, 100F, 1F)]
[EditorDisplay("Collider", null)]
[ValueCategory]
[Unmanaged]
public float ContactOffset { get; set; }Property Value
|
System.Single
|
IsTrigger
Gets or sets the 'IsTrigger' flag. A trigger doesn't register a collision with an incoming Rigidbody. Instead, it sends OnTriggerEnter and OnTriggerExit message when a rigidbody enters or exits the trigger volume.
Declaration
[EditorOrder(0)]
[EditorDisplay("Collider", null)]
[Unmanaged]
public bool IsTrigger { get; set; }Property Value
|
System.Boolean
|
Material
The physical material used to define the collider physical properties.
Declaration
[EditorOrder(2)]
[EditorDisplay("Collider", null)]
[Unmanaged]
public JsonAssetReference<PhysicalMaterial> Material { get; set; }Property Value
|
JsonAssetReference<PhysicalMaterial>
|
Methods
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. |