Chapter 329: SelectionHelper

Core Idea

A helper for SelectionBox.

It visualizes the current selection box with a div container element.

Key Concepts

• element : HTMLDivElement: The visualization of the selection box.
• enabled : boolean: Whether helper is enabled or not.
• isDown : boolean: Whether the mouse or pointer is pressed down.
• renderer : WebGPURenderer | WebGLRenderer: A reference to the renderer.

Code Examples

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

• What it demonstrates: Typical usage of SelectionHelper.

Reference Tables

Constructor

Signature
`new SelectionHelper( renderer : WebGPURenderer

Properties

Property	Description
.element : HTMLDivElement	The visualization of the selection box.
.enabled : boolean	Whether helper is enabled or not.
.isDown : boolean	Whether the mouse or pointer is pressed down.
`.renderer : WebGPURenderer	WebGLRenderer`

Methods

Method	Description
.dispose()	Call this method if you no longer want use to the controls. It frees all internal resources and removes all event listeners.

Key Takeaways

1. Most relevant properties: element, enabled, isDown, renderer.
2. Key methods: dispose.

Connects To

• Source: examples/jsm/interactive/SelectionHelper.js