C# Class Axiom.Core.RegionSceneQuery

Abstract class defining a query which returns single results from within a region.

This class is simply a generalization of the subtypes of query that return a set of individual results in a region. See the SceneQuery class for abstract information, and subclasses for the detail of each query type.

Inheritance: SceneQuery, ISceneQueryListener

Datei anzeigen Open project: WolfgangSt/axiom

Protected Properties

Property	Type	Description
lastResult	SceneQueryResult

Public Methods

Method	Description
ClearResults ( ) : void	Clears out any cached results from the last query.
Execute ( ) : SceneQueryResult	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 is called. An more lightweight version of this method that returns results through a listener is also available.
Execute ( ISceneQueryListener 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 fragment ) : bool	Self-callback in order to deal with execute which returns collection.
OnQueryResult ( Axiom.Core.MovableObject sceneObject ) : bool	Self-callback in order to deal with execute which returns collection.

Private Methods

Method	Description
RegionSceneQuery ( SceneManager creator ) : System	Default 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 is called. An more lightweight version of this method that returns results through a listener is also available.

public Execute ( ) : SceneQueryResult
return	SceneQueryResult

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 ( ISceneQueryListener listener ) : void
listener	ISceneQueryListener
return	void

OnQueryResult() public method

Self-callback in order to deal with execute which returns collection.

public OnQueryResult ( Axiom fragment ) : bool
fragment	Axiom
return	bool

OnQueryResult() public method

Self-callback in order to deal with execute which returns collection.

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

Property Details

lastResult protected_oe property

List of results from the last non-listener query.

protected SceneQueryResult,Axiom.Core lastResult
return	SceneQueryResult