Struct RigidBody

Namespace: Unity.Physics
Syntax
public struct RigidBody : ICollidable

Fields

Collider

Declaration
public BlobAssetReference<Collider> Collider
Field Value
Type Description
BlobAssetReference<Collider>

CustomTags

Declaration
public byte CustomTags
Field Value
Type Description
Byte

Entity

Declaration
public Entity Entity
Field Value
Type Description
Entity

WorldFromBody

Declaration
public RigidTransform WorldFromBody
Field Value
Type Description
RigidTransform

Zero

Declaration
public static readonly RigidBody Zero
Field Value
Type Description
RigidBody

Methods

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

Declaration
public 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
Implements

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

Declaration
public 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
Implements

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

Declaration
public 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
Implements

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

Declaration
public 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
Implements

CalculateAabb()

Declaration
public Aabb CalculateAabb()
Returns
Type Description
Aabb
Implements

CalculateAabb(RigidTransform)

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

CalculateDistance(ColliderDistanceInput)

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

CalculateDistance(ColliderDistanceInput, ref NativeList<DistanceHit>)

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

CalculateDistance(ColliderDistanceInput, out DistanceHit)

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

CalculateDistance(PointDistanceInput)

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

CalculateDistance(PointDistanceInput, ref NativeList<DistanceHit>)

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

CalculateDistance(PointDistanceInput, out DistanceHit)

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

CalculateDistance<T>(ColliderDistanceInput, ref T)

Declaration
public 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
Implements

CalculateDistance<T>(PointDistanceInput, ref T)

Declaration
public 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
Implements

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

Declaration
public 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
Implements

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

Declaration
public 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
Implements

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

Declaration
public 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
Implements

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

Declaration
public 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
Implements

CastCollider(ColliderCastInput)

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

CastCollider(ColliderCastInput, ref NativeList<ColliderCastHit>)

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

CastCollider(ColliderCastInput, out ColliderCastHit)

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

CastCollider<T>(ColliderCastInput, ref T)

Declaration
public 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
Implements

CastRay(RaycastInput)

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

CastRay(RaycastInput, ref NativeList<RaycastHit>)

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

CastRay(RaycastInput, out RaycastHit)

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

CastRay<T>(RaycastInput, ref T)

Declaration
public 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
Implements

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

Declaration
public 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
Implements

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

Declaration
public 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
Implements

CheckSphere(float3, Single, CollisionFilter, QueryInteraction)

Declaration
public 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
Implements

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

Declaration
public 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
Implements

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

Declaration
public 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
Implements

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

Declaration
public 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
Implements

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

Declaration
public 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
Implements

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

Declaration
public 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
Implements

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

Declaration
public 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
Implements

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

Declaration
public 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
Implements

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

Declaration
public 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
Implements

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

Declaration
public 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
Implements

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

Declaration
public 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
Implements