KS.Reactor.ksRaycastParams Class Reference

Parameters for raycast queries. More...

Inheritance diagram for KS.Reactor.ksRaycastParams:

Public Member Functions
	ksRaycastParams ()
	Constructor More...
	ksRaycastParams (ksVector3 origin, ksVector3 direction, float distance, ksIQueryFilter filter=null, ksIEntity excludeEntity=null, ksQueryFlags flags=ksQueryFlags.DEFAULT)
	Constructor More...
	ksRaycastParams (ksVector3 origin, ksVector3 end, ksIQueryFilter filter=null, ksIEntity excludeEntity=null, ksQueryFlags flags=ksQueryFlags.DEFAULT)
	Constructor More...
override bool	Validate (bool log=true)
	Checks if the parameters are valid. More...
void	CopyTo (ksRaycastParams 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
	Raycast distance 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 ksVector3	Origin [get, set]
	Raycast origin More...
ksVector3	Direction [get, set]
	Raycast direction More...
ksVector3	End [get, set]
	The end-point of the raycast. More...
override ksQueryTypes	QueryType [get]
	Query type 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...

Detailed Description

Parameters for raycast queries.

Constructor & Destructor Documentation

ksRaycastParams() [1/3]

KS.Reactor.ksRaycastParams.ksRaycastParams

(

)

Constructor

ksRaycastParams() [2/3]

KS.Reactor.ksRaycastParams.ksRaycastParams	(	ksVector3	origin,
		ksVector3	direction,
		float	distance,
		ksIQueryFilter	filter = null,
		ksIEntity	excludeEntity = null,
		ksQueryFlags	flags = ksQueryFlags.DEFAULT
	)

Constructor

Parameters

origin	Raycast origin
direction	Raycast direction
distance	Raycast distance
filter	Query filter for filtering results.
excludeEntity	Exclude this entity from results.
flags	Query flags for filtering results.

ksRaycastParams() [3/3]

KS.Reactor.ksRaycastParams.ksRaycastParams	(	ksVector3	origin,
		ksVector3	end,
		ksIQueryFilter	filter = null,
		ksIEntity	excludeEntity = null,
		ksQueryFlags	flags = ksQueryFlags.DEFAULT
	)

Constructor

Parameters

origin	Raycast origin
end	Raycast end point
filter	Query filter for filtering results.
excludeEntity	Exclude this entity from results.
flags	Query flags for filtering results.

Member Function Documentation

CopyTo()

void KS.Reactor.ksRaycastParams.CopyTo

(

ksRaycastParams

target

)

Copies the values from this object to the target .

Parameters

target

Target to copy to.

Validate()

override bool KS.Reactor.ksRaycastParams.Validate ( bool  log = true )

virtual

Checks if the parameters are valid.

The parameters are invalid if ksBaseQueryParams.Filter is a ksSimulationFilter.

Parameters

log	If true, logs warnings describing what is invalid if anything is invalid.

Returns

True if the params are valid.

Reimplemented from KS.Reactor.ksBaseQueryParams.

Member Data Documentation

Distance

float KS.Reactor.ksRaycastParams.Distance

Raycast distance

Property Documentation

Direction

ksVector3 KS.Reactor.ksRaycastParams.Direction

getset

Raycast direction

End

ksVector3 KS.Reactor.ksRaycastParams.End

getset

The end-point of the raycast.

Origin

override ksVector3 KS.Reactor.ksRaycastParams.Origin

getset

Raycast origin

QueryType

override ksQueryTypes KS.Reactor.ksRaycastParams.QueryType

get

Query type