Interface ICollidable

Namespace: Unity.Physics
Syntax
public interface ICollidable

Methods

BoxCast(float3, quaternion, float3, float3, Single, out ColliderCastHit, CollisionFilter, QueryInteraction)

Declaration
bool BoxCast(float3 center, quaternion orientation, float3 halfExtents, float3 direction, float maxDistance, out ColliderCastHit hitInfo, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)
Parameters
Type Name Description
float3 center
quaternion orientation
float3 halfExtents
float3 direction
Single maxDistance
ColliderCastHit hitInfo
CollisionFilter filter
QueryInteraction queryInteraction
Returns
Type Description
Boolean

BoxCast(float3, quaternion, float3, float3, Single, CollisionFilter, QueryInteraction)

Declaration
bool BoxCast(float3 center, quaternion orientation, float3 halfExtents, float3 direction, float maxDistance, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)
Parameters
Type Name Description
float3 center
quaternion orientation
float3 halfExtents
float3 direction
Single maxDistance
CollisionFilter filter
QueryInteraction queryInteraction
Returns
Type Description
Boolean

BoxCastAll(float3, quaternion, float3, float3, Single, ref NativeList<ColliderCastHit>, CollisionFilter, QueryInteraction)

Declaration
bool BoxCastAll(float3 center, quaternion orientation, float3 halfExtents, float3 direction, float maxDistance, ref NativeList<ColliderCastHit> outHits, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)
Parameters
Type Name Description
float3 center
quaternion orientation
float3 halfExtents
float3 direction
Single maxDistance
NativeList<ColliderCastHit> outHits
CollisionFilter filter
QueryInteraction queryInteraction
Returns
Type Description
Boolean

BoxCastCustom<T>(float3, quaternion, float3, float3, Single, ref T, CollisionFilter, QueryInteraction)

Declaration
bool BoxCastCustom<T>(float3 center, quaternion orientation, float3 halfExtents, float3 direction, float maxDistance, ref T collector, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)
    where T : struct, ICollector<ColliderCastHit>
Parameters
Type Name Description
float3 center
quaternion orientation
float3 halfExtents
float3 direction
Single maxDistance
T collector
CollisionFilter filter
QueryInteraction queryInteraction
Returns
Type Description
Boolean
Type Parameters
Name Description
T

CalculateAabb()

Declaration
Aabb CalculateAabb()
Returns
Type Description
Aabb

CalculateAabb(RigidTransform)

Declaration
Aabb CalculateAabb(RigidTransform transform)
Parameters
Type Name Description
RigidTransform transform
Returns
Type Description
Aabb

CalculateDistance(ColliderDistanceInput)

Declaration
bool CalculateDistance(ColliderDistanceInput input)
Parameters
Type Name Description
ColliderDistanceInput input
Returns
Type Description
Boolean

CalculateDistance(ColliderDistanceInput, ref NativeList<DistanceHit>)

Declaration
bool CalculateDistance(ColliderDistanceInput input, ref NativeList<DistanceHit> allHits)
Parameters
Type Name Description
ColliderDistanceInput input
NativeList<DistanceHit> allHits
Returns
Type Description
Boolean

CalculateDistance(ColliderDistanceInput, out DistanceHit)

Declaration
bool CalculateDistance(ColliderDistanceInput input, out DistanceHit closestHit)
Parameters
Type Name Description
ColliderDistanceInput input
DistanceHit closestHit
Returns
Type Description
Boolean

CalculateDistance(PointDistanceInput)

Declaration
bool CalculateDistance(PointDistanceInput input)
Parameters
Type Name Description
PointDistanceInput input
Returns
Type Description
Boolean

CalculateDistance(PointDistanceInput, ref NativeList<DistanceHit>)

Declaration
bool CalculateDistance(PointDistanceInput input, ref NativeList<DistanceHit> allHits)
Parameters
Type Name Description
PointDistanceInput input
NativeList<DistanceHit> allHits
Returns
Type Description
Boolean

CalculateDistance(PointDistanceInput, out DistanceHit)

Declaration
bool CalculateDistance(PointDistanceInput input, out DistanceHit closestHit)
Parameters
Type Name Description
PointDistanceInput input
DistanceHit closestHit
Returns
Type Description
Boolean

CalculateDistance<T>(ColliderDistanceInput, ref T)

Declaration
bool CalculateDistance<T>(ColliderDistanceInput input, ref T collector)
    where T : struct, ICollector<DistanceHit>
Parameters
Type Name Description
ColliderDistanceInput input
T collector
Returns
Type Description
Boolean
Type Parameters
Name Description
T

CalculateDistance<T>(PointDistanceInput, ref T)

Declaration
bool CalculateDistance<T>(PointDistanceInput input, ref T collector)
    where T : struct, ICollector<DistanceHit>
Parameters
Type Name Description
PointDistanceInput input
T collector
Returns
Type Description
Boolean
Type Parameters
Name Description
T

CapsuleCast(float3, float3, Single, float3, Single, out ColliderCastHit, CollisionFilter, QueryInteraction)

Declaration
bool CapsuleCast(float3 point1, float3 point2, float radius, float3 direction, float maxDistance, out ColliderCastHit hitInfo, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)
Parameters
Type Name Description
float3 point1
float3 point2
Single radius
float3 direction
Single maxDistance
ColliderCastHit hitInfo
CollisionFilter filter
QueryInteraction queryInteraction
Returns
Type Description
Boolean

CapsuleCast(float3, float3, Single, float3, Single, CollisionFilter, QueryInteraction)

Declaration
bool CapsuleCast(float3 point1, float3 point2, float radius, float3 direction, float maxDistance, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)
Parameters
Type Name Description
float3 point1
float3 point2
Single radius
float3 direction
Single maxDistance
CollisionFilter filter
QueryInteraction queryInteraction
Returns
Type Description
Boolean

CapsuleCastAll(float3, float3, Single, float3, Single, ref NativeList<ColliderCastHit>, CollisionFilter, QueryInteraction)

Declaration
bool CapsuleCastAll(float3 point1, float3 point2, float radius, float3 direction, float maxDistance, ref NativeList<ColliderCastHit> outHits, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)
Parameters
Type Name Description
float3 point1
float3 point2
Single radius
float3 direction
Single maxDistance
NativeList<ColliderCastHit> outHits
CollisionFilter filter
QueryInteraction queryInteraction
Returns
Type Description
Boolean

CapsuleCastCustom<T>(float3, float3, Single, float3, Single, ref T, CollisionFilter, QueryInteraction)

Declaration
bool CapsuleCastCustom<T>(float3 point1, float3 point2, float radius, float3 direction, float maxDistance, ref T collector, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)
    where T : struct, ICollector<ColliderCastHit>
Parameters
Type Name Description
float3 point1
float3 point2
Single radius
float3 direction
Single maxDistance
T collector
CollisionFilter filter
QueryInteraction queryInteraction
Returns
Type Description
Boolean
Type Parameters
Name Description
T

CastCollider(ColliderCastInput)

Declaration
bool CastCollider(ColliderCastInput input)
Parameters
Type Name Description
ColliderCastInput input
Returns
Type Description
Boolean

CastCollider(ColliderCastInput, ref NativeList<ColliderCastHit>)

Declaration
bool CastCollider(ColliderCastInput input, ref NativeList<ColliderCastHit> allHits)
Parameters
Type Name Description
ColliderCastInput input
NativeList<ColliderCastHit> allHits
Returns
Type Description
Boolean

CastCollider(ColliderCastInput, out ColliderCastHit)

Declaration
bool CastCollider(ColliderCastInput input, out ColliderCastHit closestHit)
Parameters
Type Name Description
ColliderCastInput input
ColliderCastHit closestHit
Returns
Type Description
Boolean

CastCollider<T>(ColliderCastInput, ref T)

Declaration
bool CastCollider<T>(ColliderCastInput input, ref T collector)
    where T : struct, ICollector<ColliderCastHit>
Parameters
Type Name Description
ColliderCastInput input
T collector
Returns
Type Description
Boolean
Type Parameters
Name Description
T

CastRay(RaycastInput)

Declaration
bool CastRay(RaycastInput input)
Parameters
Type Name Description
RaycastInput input
Returns
Type Description
Boolean

CastRay(RaycastInput, ref NativeList<RaycastHit>)

Declaration
bool CastRay(RaycastInput input, ref NativeList<RaycastHit> allHits)
Parameters
Type Name Description
RaycastInput input
NativeList<RaycastHit> allHits
Returns
Type Description
Boolean

CastRay(RaycastInput, out RaycastHit)

Declaration
bool CastRay(RaycastInput input, out RaycastHit closestHit)
Parameters
Type Name Description
RaycastInput input
RaycastHit closestHit
Returns
Type Description
Boolean

CastRay<T>(RaycastInput, ref T)

Declaration
bool CastRay<T>(RaycastInput input, ref T collector)
    where T : struct, ICollector<RaycastHit>
Parameters
Type Name Description
RaycastInput input
T collector
Returns
Type Description
Boolean
Type Parameters
Name Description
T

CheckBox(float3, quaternion, float3, CollisionFilter, QueryInteraction)

Declaration
bool CheckBox(float3 center, quaternion orientation, float3 halfExtents, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)
Parameters
Type Name Description
float3 center
quaternion orientation
float3 halfExtents
CollisionFilter filter
QueryInteraction queryInteraction
Returns
Type Description
Boolean

CheckCapsule(float3, float3, Single, CollisionFilter, QueryInteraction)

Declaration
bool CheckCapsule(float3 point1, float3 point2, float radius, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)
Parameters
Type Name Description
float3 point1
float3 point2
Single radius
CollisionFilter filter
QueryInteraction queryInteraction
Returns
Type Description
Boolean

CheckSphere(float3, Single, CollisionFilter, QueryInteraction)

Declaration
bool CheckSphere(float3 position, float radius, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)
Parameters
Type Name Description
float3 position
Single radius
CollisionFilter filter
QueryInteraction queryInteraction
Returns
Type Description
Boolean

OverlapBox(float3, quaternion, float3, ref NativeList<DistanceHit>, CollisionFilter, QueryInteraction)

Declaration
bool OverlapBox(float3 center, quaternion orientation, float3 halfExtents, ref NativeList<DistanceHit> outHits, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)
Parameters
Type Name Description
float3 center
quaternion orientation
float3 halfExtents
NativeList<DistanceHit> outHits
CollisionFilter filter
QueryInteraction queryInteraction
Returns
Type Description
Boolean

OverlapBoxCustom<T>(float3, quaternion, float3, ref T, CollisionFilter, QueryInteraction)

Declaration
bool OverlapBoxCustom<T>(float3 center, quaternion orientation, float3 halfExtents, ref T collector, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)
    where T : struct, ICollector<DistanceHit>
Parameters
Type Name Description
float3 center
quaternion orientation
float3 halfExtents
T collector
CollisionFilter filter
QueryInteraction queryInteraction
Returns
Type Description
Boolean
Type Parameters
Name Description
T

OverlapCapsule(float3, float3, Single, ref NativeList<DistanceHit>, CollisionFilter, QueryInteraction)

Declaration
bool OverlapCapsule(float3 point1, float3 point2, float radius, ref NativeList<DistanceHit> outHits, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)
Parameters
Type Name Description
float3 point1
float3 point2
Single radius
NativeList<DistanceHit> outHits
CollisionFilter filter
QueryInteraction queryInteraction
Returns
Type Description
Boolean

OverlapCapsuleCustom<T>(float3, float3, Single, ref T, CollisionFilter, QueryInteraction)

Declaration
bool OverlapCapsuleCustom<T>(float3 point1, float3 point2, float radius, ref T collector, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)
    where T : struct, ICollector<DistanceHit>
Parameters
Type Name Description
float3 point1
float3 point2
Single radius
T collector
CollisionFilter filter
QueryInteraction queryInteraction
Returns
Type Description
Boolean
Type Parameters
Name Description
T

OverlapSphere(float3, Single, ref NativeList<DistanceHit>, CollisionFilter, QueryInteraction)

Declaration
bool OverlapSphere(float3 position, float radius, ref NativeList<DistanceHit> outHits, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)
Parameters
Type Name Description
float3 position
Single radius
NativeList<DistanceHit> outHits
CollisionFilter filter
QueryInteraction queryInteraction
Returns
Type Description
Boolean

OverlapSphereCustom<T>(float3, Single, ref T, CollisionFilter, QueryInteraction)

Declaration
bool OverlapSphereCustom<T>(float3 position, float radius, ref T collector, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)
    where T : struct, ICollector<DistanceHit>
Parameters
Type Name Description
float3 position
Single radius
T collector
CollisionFilter filter
QueryInteraction queryInteraction
Returns
Type Description
Boolean
Type Parameters
Name Description
T

SphereCast(float3, Single, float3, Single, out ColliderCastHit, CollisionFilter, QueryInteraction)

Declaration
bool SphereCast(float3 origin, float radius, float3 direction, float maxDistance, out ColliderCastHit hitInfo, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)
Parameters
Type Name Description
float3 origin
Single radius
float3 direction
Single maxDistance
ColliderCastHit hitInfo
CollisionFilter filter
QueryInteraction queryInteraction
Returns
Type Description
Boolean

SphereCast(float3, Single, float3, Single, CollisionFilter, QueryInteraction)

Declaration
bool SphereCast(float3 origin, float radius, float3 direction, float maxDistance, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)
Parameters
Type Name Description
float3 origin
Single radius
float3 direction
Single maxDistance
CollisionFilter filter
QueryInteraction queryInteraction
Returns
Type Description
Boolean

SphereCastAll(float3, Single, float3, Single, ref NativeList<ColliderCastHit>, CollisionFilter, QueryInteraction)

Declaration
bool SphereCastAll(float3 origin, float radius, float3 direction, float maxDistance, ref NativeList<ColliderCastHit> outHits, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)
Parameters
Type Name Description
float3 origin
Single radius
float3 direction
Single maxDistance
NativeList<ColliderCastHit> outHits
CollisionFilter filter
QueryInteraction queryInteraction
Returns
Type Description
Boolean

SphereCastCustom<T>(float3, Single, float3, Single, ref T, CollisionFilter, QueryInteraction)

Declaration
bool SphereCastCustom<T>(float3 origin, float radius, float3 direction, float maxDistance, ref T collector, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)
    where T : struct, ICollector<ColliderCastHit>
Parameters
Type Name Description
float3 origin
Single radius
float3 direction
Single maxDistance
T collector
CollisionFilter filter
QueryInteraction queryInteraction
Returns
Type Description
Boolean
Type Parameters
Name Description
T