C# Class Axiom.Core.IntersectionSceneQuery

Separate SceneQuery class to query for pairs of objects which are possibly intersecting one another.
This SceneQuery subclass considers the whole world and returns pairs of objects which are close enough to each other that they may be intersecting. Because of this slightly different focus, the return types and listener interface are different for this class.
Inheritance: SceneQuery, IIntersectionSceneQueryListener
Show file Open project: WolfgangSt/axiom

Protected Properties

Property Type Description
lastResults IntersectionSceneQueryResult

Public Methods

Method Description
ClearResults ( ) : void

Clears out any cached results from the last query.
Execute ( ) : IntersectionSceneQueryResult

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 ( IIntersectionSceneQueryListener 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.

Private Methods

Method Description
Axiom ( Axiom.Core.MovableObject first, Axiom.Core.MovableObject second ) : bool
Axiom ( Axiom.Core.MovableObject obj, SceneQuery fragment ) : bool
IntersectionSceneQuery ( 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 ( ) : IntersectionSceneQueryResult
return IntersectionSceneQueryResult

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 ( IIntersectionSceneQueryListener listener ) : void
listener IIntersectionSceneQueryListener Listener object to handle the result callbacks.
return void

Property Details

lastResults protected property

List of query results from the last execution of this query.
protected IntersectionSceneQueryResult,Axiom.Core lastResults
return IntersectionSceneQueryResult