C# Class Axiom.Core.RaySceneQuery

Specializes the SceneQuery class for querying for objects along a ray.

Inheritance: SceneQuery, IRaySceneQueryListener

Show file Open project: WolfgangSt/axiom Class Usage Examples

Protected Properties

Property	Type	Description
lastResults	List
maxResults	int
ray	Axiom.Math.Ray
sortByDistance	bool

Public Methods

Method	Description
ClearResults ( ) : void	Clears out any cached results from the last query.
Execute ( ) : IList	Executes the query, returning the results back in one list. This method executes the scene query as configured, gathers the results into one structure and returns a reference to that structure. These results will also persist in this query object until the next query is executed, or ClearResults. A more lightweight version of this method that returns results through a listener is also available.
Execute ( IRaySceneQueryListener listener ) : void	Executes the query and returns each match through a listener interface. Note that this method does not store the results of the query internally so does not update the 'last result' value. This means that this version of execute is more lightweight and therefore more efficient than the version which returns the results as a collection.
OnQueryResult ( Axiom.Core.MovableObject sceneObject, float distance ) : bool

Private Methods

Method	Description
IRaySceneQueryListener ( SceneQuery fragment, float distance ) : bool
RaySceneQuery ( SceneManager creator ) : System	Constructor.

Method Details

ClearResults() public method

Clears out any cached results from the last query.

public ClearResults ( ) : void
return	void

Execute() public method

Executes the query, returning the results back in one list.

This method executes the scene query as configured, gathers the results into one structure and returns a reference to that structure. These results will also persist in this query object until the next query is executed, or ClearResults. A more lightweight version of this method that returns results through a listener is also available.

public Execute ( ) : IList
return	IList

Execute() public abstract method

Executes the query and returns each match through a listener interface.

Note that this method does not store the results of the query internally so does not update the 'last result' value. This means that this version of execute is more lightweight and therefore more efficient than the version which returns the results as a collection.

public abstract Execute ( IRaySceneQueryListener listener ) : void
listener	IRaySceneQueryListener	Listener object to handle the result callbacks.
return	void

OnQueryResult() public method

public OnQueryResult ( Axiom.Core.MovableObject sceneObject, float distance ) : bool
sceneObject	Axiom.Core.MovableObject
distance	float
return	bool

Property Details

lastResults protected property

List of query results from the last execution of this query.

protected List lastResults
return	List

maxResults protected property

Maximum results to return when executing the query.

protected int maxResults
return	int

ray protected property

Reference to a ray to use for this query.

protected Ray,Axiom.Math ray
return	Axiom.Math.Ray

sortByDistance protected property

If true, results returned in the list

protected bool sortByDistance
return	bool