Struct DistanceHit

A hit from a distance query.

Implements

IQueryResult

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

Fields

QueryColliderKey

Collider key of the query collider. 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.

Declaration

public ColliderKey QueryColliderKey

Field Value

Type	Description
ColliderKey

Properties

ColliderKey

Gets or sets the collider key.

Declaration

public ColliderKey ColliderKey { readonly get; set; }

Property Value

Type	Description
ColliderKey	Returns ColliderKey of queried leaf collider.

Distance

Gets the distance.

Declaration

public float Distance { get; }

Property Value

Type	Description
float	Distance at which the hit occurred.

Entity

Gets or sets the entity.

Declaration

public Entity Entity { readonly get; set; }

Property Value

Type	Description
Entity	Returns Entity of queried body.

Fraction

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

Declaration

public float Fraction { readonly get; set; }

Property Value

Type	Description
float	Distance at which the hit occurred.

Material

Gets or sets the material.

Declaration

public Material Material { readonly get; set; }

Property Value

Type	Description
Material	Returns Material of queried leaf collider.

Position

The point in query space where the hit occurred.

Declaration

public float3 Position { readonly 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 { readonly get; set; }

Property Value

Type	Description
int	Returns RigidBodyIndex of queried body.

SurfaceNormal

Gets or sets the surface normal.

Declaration

public float3 SurfaceNormal { readonly get; set; }

Property Value

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

Implements

IQueryResult