KS.Reactor.ksSweepResult Struct Reference

Result of a sweep scene query. More...

Inheritance diagram for KS.Reactor.ksSweepResult:
KS.Reactor.ksIQueryHitResult

Properties

ksICollider QueryCollider [get, set]
 The collider used in the query. Null for shape queries. More...
 
ksIEntity Entity [get, set]
 Entity hit by the sweep. More...
 
ksICollider Collider [get, set]
 Collider hit by the sweep. More...
 
ksVector3 Point [get, set]
 summary>Normal of the surface where the sweep point is. More...
 
ksVector3 Normal [get, set]
 summary>Distance along the sweep when the intersection was detected. More...
 
float Distance [get, set]
 
bool IsValid [get]
 A sweep result is only valid if it includes an entity reference. More...
 
bool IsInitialOverlap [get]
 Is the entity/collider overlapping with the sweep origin? More...
 
- Properties inherited from KS.Reactor.ksIQueryHitResult
ksIEntity Entity [get, set]
 Entity hit by the query. More...
 
ksICollider Collider [get, set]
 Collider hit by the query. More...
 
ksVector3 Point [get, set]
 summary>Normal of the surface where the hit point is. More...
 
ksVector3 Normal [get, set]
 summary>Distance along the query when the intersection was detected. More...
 
float Distance [get, set]
 
bool IsValid [get]
 A hit result is only valid if it includes an entity reference. More...
 
bool IsInitialOverlap [get]
 Is the entity/collider overlapping with the query origin? More...
 

Detailed Description

Result of a sweep scene query.

Property Documentation

◆ Collider

ksICollider KS.Reactor.ksSweepResult.Collider
getset

Collider hit by the sweep.

summary>Point on the surface of the entity where the sweep instersected

◆ Entity

ksIEntity KS.Reactor.ksSweepResult.Entity
getset

Entity hit by the sweep.

◆ IsInitialOverlap

bool KS.Reactor.ksSweepResult.IsInitialOverlap
get

Is the entity/collider overlapping with the sweep origin?

◆ IsValid

bool KS.Reactor.ksSweepResult.IsValid
get

A sweep result is only valid if it includes an entity reference.

◆ Normal

ksVector3 KS.Reactor.ksSweepResult.Normal
getset

summary>Distance along the sweep when the intersection was detected.

◆ Point

ksVector3 KS.Reactor.ksSweepResult.Point
getset

summary>Normal of the surface where the sweep point is.

◆ QueryCollider

ksICollider KS.Reactor.ksSweepResult.QueryCollider
getset

The collider used in the query. Null for shape queries.