Struct SphereCollider
A collider in the shape of a sphere.
Inherited Members
Namespace: Unity.Physics
Assembly: Unity.Physics.dll
Syntax
public struct SphereCollider : ICollider, ICollidable
Properties
Center
Gets the center.
Declaration
public float3 Center { get; }
Property Value
| Type | Description |
|---|---|
| float3 | The center. |
CollisionType
Gets the Collision Type.
Declaration
public CollisionType CollisionType { get; }
Property Value
| Type | Description |
|---|---|
| CollisionType | Collision Type. |
Geometry
Gets or sets the geometry.
Declaration
public SphereGeometry Geometry { get; set; }
Property Value
| Type | Description |
|---|---|
| SphereGeometry | The geometry. |
MassProperties
Gets the mass properties.
Declaration
public MassProperties MassProperties { get; }
Property Value
| Type | Description |
|---|---|
| MassProperties | The mass properties. |
Material
Gets or sets the material.
Declaration
public Material Material { get; set; }
Property Value
| Type | Description |
|---|---|
| Material | The material. |
MemorySize
Gets the memory size.
Declaration
public int MemorySize { get; }
Property Value
| Type | Description |
|---|---|
| int | The size of the memory. |
Radius
Gets the radius.
Declaration
public float Radius { get; }
Property Value
| Type | Description |
|---|---|
| float | The radius. |
Type
Gets the collider type.
Declaration
public ColliderType Type { get; }
Property Value
| Type | Description |
|---|---|
| ColliderType | Collider Type. |
Methods
BakeTransform(AffineTransform)
Bakes the provided transformation into the sphere collider geometry.
Applies the transformation to the sphere collider in local space, consequently scaling, shearing, rotating and translating its geometry exactly or approximately depending on the provided transformation.
Declaration
public void BakeTransform(AffineTransform transform)
Parameters
| Type | Name | Description |
|---|---|---|
| AffineTransform | transform | The affine transformation to apply. |
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. |
CalculateAabb(RigidTransform, float)
Calculates the aabb.
Declaration
public Aabb CalculateAabb(RigidTransform transform, float uniformScale = 1)
Parameters
| Type | Name | Description |
|---|---|---|
| RigidTransform | transform | The transform. |
| float | uniformScale | (Optional) The uniform scale. |
Returns
| Type | Description |
|---|---|
| Aabb | The calculated aabb. |
CalculateDistance(ColliderDistanceInput)
Calculate the distance from another collider to this one.
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)
Calculate the distance from a point to this collider.
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>(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(ColliderCastInput)
Cast another collider against this one.
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>(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 a ray against this collider.
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 this collider.
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. |
Create(SphereGeometry)
Creates a new BlobAssetReference<Collider>
Declaration
public static BlobAssetReference<Collider> Create(SphereGeometry geometry)
Parameters
| Type | Name | Description |
|---|---|---|
| SphereGeometry | geometry | The geometry. |
Returns
| Type | Description |
|---|---|
| BlobAssetReference<Collider> | A BlobAssetReference<Collider> |
Create(SphereGeometry, CollisionFilter)
Creates a new BlobAssetReference<Collider>
Declaration
public static BlobAssetReference<Collider> Create(SphereGeometry geometry, CollisionFilter filter)
Parameters
| Type | Name | Description |
|---|---|---|
| SphereGeometry | geometry | The geometry. |
| CollisionFilter | filter | Specifies the filter. |
Returns
| Type | Description |
|---|---|
| BlobAssetReference<Collider> | A BlobAssetReference<Collider> |
Create(SphereGeometry, CollisionFilter, Material)
Creates a new BlobAssetReference<Collider>
Declaration
public static BlobAssetReference<Collider> Create(SphereGeometry geometry, CollisionFilter filter, Material material)
Parameters
| Type | Name | Description |
|---|---|---|
| SphereGeometry | geometry | The geometry. |
| CollisionFilter | filter | Specifies the filter. |
| Material | material | The material. |
Returns
| Type | Description |
|---|---|
| BlobAssetReference<Collider> | A BlobAssetReference<Collider> |
GetCollisionFilter()
Gets the collision filter.
Declaration
public CollisionFilter GetCollisionFilter()
Returns
| Type | Description |
|---|---|
| CollisionFilter | The collision filter. |
Initialize(SphereGeometry, CollisionFilter, Material)
Initializes the sphere collider, enables it to be created on stack.
Declaration
public void Initialize(SphereGeometry geometry, CollisionFilter filter, Material material)
Parameters
| Type | Name | Description |
|---|---|---|
| SphereGeometry | geometry | The geometry. |
| CollisionFilter | filter | Specifies the filter. |
| Material | material | The material. |
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. |
SetCollisionFilter(CollisionFilter)
Sets the collision filter.
Declaration
public void SetCollisionFilter(CollisionFilter filter)
Parameters
| Type | Name | Description |
|---|---|---|
| CollisionFilter | filter | Specifies the filter. |
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. |