Creates a new scene selection manager.
Camera into which to render the selection overlay, and perform picking from.
Settings that control how are pickable gizmos drawn.
OptionalisInternalConstructor: booleanThe settings used to draw the gizmos for picking.
Begin a drag selection, internally this records the selection when the drag operation starts.
The initial selection to start the drag selection with.
True to perform an update of the scene cache, required in most cases.
True to perform the update of the scene cache in a blocking manner, this is required when picking begins immediately.
End a drag selection, clears internal state set by BeginDragSelection.
Try to get cached scene object data at given location.
Information about the scene picking
The SnapData might not be valid unless the data is already cached. If SnapData is required use getCachedSnapSampleForPosition instead.
Try to get cached object data with snapping information at given location.
Information about the scene picking
Snap samples require an expensive read-back of mesh data, so this method should only be used when snap information is actually required. Otherwise use getCachedSampleForPosition.
Get all intersection points between a line and the meshes of a scene object.
A point on the line.
A direction vector of the line.
Scene object to find intersections.
All the intersections between the line and the object, if any.
Attempts to acquire pick data for the provided pointerPosition.
Position of the pointer relative to the scene camera viewport.
Optional set of objects to ignore during scene picking.
True to require snap data, false to only get object/component info.
Information about the the snap.
This is a slow API that should only be used for single-shot request. For continous requests, it's better to call updateCacheAsync and use getCachedSampleForPosition instead.
Attempts to select a scene object under the pointer position.
Position of the pointer relative to the scene camera viewport.
Should this selection add to the existing selection, or replace it.
Optional set of objects to ignore during scene picking.
This is a slow API that should only be used for single-shot request. For continous requests, it's better to call updateCacheAsync and use getCachedSampleForPosition instead.
Selects a scene object in the specified area. Rebuilds selection cache if needed.
Position of the pointer relative to the scene camera viewport.
Size of the in which objects will be selected, in pixels and relative to
Should this selection add and remove to the existing selection, or replace it.
Should this selection only add to the existing selection, when additive is true.
Optional set of objects to ignore during scene picking.
Is the function blocking until the results are available.
Schedules a blocking update of cache containing object IDs and positions in given camera view.
A list of objects that should be ignored during scene picking.
OptionaldrawGizmos: boolean
Should gizmos be included.
OptionalintersectionRay: Immutable<Ray>
If specified, only objects that AABB intersect the picking ray will be included in the cache.
Prefer to use updateCacheAsync instead, unless you specifically need a blocking call.
Schedules an asynchronous update of cache containing object IDs and positions in given camera view.
OptionalignoreSceneObjects: SceneObject[]
A list of objects that should be ignored during scene picking.
OptionaldrawGizmos: boolean
Should gizmos be included.
OptionalintersectionRay: Immutable<Ray>
If specified, only objects that AABB intersect the picking ray will be included in the cache.
The ScenePicking class exposes high-level functionality for convenient picking and drag-selecting of objects in a camera viewport.