Quantum.Physics3D.Hit3D Struct Reference

Information returned from a valid hit of a physics query. More...

Public Member Functions
ref MapStaticCollider3D	GetStaticCollider (FrameBase f)
	Gets a reference to the static collider hit. Does not perform additional safety checks. More...
ref StaticColliderData	GetStaticData (FrameBase f)
	Gets a reference to the data of the static collider hit (MapStaticCollider3D.StaticData). Does not perform additional safety checks. More...
void	SetHitEntity (EntityRef entity)
	Sets the entity that was hit. Automatically resets StaticColliderIndex to -1. More...
void	SetHitStaticCollider (int staticColliderIndex, AssetRefMap mapRef)
	Sets the index of the static collider hit on the Map.StaticColliders3D array of the referenced map. More...
bool	TryGetStaticCollider (FrameBase f, out MapStaticCollider3D collider)
	Tries to access the static collider that was hit. More...
bool	TryGetStaticData (FrameBase f, out StaticColliderData data)
	Tries to access the data of the static collider that was hit (MapStaticCollider3D.StaticData). More...

Public Attributes
FP	CastDistanceNormalized
	A normalized value (0 to 1) of the feature being casted when the hit occurs, relative to its full cast distance. More...
FPVector3	Normal
	The surface normal of the hit. More...
FP	OverlapPenetration
	The penetration of a shape overlap query on the collider that was hit. More...
FPVector3	Point
	The point in world space where the collider is hit by the query. More...
ushort	ShapeUserTag
	The Shape3D.UserTag field of the shape hit by the query. More...

Properties
EntityRef?	Entity [get]
	The reference of the entity hit by the query, EntityRef.None if hitting a static collider (IsDynamic false). More...
Boolean	IsDynamic [get]
	If the collider hit by the query is not static, i.e. it belongs to an Entity. More...
Boolean?	IsTrigger [get, set]
	If the collider hit by the query is Trigger. More...
int	StaticColliderIndex [get]
	0-based index of the static collider on the Map.StaticColliders3D array of the map referenced by StaticColliderMapRef. If the hit IsDynamic, this value is -1. Tip: use TryGetStaticCollider(FrameBase, out MapStaticCollider3D), TryGetStaticData(FrameBase, out StaticColliderData), GetStaticCollider(FrameBase) or GetStaticData(FrameBase) in order to safely and conveniently access info about a static collider hit. More...
AssetRefMap	StaticColliderMapRef [get]
	The reference to the map used by the physics engine when a static collider is hit. Otherwise, this value is default (hit IsDynamic). More...

Detailed Description

Information returned from a valid hit of a physics query.

Member Function Documentation

SetHitEntity()

void Quantum.Physics3D.Hit3D.SetHitEntity ( EntityRef  entity )

inline

Sets the entity that was hit. Automatically resets StaticColliderIndex to -1.

Parameters

entity

The entity reference.

SetHitStaticCollider()

void Quantum.Physics3D.Hit3D.SetHitStaticCollider ( int  staticColliderIndex, AssetRefMap  mapRef  )

inline

Sets the index of the static collider hit on the Map.StaticColliders3D array of the referenced map.

Parameters

staticColliderIndex	A valid index of the static collider on the array of the map.
mapRef	A reference to the map where the static collider hit is located.

TryGetStaticCollider()

bool Quantum.Physics3D.Hit3D.TryGetStaticCollider ( FrameBase  f, out MapStaticCollider3D  collider  )

inline

Tries to access the static collider that was hit.

Parameters

f	Current frame.
collider	A copy of the static collider data found. Default if the metadata is not valid (returns false).

Returns

False if the collider hit is not static or the collide index or referenced map are not valid. True otherwise.

TryGetStaticData()

bool Quantum.Physics3D.Hit3D.TryGetStaticData ( FrameBase  f, out StaticColliderData  data  )

inline

Tries to access the data of the static collider that was hit (MapStaticCollider3D.StaticData).

Parameters

f	Current frame.
data	A copy of the static collider data found. Default if the metadata is not valid (returns false).

Returns

False if the collider hit is not static or the collide index or referenced map are not valid. True otherwise.

GetStaticCollider()

ref MapStaticCollider3D Quantum.Physics3D.Hit3D.GetStaticCollider ( FrameBase  f )

inline

Gets a reference to the static collider hit. Does not perform additional safety checks.

Parameters

f	Current frame.

Exceptions

NullReferenceException	If the StaticColliderMapRef does not reference a valid asset.
IndexOutOfRangeException	If the hit is not static (IsDynamic) or the collider index is not valid for the array of static colliders on the referenced map.

Returns

A reference to the static collider hit.

GetStaticData()

ref StaticColliderData Quantum.Physics3D.Hit3D.GetStaticData ( FrameBase  f )

inline

Gets a reference to the data of the static collider hit (MapStaticCollider3D.StaticData). Does not perform additional safety checks.

Parameters

f	Current frame.

Exceptions

NullReferenceException	If the StaticColliderMapRef does not reference a valid asset.
IndexOutOfRangeException	If the hit is not static (IsDynamic) or the collider index is not valid for the array of static colliders on the referenced map.

Returns

A reference to the static collider hit.

Member Data Documentation

ShapeUserTag

ushort Quantum.Physics3D.Hit3D.ShapeUserTag

The Shape3D.UserTag field of the shape hit by the query.

OverlapPenetration

FP Quantum.Physics3D.Hit3D.OverlapPenetration

The penetration of a shape overlap query on the collider that was hit.

This field is not computed unless QueryOptions.ComputeDetailedInfo is used in the query options and only applies to Shape Overlap queries. It overlaps in memory and is mutually exclusive with CastDistanceNormalized.

CastDistanceNormalized

FP Quantum.Physics3D.Hit3D.CastDistanceNormalized

A normalized value (0 to 1) of the feature being casted when the hit occurs, relative to its full cast distance.

This field only applies to Ray, Line or Shape casts. It overlaps in memory and is mutually exclusive with OverlapPenetration.

Point

FPVector3 Quantum.Physics3D.Hit3D.Point

The point in world space where the collider is hit by the query.

Normal

FPVector3 Quantum.Physics3D.Hit3D.Normal

The surface normal of the hit.

This field is not computed unless QueryOptions.ComputeDetailedInfo is used in the query options.

Property Documentation

IsDynamic

Boolean Quantum.Physics3D.Hit3D.IsDynamic

get

If the collider hit by the query is not static, i.e. it belongs to an Entity.

StaticColliderIndex

int Quantum.Physics3D.Hit3D.StaticColliderIndex

get

0-based index of the static collider on the Map.StaticColliders3D array of the map referenced by StaticColliderMapRef. If the hit IsDynamic, this value is -1. Tip: use TryGetStaticCollider(FrameBase, out MapStaticCollider3D), TryGetStaticData(FrameBase, out StaticColliderData), GetStaticCollider(FrameBase) or GetStaticData(FrameBase) in order to safely and conveniently access info about a static collider hit.

StaticColliderMapRef

AssetRefMap Quantum.Physics3D.Hit3D.StaticColliderMapRef

get

The reference to the map used by the physics engine when a static collider is hit. Otherwise, this value is default (hit IsDynamic).

IsTrigger

Boolean? Quantum.Physics3D.Hit3D.IsTrigger

getset

If the collider hit by the query is Trigger.

Entity

EntityRef? Quantum.Physics3D.Hit3D.Entity

get

The reference of the entity hit by the query, EntityRef.None if hitting a static collider (IsDynamic false).