Struct RigidBody

An instance of a collider in a physics world.

Implements

ICollidable

IAspectQueryable

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Unity.Physics

Assembly: Unity.Physics.dll

Syntax

public struct RigidBody : ICollidable, IAspectQueryable

Fields

Collider

The rigid body's collider (allowed to be null)

Declaration

public BlobAssetReference<Collider> Collider

Field Value

Type	Description
BlobAssetReference<Collider>

CustomTags

Arbitrary custom tags. These get copied into contact manifolds and can be used to inform contact modifiers.

Declaration

public byte CustomTags

Field Value

Type	Description
byte

Entity

The entity that rigid body represents.

Declaration

public Entity Entity

Field Value

Type	Description
Entity

Scale

The rigid body's scale in world space.

Declaration

public float Scale

Field Value

Type	Description
float

WorldFromBody

The rigid body's transform in world space.

Declaration

public RigidTransform WorldFromBody

Field Value

Type	Description
RigidTransform

Zero

Rigid body that thas identity transform, null entity, and a null collider.

Declaration

public static readonly RigidBody Zero

Field Value

Type	Description
RigidBody

Methods

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

Box cast.

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	The center.
quaternion	orientation	The orientation.
float3	halfExtents	Half extents of the box.
float3	direction	The direction.
float	maxDistance	The maximum distance.
ColliderCastHit	hitInfo	[out] Information describing the hit.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

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

Box cast.

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	The center.
quaternion	orientation	The orientation.
float3	halfExtents	Half extents of the box.
float3	direction	The direction.
float	maxDistance	The maximum distance.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

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

Box cast all.

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	The center.
quaternion	orientation	The orientation.
float3	halfExtents	Half extents of the box.
float3	direction	The direction.
float	maxDistance	The maximum distance.
NativeList<ColliderCastHit>	outHits	[in,out] The out hits.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

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

Box cast custom.

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	The center.
quaternion	orientation	The orientation.
float3	halfExtents	Half extents of the box.
float3	direction	The direction.
float	maxDistance	The maximum distance.
T	collector	[in,out] The collector.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

Type Parameters

Name	Description
T	Generic type parameter.

CalculateAabb()

Calculates the aabb.

Declaration

public Aabb CalculateAabb()

Returns

Type	Description
Aabb	The calculated aabb.

CalculateDistance(in ColliderAspect, float, ref NativeList<DistanceHit>, QueryInteraction)

Calculates the distance from the input aspect.

Declaration

public bool CalculateDistance(in ColliderAspect colliderAspect, float maxDistance, ref NativeList<DistanceHit> allHits, QueryInteraction queryInteraction = QueryInteraction.Default)

Parameters

Type	Name	Description
ColliderAspect	colliderAspect	The collider aspect.
float	maxDistance	The maximum distance.
NativeList<DistanceHit>	allHits	[in,out] all hits.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

CalculateDistance(in ColliderAspect, float, out DistanceHit, QueryInteraction)

Calculates the distance from the input aspect.

Declaration

public bool CalculateDistance(in ColliderAspect colliderAspect, float maxDistance, out DistanceHit closestHit, QueryInteraction queryInteraction = QueryInteraction.Default)

Parameters

Type	Name	Description
ColliderAspect	colliderAspect	The collider aspect.
float	maxDistance	The maximum distance.
DistanceHit	closestHit	[out] The closest hit.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

CalculateDistance(in ColliderAspect, float, QueryInteraction)

Calculates the distance from the input aspect.

Declaration

public bool CalculateDistance(in ColliderAspect colliderAspect, float maxDistance, QueryInteraction queryInteraction = QueryInteraction.Default)

Parameters

Type	Name	Description
ColliderAspect	colliderAspect	The collider aspect.
float	maxDistance	The maximum distance.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

CalculateDistance(ColliderDistanceInput)

Calculates the distance.

Declaration

public bool CalculateDistance(ColliderDistanceInput input)

Parameters

Type	Name	Description
ColliderDistanceInput	input	The input.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

CalculateDistance(ColliderDistanceInput, ref NativeList<DistanceHit>)

Calculates the distance.

Declaration

public bool CalculateDistance(ColliderDistanceInput input, ref NativeList<DistanceHit> allHits)

Parameters

Type	Name	Description
ColliderDistanceInput	input	The input.
NativeList<DistanceHit>	allHits	[in,out] all hits.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

CalculateDistance(ColliderDistanceInput, out DistanceHit)

Calculates the distance.

Declaration

public bool CalculateDistance(ColliderDistanceInput input, out DistanceHit closestHit)

Parameters

Type	Name	Description
ColliderDistanceInput	input	The input.
DistanceHit	closestHit	[out] The closest hit.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

CalculateDistance(PointDistanceInput)

Calculates the distance.

Declaration

public bool CalculateDistance(PointDistanceInput input)

Parameters

Type	Name	Description
PointDistanceInput	input	The input.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

CalculateDistance(PointDistanceInput, ref NativeList<DistanceHit>)

Calculates the distance.

Declaration

public bool CalculateDistance(PointDistanceInput input, ref NativeList<DistanceHit> allHits)

Parameters

Type	Name	Description
PointDistanceInput	input	The input.
NativeList<DistanceHit>	allHits	[in,out] all hits.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

CalculateDistance(PointDistanceInput, out DistanceHit)

Calculates the distance.

Declaration

public bool CalculateDistance(PointDistanceInput input, out DistanceHit closestHit)

Parameters

Type	Name	Description
PointDistanceInput	input	The input.
DistanceHit	closestHit	[out] The closest hit.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

CalculateDistance<T>(in ColliderAspect, float, ref T, QueryInteraction)

Calculates the distance from the input aspect.

Declaration

public bool CalculateDistance<T>(in ColliderAspect colliderAspect, float maxDistance, ref T collector, QueryInteraction queryInteraction = QueryInteraction.Default) where T : struct, ICollector<DistanceHit>

Parameters

Type	Name	Description
ColliderAspect	colliderAspect	The collider aspect.
float	maxDistance	The maximum distance.
T	collector	[in,out] The collector.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

Type Parameters

Name	Description
T	Generic type parameter.

CalculateDistance<T>(ColliderDistanceInput, ref T)

Calculates the distance.

Declaration

public bool CalculateDistance<T>(ColliderDistanceInput input, ref T collector) where T : struct, ICollector<DistanceHit>

Parameters

Type	Name	Description
ColliderDistanceInput	input	The input.
T	collector	[in,out] The collector.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

Type Parameters

Name	Description
T	Generic type parameter.

CalculateDistance<T>(PointDistanceInput, ref T)

Calculates the distance.

Declaration

public bool CalculateDistance<T>(PointDistanceInput input, ref T collector) where T : struct, ICollector<DistanceHit>

Parameters

Type	Name	Description
PointDistanceInput	input	The input.
T	collector	[in,out] The collector.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

Type Parameters

Name	Description
T	Generic type parameter.

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

Capsule cast.

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	The first point in capsule definition.
float3	point2	The second point in capsule definition.
float	radius	The radius.
float3	direction	The direction.
float	maxDistance	The maximum distance.
ColliderCastHit	hitInfo	[out] Information describing the hit.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

CapsuleCast(float3, float3, float, float3, float, CollisionFilter, QueryInteraction)

Capsule cast.

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	The first point in capsule definition.
float3	point2	The second point in capsule definition.
float	radius	The radius.
float3	direction	The direction.
float	maxDistance	The maximum distance.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

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

Capsule cast all.

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	The first point in capsule definition.
float3	point2	The second point in capsule definition.
float	radius	The radius.
float3	direction	The direction.
float	maxDistance	The maximum distance.
NativeList<ColliderCastHit>	outHits	[in,out] The out hits.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

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

Capsule cast custom.

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	The first point in capsule definition.
float3	point2	The second point in capsule definition.
float	radius	The radius.
float3	direction	The direction.
float	maxDistance	The maximum distance.
T	collector	[in,out] The collector.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

Type Parameters

Name	Description
T	Generic type parameter.

CastCollider(in ColliderAspect, float3, float, ref NativeList<ColliderCastHit>, QueryInteraction)

Cast another collider aspect against this RigidBody.

Declaration

public bool CastCollider(in ColliderAspect colliderAspect, float3 direction, float maxDistance, ref NativeList<ColliderCastHit> allHits, QueryInteraction queryInteraction = QueryInteraction.Default)

Parameters

Type	Name	Description
ColliderAspect	colliderAspect	The collider aspect.
float3	direction	The direction of the input aspect.
float	maxDistance	The maximum distance.
NativeList<ColliderCastHit>	allHits	[in,out] all hits.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

CastCollider(in ColliderAspect, float3, float, out ColliderCastHit, QueryInteraction)

Cast another collider aspect against this RigidBody.

Declaration

public bool CastCollider(in ColliderAspect colliderAspect, float3 direction, float maxDistance, out ColliderCastHit closestHit, QueryInteraction queryInteraction = QueryInteraction.Default)

Parameters

Type	Name	Description
ColliderAspect	colliderAspect	The collider aspect.
float3	direction	The direction of the input aspect.
float	maxDistance	The maximum distance.
ColliderCastHit	closestHit	[out] The closest hit.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

CastCollider(in ColliderAspect, float3, float, QueryInteraction)

Cast another collider aspect against this RigidBody.

Declaration

public bool CastCollider(in ColliderAspect colliderAspect, float3 direction, float maxDistance, QueryInteraction queryInteraction = QueryInteraction.Default)

Parameters

Type	Name	Description
ColliderAspect	colliderAspect	The collider aspect.
float3	direction	The direction of the input aspect.
float	maxDistance	The maximum distance.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

CastCollider(ColliderCastInput)

Cast collider.

Declaration

public bool CastCollider(ColliderCastInput input)

Parameters

Type	Name	Description
ColliderCastInput	input	The input.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

CastCollider(ColliderCastInput, ref NativeList<ColliderCastHit>)

Cast collider.

Declaration

public bool CastCollider(ColliderCastInput input, ref NativeList<ColliderCastHit> allHits)

Parameters

Type	Name	Description
ColliderCastInput	input	The input.
NativeList<ColliderCastHit>	allHits	[in,out] all hits.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

CastCollider(ColliderCastInput, out ColliderCastHit)

Cast collider.

Declaration

public bool CastCollider(ColliderCastInput input, out ColliderCastHit closestHit)

Parameters

Type	Name	Description
ColliderCastInput	input	The input.
ColliderCastHit	closestHit	[out] The closest hit.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

CastCollider<T>(in ColliderAspect, float3, float, ref T, QueryInteraction)

Cast another collider aspect against this one.

Declaration

public bool CastCollider<T>(in ColliderAspect colliderAspect, float3 direction, float maxDistance, ref T collector, QueryInteraction queryInteraction = QueryInteraction.Default) where T : struct, ICollector<ColliderCastHit>

Parameters

Type	Name	Description
ColliderAspect	colliderAspect	The collider aspect.
float3	direction	The direction of the input aspect.
float	maxDistance	The maximum distance.
T	collector	[in,out] The collector.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

Type Parameters

Name	Description
T	Generic type parameter.

CastCollider<T>(ColliderCastInput, ref T)

Cast collider.

Declaration

public bool CastCollider<T>(ColliderCastInput input, ref T collector) where T : struct, ICollector<ColliderCastHit>

Parameters

Type	Name	Description
ColliderCastInput	input	The input.
T	collector	[in,out] The collector.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

Type Parameters

Name	Description
T	Generic type parameter.

CastRay(RaycastInput)

Cast ray.

Declaration

public bool CastRay(RaycastInput input)

Parameters

Type	Name	Description
RaycastInput	input	The input.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

CastRay(RaycastInput, ref NativeList<RaycastHit>)

Cast ray.

Declaration

public bool CastRay(RaycastInput input, ref NativeList<RaycastHit> allHits)

Parameters

Type	Name	Description
RaycastInput	input	The input.
NativeList<RaycastHit>	allHits	[in,out] all hits.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

CastRay(RaycastInput, out RaycastHit)

Cast ray.

Declaration

public bool CastRay(RaycastInput input, out RaycastHit closestHit)

Parameters

Type	Name	Description
RaycastInput	input	The input.
RaycastHit	closestHit	[out] The closest hit.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

CastRay<T>(RaycastInput, ref T)

Cast ray.

Declaration

public bool CastRay<T>(RaycastInput input, ref T collector) where T : struct, ICollector<RaycastHit>

Parameters

Type	Name	Description
RaycastInput	input	The input.
T	collector	[in,out] The collector.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

Type Parameters

Name	Description
T	Generic type parameter.

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

Check box.

Declaration

public bool CheckBox(float3 center, quaternion orientation, float3 halfExtents, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)

Parameters

Type	Name	Description
float3	center	The center.
quaternion	orientation	The orientation.
float3	halfExtents	Half extents of the box.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

CheckCapsule(float3, float3, float, CollisionFilter, QueryInteraction)

Check capsule.

Declaration

public bool CheckCapsule(float3 point1, float3 point2, float radius, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)

Parameters

Type	Name	Description
float3	point1	The first point in capsule definition.
float3	point2	The second point in capsule definition.
float	radius	The radius.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

CheckSphere(float3, float, CollisionFilter, QueryInteraction)

Checks if a sphere overlaps with this body.

Declaration

public bool CheckSphere(float3 position, float radius, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)

Parameters

Type	Name	Description
float3	position	The position.
float	radius	The radius.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

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

Overlap box.

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	The center.
quaternion	orientation	The orientation.
float3	halfExtents	Half extents of the box.
NativeList<DistanceHit>	outHits	[in,out] The out hits.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

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

Overlap box custom.

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	The center.
quaternion	orientation	The orientation.
float3	halfExtents	Half extents of the box.
T	collector	[in,out] The collector.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

Type Parameters

Name	Description
T	Generic type parameter.

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

Overlap capsule.

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	The first point in capsule definition.
float3	point2	The second point in capsule definition.
float	radius	The radius.
NativeList<DistanceHit>	outHits	[in,out] The out hits.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

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

Overlap capsule custom.

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	The first point in capsule definition.
float3	point2	The second point in capsule definition.
float	radius	The radius.
T	collector	[in,out] The collector.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

Type Parameters

Name	Description
T	Generic type parameter.

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

Overlap sphere.

Declaration

public bool OverlapSphere(float3 position, float radius, ref NativeList<DistanceHit> outHits, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)

Parameters

Type	Name	Description
float3	position	The position.
float	radius	The radius.
NativeList<DistanceHit>	outHits	[in,out] The out hits.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

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

Overlap sphere custom.

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	The position.
float	radius	The radius.
T	collector	[in,out] The collector.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

Type Parameters

Name	Description
T	Generic type parameter.

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

Sphere cast.

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	The origin.
float	radius	The radius.
float3	direction	The direction.
float	maxDistance	The maximum distance.
ColliderCastHit	hitInfo	[out] Information describing the hit.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

SphereCast(float3, float, float3, float, CollisionFilter, QueryInteraction)

Sphere cast.

Declaration

public bool SphereCast(float3 origin, float radius, float3 direction, float maxDistance, CollisionFilter filter, QueryInteraction queryInteraction = QueryInteraction.Default)

Parameters

Type	Name	Description
float3	origin	The origin.
float	radius	The radius.
float3	direction	The direction.
float	maxDistance	The maximum distance.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

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

Sphere cast all.

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	The origin.
float	radius	The radius.
float3	direction	The direction.
float	maxDistance	The maximum distance.
NativeList<ColliderCastHit>	outHits	[in,out] The out hits.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

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

Sphere cast custom.

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	The origin.
float	radius	The radius.
float3	direction	The direction.
float	maxDistance	The maximum distance.
T	collector	[in,out] The collector.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

Type	Description
bool	True if there is a hit, false otherwise.

Type Parameters

Name	Description
T	Generic type parameter.

Implements

ICollidable

IAspectQueryable