SelectionBox

This class can be used to select 3D objects in a scene with a selection box. It is recommended to visualize the selected area with the help of SelectionHelper.

Code Example

const selectionBox = new SelectionBox( camera, scene );
const selectedObjects = selectionBox.select( startPoint, endPoint );

Import

SelectionBox is an addon, and must be imported explicitly, see Installation#Addons.

import { SelectionBox } from 'three/addons/interactive/SelectionBox.js';

Constructor

new SelectionBox( camera : Camera, scene : Scene, deep : number )

Constructs a new selection box.

camera

The camera the scene is rendered with.
scene

The scene.
deep

How deep the selection frustum of perspective cameras should extend.

Default is Number.MAX_VALUE.

Properties

.batches : Object

The selected batches of batched meshes.

.camera : Camera

The camera the scene is rendered with.

.collection : Array.<Object3D>

The selected 3D objects.

.deep : number

How deep the selection frustum of perspective cameras should extend.

Default is Number.MAX_VALUE.

.endPoint : Vector3

The end point of the selection.

.instances : Object

The selected instance IDs of instanced meshes.

.scene : Scene

The camera the scene is rendered with.

.startPoint : Vector3

The start point of the selection.

Methods

.select( startPoint : Vector3, endPoint : Vector3 ) : Array.<Object3D>

This method selects 3D objects in the scene based on the given start and end point. If no parameters are provided, the method uses the start and end values of the respective members.

startPoint

The start point.
endPoint

The end point.
Returns: The selected 3D objects.

Source

examples/jsm/interactive/SelectionBox.js