ISceneQueryProvider

Description

interface Tinman.Engine.Scenes.ISceneQueryProvider

Extended by

IScene

Base interface for classes that provide scene queries.

Public / Methods

QueryBox


public method QueryBox → (1)

box in : Box3D

The axis-aligned bounding box.

returns → ISceneQuery

The scene query.

Creates a scene query for finding scene objects that intersect with the given box.

The query result distance (see ISceneQueryResult.Distance) is the distance between the pick result and the center of the given box in.

QueryRay


public method QueryRay → (1)

ray in : Ray

The ray.

returns → ISceneQuery

The scene query.

Creates a scene query for finding scene objects that intersect with the given ray.

The query result distance (see ISceneQueryResult.Distance) is the distance between the projection of the pick result onto the given ray in and its origin.

QueryShape


public method QueryShape → (1)

shape in : IShape

[not-null]
The geo-referenced shape.

returns → ISceneQuery

The scene query.

Creates a scene query for finding scene objects that intersect with the given shape.

The query result distance (see ISceneQueryResult.Distance) is the distance between the pick result of the given shape in (see IShape.DistanceTo2).

QuerySphere


public method QuerySphere → (1)

sphere in : Sphere

The sphere ray.

returns → ISceneQuery

The scene query.

Creates a scene query for finding scene objects that intersect with the given sphere.

The query result distance (see ISceneQueryResult.Distance) is the distance between the pick result and the center of the given sphere in.