Class AbstractViewportControls

Abstract class for all viewport controls implementations.

Hierarchy (View Summary)

EventDispatcher
- AbstractViewportControls
  - SimpleViewportControls
  - ViewportCameraControls

Implements

ViewportControls

Index

Constructors

constructor

new AbstractViewportControls(
object: Object3D,
domElement: HTMLCanvasElement,
): AbstractViewportControls
Parameters
- object: Object3D
- domElement: HTMLCanvasElement
Returns AbstractViewportControls
Overrides THREE.EventDispatcher.constructor
- Defined in src/controls/AbstractViewportControls.ts:25

Properties

`Protected`_enabled

_enabled: boolean

domElement

domElement: HTMLCanvasElement

Reference to the canvas element where the controls are attached. I.e. where pointer events are listened.

object

object: Object3D<Object3DEventMap>

Object that is begin controlled. Usually the camera.

Accessors

enabled

get enabled(): boolean
Whether the controls are enabled or not.

Returns boolean
Default
```
true
```
Implementation of ViewportControls.enabled
- Defined in src/controls/AbstractViewportControls.ts:17
set enabled(value: boolean): void
Whether the controls are enabled or not.
Parameters
- value: boolean
Returns void
Default
```
true
```
Implementation of ViewportControls.enabled
- Defined in src/controls/AbstractViewportControls.ts:13

Methods

addDebug

addDebug(_gui: GUI): void
This allows all components to add their own debug options to the debugger.

For example, the controls. One controls may provide a set of debug options while another may provide a slightly different set.
Parameters
- _gui: GUI
Returns void
Implementation of ViewportControls.addDebug
- Defined in src/controls/AbstractViewportControls.ts:50

addEventListener

addEventListener<T extends never>(
type: T,
listener: EventListener<{}[T], T, AbstractViewportControls>,
): void
Adds a listener to an event type.
Type Parameters
- T extends never
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<{}[T], T, AbstractViewportControls>
  The function that gets called when the event is fired.
Returns void
Implementation of ViewportControls.addEventListener
Inherited from THREE.EventDispatcher.addEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:52

dispatchEvent

dispatchEvent<T extends never>(event: BaseEvent<T> & {}[T]): void
Fire an event type.
Type Parameters
- T extends never
Parameters
- event: BaseEvent<T> & {}[T]
  The event that gets fired.
Returns void
Implementation of ViewportControls.dispatchEvent
Inherited from THREE.EventDispatcher.dispatchEvent
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:81

dispose

dispose(): void
Dispose the controls and its event listeners.

Returns void
Implementation of ViewportControls.dispose
- Defined in src/controls/AbstractViewportControls.ts:42

focus

focus(_object: Object3D, ..._args: any[]): void
Focus the controls on the given target.
Parameters
- _object: Object3D
- ..._args: any[]
Returns void
Implementation of ViewportControls.focus
- Defined in src/controls/AbstractViewportControls.ts:36

hasEventListener

hasEventListener<T extends never>(
type: T,
listener: EventListener<{}[T], T, AbstractViewportControls>,
): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends never
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<{}[T], T, AbstractViewportControls>
  The function that gets called when the event is fired.
Returns boolean
Implementation of ViewportControls.hasEventListener
Inherited from THREE.EventDispatcher.hasEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:62

removeEventListener

removeEventListener<T extends never>(
type: T,
listener: EventListener<{}[T], T, AbstractViewportControls>,
): void
Removes a listener from an event type.
Type Parameters
- T extends never
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<{}[T], T, AbstractViewportControls>
  The listener function that gets removed.
Returns void
Implementation of ViewportControls.removeEventListener
Inherited from THREE.EventDispatcher.removeEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:72

setCamera

setCamera(_camera: Camera): void
Set the camera to be used by this renderer.
Parameters
- _camera: Camera
Returns void
Implementation of ViewportControls.setCamera
- Defined in src/controls/AbstractViewportControls.ts:33

test

test(): boolean
E2E test method.

This method should return true if the test passes, and false if it fails. Check the method itself for more information.

Returns boolean
Implementation of ViewportControls.test
- Defined in src/controls/AbstractViewportControls.ts:45

update

update(_delta: number): void
Call this on every frame to update the controls.
Parameters
- _delta: number
Returns void
Implementation of ViewportControls.update
- Defined in src/controls/AbstractViewportControls.ts:39

Class AbstractViewportControls

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AbstractViewportControls

Properties

Protected_enabled

domElement

object

Accessors

enabled

Returns boolean

Default

Parameters

Returns void

Default

Methods

addDebug

Parameters

Returns void

addEventListener

Type Parameters

Parameters

Returns void

dispatchEvent

Type Parameters

Parameters

Returns void

dispose

Returns void

focus

Parameters

Returns void

hasEventListener

Type Parameters

Parameters

Returns boolean

removeEventListener

Type Parameters

Parameters

Returns void

setCamera

Parameters

Returns void

test

Returns boolean

update

Parameters

Returns void

Settings

On This Page

`Protected`_enabled