Struct DistanceHit

A hit from a distance query.

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 DistanceHit : IQueryResult

Fields

QueryColliderKey

Collider key of the query collider.

Declaration

public ColliderKey QueryColliderKey

Field Value

Type	Description
ColliderKey	If the query input uses composite collider, this field will have the collider key of it's leaf which participated in the hit, otherwise the value will be undefined.

Properties

ColliderKey

Gets or sets the collider key.

Declaration

public ColliderKey ColliderKey { get; set; }

Property Value

Type	Description
ColliderKey	Returns ColliderKey of queried leaf collider.

Implements

IQueryResult.ColliderKey

Distance

Gets the distance.

Declaration

public readonly float Distance { get; }

Property Value

Type	Description
Single	Distance at which the hit occurred.

Entity

Gets or sets the entity.

Declaration

public Entity Entity { get; set; }

Property Value

Type	Description
Entity	Returns Entity of queried body.

Implements

IQueryResult.Entity

Fraction

Fraction in distance queries represents the actual distance where the hit occurred, NOT the percentage of max distance.

Declaration

public float Fraction { get; set; }

Property Value

Type	Description
Single	Distance at which the hit occurred.

Implements

IQueryResult.Fraction

Material

Gets or sets the material.

Declaration

public Material Material { get; set; }

Property Value

Type	Description
Material	Returns Material of queried leaf collider.

Implements

IQueryResult.Material

Position

The point in query space where the hit occurred.

Declaration

public float3 Position { get; set; }

Property Value

Type	Description
float3	Returns the position of the point where the hit occurred.

RigidBodyIndex

Gets or sets the zero-based index of the rigid body.

Declaration

public int RigidBodyIndex { get; set; }

Property Value

Type	Description
Int32	Returns RigidBodyIndex of queried body.

Implements

IQueryResult.RigidBodyIndex

SurfaceNormal

Gets or sets the surface normal.

Declaration

public float3 SurfaceNormal { get; set; }

Property Value

Type	Description
float3	Returns the normal of the point where the hit occurred.