KS.Reactor.ksSweepParams Class Reference
Inheritance diagram for KS.Reactor.ksSweepParams:
KS.Reactor.ksOverlapParams KS.Reactor.ksBaseQueryParams KS.Reactor.ksSweepSlideParams

Public Member Functions

 ksSweepParams ()
 Default constructor More...
 
 ksSweepParams (ksShape shape, ksVector3 origin, ksQuaternion rotation, ksVector3 direction, float distance, ksIQueryFilter filter=null, ksIEntity excludeEntity=null, ksQueryFlags flags=ksQueryFlags.DEFAULT)
 Construct a shape sweep using an origin point, direction and distance. More...
 
 ksSweepParams (ksShape shape, ksVector3 origin, ksVector3 end, ksQuaternion rotation, ksIQueryFilter filter=null, ksIEntity excludeEntity=null, ksQueryFlags flags=ksQueryFlags.DEFAULT)
 Construct a shape sweep using an origin and end point. More...
 
 ksSweepParams (ksIEntity entity, ksVector3 direction, float distance, ksIQueryFilter filter=null, ksIEntityQueryColliderFilter colliderFilter=null, bool excludeSelf=true, ksQueryFlags flags=ksQueryFlags.DEFAULT)
 Construct an entity sweep from the entity position and sweeping over a direction and distance. More...
 
 ksSweepParams (ksIEntity entity, ksVector3 end, ksIQueryFilter filter=null, ksIEntityQueryColliderFilter colliderFilter=null, bool excludeSelf=true, ksQueryFlags flags=ksQueryFlags.DEFAULT)
 Construct an entity sweep from the entity position and sweeping to an end point. More...
 
 ksSweepParams (ksIEntity entity, ksVector3 origin, ksQuaternion rotation, ksVector3 direction, float distance, ksIQueryFilter filter=null, ksIEntityQueryColliderFilter colliderFilter=null, bool excludeSelf=true, ksQueryFlags flags=ksQueryFlags.DEFAULT)
 Construct an entity sweep from a specified origin and rotation and sweeping over a direction and distance. More...
 
 ksSweepParams (ksIEntity entity, ksVector3 origin, ksVector3 end, ksQuaternion rotation, ksIQueryFilter filter=null, ksIEntityQueryColliderFilter colliderFilter=null, bool excludeSelf=true, ksQueryFlags flags=ksQueryFlags.DEFAULT)
 Construct an entity sweep from a specified origin and rotation and sweeping to an end point. More...
 
 ksSweepParams (ksICollider collider, ksVector3 direction, float distance, ksIQueryFilter filter=null, bool excludeColliderEntity=true, ksQueryFlags flags=ksQueryFlags.DEFAULT)
 Construct a collider sweep from the entity position and sweeping over a direction and distance. More...
 
 ksSweepParams (ksICollider collider, ksVector3 end, ksIQueryFilter filter=null, bool excludeColliderEntity=true, ksQueryFlags flags=ksQueryFlags.DEFAULT)
 Construct a collider sweep from the entity position and sweeping to an end point. More...
 
 ksSweepParams (ksICollider collider, ksVector3 origin, ksQuaternion rotation, ksVector3 direction, float distance, ksIQueryFilter filter=null, bool excludeColliderEntity=true, ksQueryFlags flags=ksQueryFlags.DEFAULT)
 Construct a collider sweep from a specified origin and rotation and sweeping over a direction and distance. More...
 
 ksSweepParams (ksICollider collider, ksVector3 origin, ksVector3 end, ksQuaternion rotation, ksIQueryFilter filter=null, bool excludeColliderEntity=true, ksQueryFlags flags=ksQueryFlags.DEFAULT)
 Construct a collider sweep from a specified origin and rotation and sweeping to an end point. More...
 
void CopyTo (ksSweepParams target)
 Copies the values from this object to the target . More...
 
- Public Member Functions inherited from KS.Reactor.ksOverlapParams
 ksOverlapParams ()
 Constructor More...
 
 ksOverlapParams (ksShape shape, ksVector3 origin, ksQuaternion rotation, ksIQueryFilter filter=null, ksIEntity excludeEntity=null, ksQueryFlags flags=ksQueryFlags.DEFAULT)
 Constructor More...
 
 ksOverlapParams (ksIEntity entity, ksIQueryFilter filter=null, ksIEntityQueryColliderFilter colliderFilter=null, bool excludeSelf=true, ksQueryFlags flags=ksQueryFlags.DEFAULT)
 Entity overlap which uses the pose of the entity when the query is performed. More...
 
 ksOverlapParams (ksIEntity entity, ksVector3 origin, ksQuaternion rotation, ksIQueryFilter filter=null, ksIEntityQueryColliderFilter colliderFilter=null, bool excludeSelf=true, ksQueryFlags flags=ksQueryFlags.DEFAULT)
 Entity overlap which sets the pose; More...
 
 ksOverlapParams (ksICollider collider, ksIQueryFilter filter=null, bool excludeColliderEntity=true, ksQueryFlags flags=ksQueryFlags.DEFAULT)
 Collider overlap that uses the collider's entity's pose. More...
 
 ksOverlapParams (ksICollider collider, ksVector3 origin, ksQuaternion rotation, ksIQueryFilter filter=null, bool excludeColliderEntity=true, ksQueryFlags flags=ksQueryFlags.DEFAULT)
 Collider overlap that sets the pose. More...
 
override bool Validate (bool log=true)
 Checks if the parameters are valid. More...
 
void CopyTo (ksOverlapParams target)
 Copies the values from this object to the target . More...
 
- Public Member Functions inherited from KS.Reactor.ksBaseQueryParams
void CopyTo (ksBaseQueryParams target)
 Copies the values from this object to the target . More...
 

Public Attributes

float Distance
 Sweep distance More...
 
- Public Attributes inherited from KS.Reactor.ksOverlapParams
ksIEntityQueryColliderFilter EntityColliderFilter
 Collider filter for entity queries to determine which of the entity's colliders to run queries for. More...
 
bool UseEntityPosition = false
 If true, the position of the entity will be used in place of an explicit origin or rotation. More...
 
bool UseEntityRotation = false
 If true, the rotation of the entity will be used in place of an explicit origin or rotation. More...
 
- Public Attributes inherited from KS.Reactor.ksBaseQueryParams
ksIQueryFilter Filter
 Query filter for filtering results. If null, all hits are touching. More...
 
ksIEntity ExcludeEntity
 This entity is excluded from results. More...
 
ksQueryFlags Flags = ksQueryFlags.DEFAULT
 Query flags for filtering results. More...
 

Properties

override ksQueryTypes QueryType [get]
 Query type More...
 
ksVector3 Direction [get, set]
 Sweep direction More...
 
ksVector3 End [get, set]
 Sweep distance More...
 
- Properties inherited from KS.Reactor.ksOverlapParams
override ksQueryTypes QueryType [get]
 Query type More...
 
ksShape?? Shape [get, set]
 Get/Set the ksShape More...
 
ksIEntity?? Entity [get, set]
 Get/Set the ksIEntity More...
 
ksICollider?? Collider [get, set]
 Get/Set the ksICollider More...
 
object QueryObject [get, set]
 Get/Set the object which defines the geomeetry being queried. More...
 
override ksVector3 Origin [get, set]
 Set/Get the query origin. More...
 
ksQuaternion Rotation [get, set]
 Set/Get the query rotation. More...
 
override ksQueryObjectTypes ObjectType [get]
 The object type used in the query. More...
 
- Properties inherited from KS.Reactor.ksBaseQueryParams
abstract ksVector3 Origin [get, set]
 The starting position of the physics query. More...
 
abstract ksQueryTypes QueryType [get]
 Query type More...
 
virtual ksQueryObjectTypes ObjectType [get]
 The object type used in the query. More...
 

Additional Inherited Members

- Protected Member Functions inherited from KS.Reactor.ksOverlapParams
 ksOverlapParams (ksVector3 origin, ksQuaternion rotation, ksIQueryFilter filter, ksIEntity excludeEntity, ksQueryFlags flags, bool useEntityPosition=false, bool useEntityRotation=false)
 Private common constructor for all query object types More...
 
- Protected Attributes inherited from KS.Reactor.ksOverlapParams
object m_queryObject = null
 
ksQueryObjectTypes m_queryObjectType = ksQueryObjectTypes.NONE
 
ksVector3 m_origin
 
ksQuaternion m_rotation = ksQuaternion.Identity
 

Constructor & Destructor Documentation

◆ ksSweepParams() [1/11]

KS.Reactor.ksSweepParams.ksSweepParams ( )

Default constructor

◆ ksSweepParams() [2/11]

KS.Reactor.ksSweepParams.ksSweepParams ( ksShape  shape,
ksVector3  origin,
ksQuaternion  rotation,
ksVector3  direction,
float  distance,
ksIQueryFilter  filter = null,
ksIEntity  excludeEntity = null,
ksQueryFlags  flags = ksQueryFlags.DEFAULT 
)

Construct a shape sweep using an origin point, direction and distance.

Parameters
shapeSweep shape
originSweep origin
rotationShape rotation
directionSweep direction
distanceSweep distance
filterQuery filter for filtering results.
excludeEntityExclude this entity from results.
flagsQuery flags for filtering results.

◆ ksSweepParams() [3/11]

KS.Reactor.ksSweepParams.ksSweepParams ( ksShape  shape,
ksVector3  origin,
ksVector3  end,
ksQuaternion  rotation,
ksIQueryFilter  filter = null,
ksIEntity  excludeEntity = null,
ksQueryFlags  flags = ksQueryFlags.DEFAULT 
)

Construct a shape sweep using an origin and end point.

Parameters
shapeSweep shape
originSweep origin
endSweep end point
rotationShape rotation
filterQuery filter for filtering results.
excludeEntityExclude this entity from results.
flagsQuery flags for filtering results.

◆ ksSweepParams() [4/11]

KS.Reactor.ksSweepParams.ksSweepParams ( ksIEntity  entity,
ksVector3  direction,
float  distance,
ksIQueryFilter  filter = null,
ksIEntityQueryColliderFilter  colliderFilter = null,
bool  excludeSelf = true,
ksQueryFlags  flags = ksQueryFlags.DEFAULT 
)

Construct an entity sweep from the entity position and sweeping over a direction and distance.

Parameters
entitySweep entity
directionSweep direction
distanceSweep distance
filterQuery filter for filtering results.
colliderFilterQuery collider filter for filtering which of the entity's colliders to query with.
excludeSelfShould entity be excluded from results?
flagsQuery flags for filtering results.

◆ ksSweepParams() [5/11]

KS.Reactor.ksSweepParams.ksSweepParams ( ksIEntity  entity,
ksVector3  end,
ksIQueryFilter  filter = null,
ksIEntityQueryColliderFilter  colliderFilter = null,
bool  excludeSelf = true,
ksQueryFlags  flags = ksQueryFlags.DEFAULT 
)

Construct an entity sweep from the entity position and sweeping to an end point.

Parameters
entitySweep entity
endSweep end point
filterQuery filter for filtering results.
colliderFilterQuery collider filter for filtering which of the entity's colliders to query with.
excludeSelfShould entity be excluded from results?
flagsQuery flags for filtering results.

◆ ksSweepParams() [6/11]

KS.Reactor.ksSweepParams.ksSweepParams ( ksIEntity  entity,
ksVector3  origin,
ksQuaternion  rotation,
ksVector3  direction,
float  distance,
ksIQueryFilter  filter = null,
ksIEntityQueryColliderFilter  colliderFilter = null,
bool  excludeSelf = true,
ksQueryFlags  flags = ksQueryFlags.DEFAULT 
)

Construct an entity sweep from a specified origin and rotation and sweeping over a direction and distance.

Parameters
entitySweep entity
originSweep origin
rotationSweep rotation
directionSweep direction
distanceSweep distance
filterQuery filter for filtering results.
colliderFilterQuery collider filter for filtering which of the entity's colliders to query with.
excludeSelfShould entity be excluded from results?
flagsQuery flags for filtering results.

◆ ksSweepParams() [7/11]

KS.Reactor.ksSweepParams.ksSweepParams ( ksIEntity  entity,
ksVector3  origin,
ksVector3  end,
ksQuaternion  rotation,
ksIQueryFilter  filter = null,
ksIEntityQueryColliderFilter  colliderFilter = null,
bool  excludeSelf = true,
ksQueryFlags  flags = ksQueryFlags.DEFAULT 
)

Construct an entity sweep from a specified origin and rotation and sweeping to an end point.

Parameters
entitySweep entity
originSweep origin
endSweep end point
rotationSweep rotation
filterQuery filter for filtering results.
colliderFilterQuery collider filter for filtering which of the entity's colliders to query with.
excludeSelfShould entity be excluded from results?
flagsQuery flags for filtering results.

◆ ksSweepParams() [8/11]

KS.Reactor.ksSweepParams.ksSweepParams ( ksICollider  collider,
ksVector3  direction,
float  distance,
ksIQueryFilter  filter = null,
bool  excludeColliderEntity = true,
ksQueryFlags  flags = ksQueryFlags.DEFAULT 
)

Construct a collider sweep from the entity position and sweeping over a direction and distance.

Parameters
colliderSweep collider
directionSweep direction
distanceSweep distance
filterQuery filter for filtering results.
excludeColliderEntityShould collider 's entity be excluded from results?
flagsQuery flags for filtering results.

◆ ksSweepParams() [9/11]

KS.Reactor.ksSweepParams.ksSweepParams ( ksICollider  collider,
ksVector3  end,
ksIQueryFilter  filter = null,
bool  excludeColliderEntity = true,
ksQueryFlags  flags = ksQueryFlags.DEFAULT 
)

Construct a collider sweep from the entity position and sweeping to an end point.

Parameters
colliderSweep collider
endSweep end point
filterQuery filter for filtering results.
excludeColliderEntityShould collider 's entity be excluded from results?
flagsQuery flags for filtering results.

◆ ksSweepParams() [10/11]

KS.Reactor.ksSweepParams.ksSweepParams ( ksICollider  collider,
ksVector3  origin,
ksQuaternion  rotation,
ksVector3  direction,
float  distance,
ksIQueryFilter  filter = null,
bool  excludeColliderEntity = true,
ksQueryFlags  flags = ksQueryFlags.DEFAULT 
)

Construct a collider sweep from a specified origin and rotation and sweeping over a direction and distance.

Parameters
colliderSweep collider
originSweep origin
rotationSweep rotation
directionSweep direction
distanceSweep distance
filterQuery filter for filtering results.
excludeColliderEntityShould collider 's entity be excluded from results?
flagsQuery flags for filtering results.

◆ ksSweepParams() [11/11]

KS.Reactor.ksSweepParams.ksSweepParams ( ksICollider  collider,
ksVector3  origin,
ksVector3  end,
ksQuaternion  rotation,
ksIQueryFilter  filter = null,
bool  excludeColliderEntity = true,
ksQueryFlags  flags = ksQueryFlags.DEFAULT 
)

Construct a collider sweep from a specified origin and rotation and sweeping to an end point.

Parameters
colliderSweep collider
originSweep origin
endSweep end point
rotationSweep rotation
filterQuery filter for filtering results.
excludeColliderEntityShould collider 's entity be excluded from results?
flagsQuery flags for filtering results.

Member Function Documentation

◆ CopyTo()

void KS.Reactor.ksSweepParams.CopyTo ( ksSweepParams  target)

Copies the values from this object to the target .

Parameters
targetTarget to copy to.

Member Data Documentation

◆ Distance

float KS.Reactor.ksSweepParams.Distance

Sweep distance

Property Documentation

◆ Direction

ksVector3 KS.Reactor.ksSweepParams.Direction
getset

Sweep direction

◆ End

ksVector3 KS.Reactor.ksSweepParams.End
getset

Sweep distance

The end-point of the sweep.

◆ QueryType

override ksQueryTypes KS.Reactor.ksSweepParams.QueryType
get

Query type