Class SimpleViewportControls

Abstract class for all viewport controls implementations.

Hierarchy

AbstractViewportControls
- SimpleViewportControls

Implements

ViewportControls

Index

Constructors

Properties

_enabled center dispose domElement object panSpeed rotationSpeed zoomSpeed

Accessors

Methods

_changeEvent addDebug addEventListener dispatchEvent focus hasEventListener pan removeEventListener rotate setCamera test update zoom

Constructors

constructor

new SimpleViewportControls(object, domElement): SimpleViewportControls
Parameters
- object: Object3D<Object3DEventMap>
- 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)

Type declaration

- (): void
- Returns void

domElement

domElement: HTMLCanvasElement

object

object: Object3D<Object3DEventMap>

Usually the camera.

panSpeed

panSpeed: number

rotationSpeed

rotationSpeed: number

zoomSpeed

zoomSpeed: number

Accessors

enabled

get enabled(): boolean
Returns boolean
Implementation of ViewportControls.enabled

Inherited from AbstractViewportControls.enabled
- Defined in src/controls/AbstractViewportControls.ts:17
set enabled(value): void
Parameters
- value: boolean
Returns void
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): void
Parameters
- _gui: GUI
Returns void
Implementation of ViewportControls.addDebug

Inherited from AbstractViewportControls.addDebug
- Defined in src/controls/AbstractViewportControls.ts:50

addEventListener

addEventListener<T>(type, listener): 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>(event): 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, delta?): void
Parameters
- target: Object3D<Object3DEventMap>
- delta: Vector3 = ...
Returns void
Implementation of ViewportControls.focus

Overrides AbstractViewportControls.focus
- Defined in src/controls/SimpleViewportControls.ts:308

hasEventListener

hasEventListener<T>(type, listener): 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): void
Parameters
- delta: Vector3
Returns void
- Defined in src/controls/SimpleViewportControls.ts:331

removeEventListener

removeEventListener<T>(type, listener): 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): void
Parameters
- delta: Vector3
Returns void
- Defined in src/controls/SimpleViewportControls.ts:357

setCamera

setCamera(_camera): void
Parameters
- _camera: Camera
Returns void
Implementation of ViewportControls.setCamera

Overrides AbstractViewportControls.setCamera
- Defined in src/controls/SimpleViewportControls.ts:385

test

test(): boolean
Returns boolean
Implementation of ViewportControls.test

Overrides AbstractViewportControls.test
- Defined in src/controls/SimpleViewportControls.ts:396

update

update(_delta): void
Parameters
- _delta: number
Returns void
Implementation of ViewportControls.update

Overrides AbstractViewportControls.update
- Defined in src/controls/SimpleViewportControls.ts:383

zoom

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

Generated using TypeDoc