ISceneQueryResultBuilder

Description

interface Tinman.Engine.Scenes.Queries.ISceneQueryResultBuilder

Derived from

IBeginEnd

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:

Public / Methods

Result


[BeginEnd]
public method Result → (1)

result in : ISceneQueryResult

[not-null]
The intermediate query result.

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:

ResultCheck

3 overloads


public method ResultCheck1 → (1)

queryMask in : int64

The spatial query mask, see ISceneObject.QueryMask.

returns → bool

true if intermediate query results with the given queryMask in 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 ResultCheck2 → (1)

distance in : RangeD

The query result distance range.

returns → bool

true if intermediate query results with the given distance in 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 ResultCheck3 → (1)

mask in : SceneQueryResultType

The query result type mask.

returns → bool

true if at least one intermediate query result type in mask in 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 / Attributes

Distance


public attribute Distance → (get)

value : RangeD

The distance range.

The current distance range.