Class SimpleViewportControls

Abstract class for all viewport controls implementations.

Hierarchy (View Summary)

AbstractViewportControls
- SimpleViewportControls

Implements

ViewportControls

Index

Constructors

constructor

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

Properties

`Protected`_enabled

_enabled: boolean

center

center: Vector3

dispose

dispose: () => void

domElement

domElement: HTMLCanvasElement

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

object

object: Object3D<Object3DEventMap>

Usually the camera.

panSpeed

panSpeed: number

rotationSpeed

rotationSpeed: number

zoomSpeed

zoomSpeed: number

Accessors

enabled

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

Returns boolean
Default
```
true
```
Implementation of ViewportControls.enabled
Inherited from AbstractViewportControls.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
Inherited from AbstractViewportControls.enabled
- Defined in src/controls/AbstractViewportControls.ts:13

Methods

`Protected`_changeEvent

_changeEvent(): void
Returns void
- Defined in src/controls/SimpleViewportControls.ts:376

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
Inherited from AbstractViewportControls.addDebug
- Defined in src/controls/AbstractViewportControls.ts:50

addEventListener

addEventListener<T extends never>(
type: T,
listener: EventListener<{}[T], T, SimpleViewportControls>,
): 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, SimpleViewportControls>
  The function that gets called when the event is fired.
Returns void
Implementation of ViewportControls.addEventListener
Inherited from AbstractViewportControls.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 AbstractViewportControls.dispatchEvent
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:81

focus

focus(target: Object3D, delta?: Vector3): void
Focus the controls on the given target.
Parameters
- target: Object3D
- delta: Vector3 = ...
Returns void
Implementation of ViewportControls.focus
Overrides AbstractViewportControls.focus
- Defined in src/controls/SimpleViewportControls.ts:308

hasEventListener

hasEventListener<T extends never>(
type: T,
listener: EventListener<{}[T], T, SimpleViewportControls>,
): 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, SimpleViewportControls>
  The function that gets called when the event is fired.
Returns boolean
Implementation of ViewportControls.hasEventListener
Inherited from AbstractViewportControls.hasEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:62

pan

pan(delta: Vector3): void
Parameters
- delta: Vector3
Returns void
- Defined in src/controls/SimpleViewportControls.ts:331

removeEventListener

removeEventListener<T extends never>(
type: T,
listener: EventListener<{}[T], T, SimpleViewportControls>,
): 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, SimpleViewportControls>
  The listener function that gets removed.
Returns void
Implementation of ViewportControls.removeEventListener
Inherited from AbstractViewportControls.removeEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:72

rotate

rotate(delta: Vector3): void
Parameters
- delta: Vector3
Returns void
- Defined in src/controls/SimpleViewportControls.ts:357

setCamera

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

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
Overrides AbstractViewportControls.test
- Defined in src/controls/SimpleViewportControls.ts:396

update

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

zoom

zoom(delta: Vector3): void
Parameters
- delta: Vector3
Returns void
- Defined in src/controls/SimpleViewportControls.ts:343

Class SimpleViewportControls

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SimpleViewportControls

Properties

Protected_enabled

center

dispose

domElement

object

panSpeed

rotationSpeed

zoomSpeed

Accessors

enabled

Returns boolean

Default

Parameters

Returns void

Default

Methods

Protected_changeEvent

Returns void

addDebug

Parameters

Returns void

addEventListener

Type Parameters

Parameters

Returns void

dispatchEvent

Type Parameters

Parameters

Returns void

focus

Parameters

Returns void

hasEventListener

Type Parameters

Parameters

Returns boolean

pan

Parameters

Returns void

removeEventListener

Type Parameters

Parameters

Returns void

rotate

Parameters

Returns void

setCamera

Parameters

Returns void

test

Returns boolean

update

Parameters

Returns void

zoom

Parameters

Returns void

Settings

On This Page

`Protected`_enabled

`Protected`_changeEvent