ISceneQueryResultBuilder

Description

interface Tinman.Engine.Scenes.Queries.ISceneQueryResultBuilder

Consumes intermediate scene query results that are produced by a ISceneQueryOp objects and builds the final scene query result.

The following logic is used to build the final scene query result from the sequence of intermediate query results:

When IBeginEnd.Begin is called, these steps are performed:
1. If there is a current result group G, push it onto the stack.
2. Create a new result group G, which is initially empty.
3. Process next event (i.e. begin, result or end).
When Result is called to output the intermediate result R, these steps are performed:
1. Goto 8 if R is rejected by ISceneQuery.FilterAnyOf.
2. Goto 8 if R if rejected by ISceneQuery.FilterDistance.
3. Goto 8 if R if rejected by ISceneQuery.FilterNearest.
4. Goto 8 if R if it is an ancestor of any element in G, according to ISceneQueryResult.IsAncestorOrSelf.
5. Remove all elements in G that are ancestors of R, according to ISceneQueryResult.IsAncestorOrSelf.
6. Add R to G.
7. Remove all elements in G that are rejected by ISceneQuery.FilterNearest.
8. Process next event (i.e. begin, result or end).
When IBeginEnd.End is called, these steps are performed:
1. Discard G, if rejected by ISceneQuery.FilterAllOf.
2. If G contains exactly one element, use that element as R.
  Otherwise, wrap the elements of G in a GroupResult and use that as R.
3. Restore the previous result group G from the stack.
4. Add R to G.
5. Remove all elements in G that are rejected by ISceneQuery.FilterNearest.
6. Process next event (i.e. begin, result or end).
When there are no more events, the query result list is computed by sorting the elements in the final result group G according to SceneQueryResult.SortByDistanceAsc.

[BeginEnd]
public method Result → (1)

Outputs an intermediate query result.

To avoid unnecessary construction of scene query result objects, this method should only be called if all of the following methods return true:

_3 overloads

public method ResultCheck¹ → (1)

queryMask ⁱⁿ : int64: The spatial query mask, see ISceneObject.QueryMask.
returns → bool: true if intermediate query results with the given queryMask ⁱⁿ can possibly be included in the final query result,
false if it is known that those will never be included.

Checks if any intermediate query result with the given query mask would be included in the final query result.

public method ResultCheck² → (1)

distance ⁱⁿ : RangeD: The query result distance range.
returns → bool: true if intermediate query results with the given distance ⁱⁿ range can possibly be included in the final query result,
false if it is known that those will never be included.

Checks if any intermediate query result within the given distance range would be included in the final query result.

public method ResultCheck³ → (1)

mask ⁱⁿ : SceneQueryResultType: The query result type mask.
returns → bool: true if at least one intermediate query result type in mask ⁱⁿ can possibly be included in the query results,
false if it is known that those will never be included.

Checks if any of the given intermediate query result types would be included in the final query results.

public attribute Distance → (get)

The current distance range.