Struct TerrainCollider

A collider representing a terrain described by a uniform grid of height samples. Warning: This is just the header, it is followed by variable sized data in memory. Therefore this struct must always be passed by reference, never by value.

Inherited Members

ValueType.Equals(Object)

ValueType.GetHashCode()

ValueType.ToString()

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Namespace: Unity.Physics

Syntax

public struct TerrainCollider : ICompositeCollider, ICollider, ICollidable

Fields

Material

The material.

Declaration

public Material Material

Field Value

Type	Description
Material

Properties

CollisionType

Gets the collision type

Declaration

public readonly CollisionType CollisionType { get; }

Property Value

Type	Description
CollisionType	Collision type.

Implements

ICollider.CollisionType

MassProperties

Gets the mass properties.

Declaration

public readonly MassProperties MassProperties { get; }

Property Value

Type	Description
MassProperties	The mass properties.

Implements

ICollider.MassProperties

MemorySize

Gets the memory size.

Declaration

public int MemorySize { readonly get; }

Property Value

Type	Description
Int32	The size of the memory.

Implements

ICollider.MemorySize

NumColliderKeyBits

Gets the number of collider key bits.

Declaration

public readonly uint NumColliderKeyBits { get; }

Property Value

Type	Description
UInt32	The total number of collider key bits.

Type

Gets the Collider Type.

Declaration

public readonly ColliderType Type { get; }

Property Value

Type	Description
ColliderType	Collider Type.

Implements

ICollider.Type

Methods

BoxCast(float3, quaternion, float3, float3, Single, 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.
Single	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
Boolean	True if there is a hit, false otherwise.

Implements

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

BoxCast(float3, quaternion, float3, float3, Single, 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.
Single	maxDistance	The maximum distance.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

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

Implements

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

BoxCastAll(float3, quaternion, float3, float3, Single, 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.
Single	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
Boolean	True if there is a hit, false otherwise.

Implements

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

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

Returns

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

Type Parameters

Name	Description
T	Generic type parameter.

Implements

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

CalculateAabb()

Calculates the aabb.

Declaration

public Aabb CalculateAabb()

Returns

Type	Description
Aabb	The calculated aabb.

Implements

ICollidable.CalculateAabb()

CalculateAabb(RigidTransform, Single)

Calculates the aabb.

Declaration

public Aabb CalculateAabb(RigidTransform transform, float uniformScale = 1F)

Parameters

Type	Name	Description
RigidTransform	transform	The transform.
Single	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
Boolean	True if there is a hit, false otherwise.

Implements

ICollidable.CalculateDistance(ColliderDistanceInput)

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
Boolean	True if there is a hit, false otherwise.

Implements

ICollidable.CalculateDistance(ColliderDistanceInput, ref NativeList<DistanceHit>)

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
Boolean	True if there is a hit, false otherwise.

Implements

ICollidable.CalculateDistance(ColliderDistanceInput, out DistanceHit)

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
Boolean	True if there is a hit, false otherwise.

Implements

ICollidable.CalculateDistance(PointDistanceInput)

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
Boolean	True if there is a hit, false otherwise.

Implements

ICollidable.CalculateDistance(PointDistanceInput, ref NativeList<DistanceHit>)

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
Boolean	True if there is a hit, false otherwise.

Implements

ICollidable.CalculateDistance(PointDistanceInput, out DistanceHit)

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
Boolean	True if there is a hit, false otherwise.

Type Parameters

Name	Description
T	Generic type parameter.

Implements

ICollidable.CalculateDistance<T>(ColliderDistanceInput, ref T)

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
Boolean	True if there is a hit, false otherwise.

Type Parameters

Name	Description
T	Generic type parameter.

Implements

ICollidable.CalculateDistance<T>(PointDistanceInput, ref T)

CapsuleCast(float3, float3, Single, float3, Single, 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.
Single	radius	The radius.
float3	direction	The direction.
Single	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
Boolean	True if there is a hit, false otherwise.

Implements

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

CapsuleCast(float3, float3, Single, float3, Single, 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.
Single	radius	The radius.
float3	direction	The direction.
Single	maxDistance	The maximum distance.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

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

Implements

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

CapsuleCastAll(float3, float3, Single, float3, Single, 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.
Single	radius	The radius.
float3	direction	The direction.
Single	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
Boolean	True if there is a hit, false otherwise.

Implements

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

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

Returns

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

Type Parameters

Name	Description
T	Generic type parameter.

Implements

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

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
Boolean	True if there is a hit, false otherwise.

Implements

ICollidable.CastCollider(ColliderCastInput)

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
Boolean	True if there is a hit, false otherwise.

Implements

ICollidable.CastCollider(ColliderCastInput, ref NativeList<ColliderCastHit>)

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
Boolean	True if there is a hit, false otherwise.

Implements

ICollidable.CastCollider(ColliderCastInput, out ColliderCastHit)

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
Boolean	True if there is a hit, false otherwise.

Type Parameters

Name	Description
T	Generic type parameter.

Implements

ICollidable.CastCollider<T>(ColliderCastInput, ref T)

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
Boolean	True if there is a hit, false otherwise.

Implements

ICollidable.CastRay(RaycastInput)

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
Boolean	True if there is a hit, false otherwise.

Implements

ICollidable.CastRay(RaycastInput, ref NativeList<RaycastHit>)

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
Boolean	True if there is a hit, false otherwise.

Implements

ICollidable.CastRay(RaycastInput, out RaycastHit)

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
Boolean	True if there is a hit, false otherwise.

Type Parameters

Name	Description
T	Generic type parameter.

Implements

ICollidable.CastRay<T>(RaycastInput, ref T)

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
Boolean	True if there is a hit, false otherwise.

Implements

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

CheckCapsule(float3, float3, Single, 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.
Single	radius	The radius.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

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

Implements

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

CheckSphere(float3, Single, 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.
Single	radius	The radius.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

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

Implements

ICollidable.CheckSphere(float3, Single, CollisionFilter, QueryInteraction)

Create(NativeArray<Single>, int2, float3, TerrainCollider.CollisionMethod)

Create a terrain collider from a grid of heights.

Declaration

public static BlobAssetReference<Collider> Create(NativeArray<float> heights, int2 size, float3 scale, TerrainCollider.CollisionMethod collisionMethod)

Parameters

Type	Name	Description
NativeArray<Single>	heights	The heights.
int2	size	The size.
float3	scale	The scale.
TerrainCollider.CollisionMethod	collisionMethod	The collision method.

Returns

Type	Description
BlobAssetReference<Collider>	A BlobAssetReference<Collider>

Create(NativeArray<Single>, int2, float3, TerrainCollider.CollisionMethod, CollisionFilter)

Creates a new BlobAssetReference<Collider>

Declaration

public static BlobAssetReference<Collider> Create(NativeArray<float> heights, int2 size, float3 scale, TerrainCollider.CollisionMethod collisionMethod, CollisionFilter filter)

Parameters

Type	Name	Description
NativeArray<Single>	heights	The heights.
int2	size	The size.
float3	scale	The scale.
TerrainCollider.CollisionMethod	collisionMethod	The collision method.
CollisionFilter	filter	Specifies the filter.

Returns

Type	Description
BlobAssetReference<Collider>	A BlobAssetReference<Collider>

Create(NativeArray<Single>, int2, float3, TerrainCollider.CollisionMethod, CollisionFilter, Material)

Creates a new BlobAssetReference<Collider>

Declaration

public static BlobAssetReference<Collider> Create(NativeArray<float> heights, int2 size, float3 scale, TerrainCollider.CollisionMethod collisionMethod, CollisionFilter filter, Material material)

Parameters

Type	Name	Description
NativeArray<Single>	heights	The heights.
int2	size	The size.
float3	scale	The scale.
TerrainCollider.CollisionMethod	collisionMethod	The collision method.
CollisionFilter	filter	Specifies the filter.
Material	material	The material.

Returns

Type	Description
BlobAssetReference<Collider>	A BlobAssetReference<Collider>

GetChild(ref ColliderKey, out ChildCollider)

Gets a child of this collider.

Declaration

public bool GetChild(ref ColliderKey key, out ChildCollider child)

Parameters

Type	Name	Description
ColliderKey	key	[in,out] The key that identifies the child. Gets modified by removing the bits associated with the child collider.
ChildCollider	child	[out] The child.

Returns

Type	Description
Boolean	True if there is a child with the specified key, false otherwise.

GetCollisionFilter()

Gets the collision filter.

Declaration

public CollisionFilter GetCollisionFilter()

Returns

Type	Description
CollisionFilter	The collision filter.

Implements

ICollider.GetCollisionFilter()

GetLeaf(ColliderKey, out ChildCollider)

Gets a leaf collider.

Declaration

public bool GetLeaf(ColliderKey key, out ChildCollider leaf)

Parameters

Type	Name	Description
ColliderKey	key	The key representing the leaf collider.
ChildCollider	leaf	[out] The leaf.

Returns

Type	Description
Boolean	True if a leaf with the specified key exists, otherwise false.

GetLeaves<T>(ref T)

Gets the leaf colliders of this collider .

Declaration

public void GetLeaves<T>([NoAlias] ref T collector)
    where T : struct, ILeafColliderCollector

Parameters

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

Type Parameters

Name	Description
T	Generic type parameter.

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
Boolean	True if there is a hit, false otherwise.

Implements

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

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
Boolean	True if there is a hit, false otherwise.

Type Parameters

Name	Description
T	Generic type parameter.

Implements

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

OverlapCapsule(float3, float3, Single, 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.
Single	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
Boolean	True if there is a hit, false otherwise.

Implements

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

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

Returns

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

Type Parameters

Name	Description
T	Generic type parameter.

Implements

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

OverlapSphere(float3, Single, 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.
Single	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
Boolean	True if there is a hit, false otherwise.

Implements

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

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

Returns

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

Type Parameters

Name	Description
T	Generic type parameter.

Implements

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

SetCollisionFilter(CollisionFilter)

Sets the collision filter.

Declaration

public void SetCollisionFilter(CollisionFilter filter)

Parameters

Type	Name	Description
CollisionFilter	filter	Specifies the filter.

Implements

ICollider.SetCollisionFilter(CollisionFilter)

SphereCast(float3, Single, float3, Single, 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.
Single	radius	The radius.
float3	direction	The direction.
Single	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
Boolean	True if there is a hit, false otherwise.

Implements

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

SphereCast(float3, Single, float3, Single, 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.
Single	radius	The radius.
float3	direction	The direction.
Single	maxDistance	The maximum distance.
CollisionFilter	filter	Specifies the filter.
QueryInteraction	queryInteraction	(Optional) The query interaction.

Returns

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

Implements

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

SphereCastAll(float3, Single, float3, Single, 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.
Single	radius	The radius.
float3	direction	The direction.
Single	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
Boolean	True if there is a hit, false otherwise.

Implements

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

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

Returns

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

Type Parameters

Name	Description
T	Generic type parameter.

Implements

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