Class AbstractViewportControls

Abstract class for all viewport controls implementations.

Hierarchy

EventDispatcher
- AbstractViewportControls
  - SimpleViewportControls
  - ViewportCameraControls

Implements

ViewportControls

Index

Constructors

constructor

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

Properties

`Protected` _enabled

_enabled: boolean

domElement

domElement: HTMLCanvasElement

object

object: Object3D<Object3DEventMap>

Accessors

enabled

get enabled(): boolean
Returns boolean
Implementation of ViewportControls.enabled
- Defined in src/controls/AbstractViewportControls.ts:17
set enabled(value): void
Parameters
- value: boolean
Returns void
Implementation of ViewportControls.enabled
- Defined in src/controls/AbstractViewportControls.ts:13

Methods

addDebug

addDebug(_gui): void
Parameters
- _gui: GUI
Returns void
Implementation of ViewportControls.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, 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>(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 THREE.EventDispatcher.dispatchEvent
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:81

dispose

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

focus

focus(_object, ..._args): void
Parameters
- _object: Object3D<Object3DEventMap>
- Rest ..._args: any[]
Returns void
Implementation of ViewportControls.focus
- Defined in src/controls/AbstractViewportControls.ts:36

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, 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>(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, 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): void
Parameters
- _camera: Camera
Returns void
Implementation of ViewportControls.setCamera
- Defined in src/controls/AbstractViewportControls.ts:33

test

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

update

update(_delta): void
Parameters
- _delta: number
Returns void
Implementation of ViewportControls.update
- Defined in src/controls/AbstractViewportControls.ts:39

Class AbstractViewportControls

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

object: Object3D<Object3DEventMap>

domElement: HTMLCanvasElement

Returns AbstractViewportControls

Properties

Protected _enabled

domElement

object

Accessors

enabled

Returns boolean

Parameters

value: boolean

Returns void

Methods

addDebug

Parameters

_gui: GUI

Returns void

addEventListener

Type Parameters

T extends never

Parameters

type: T

listener: EventListener<{}[T], T, AbstractViewportControls>

Returns void

dispatchEvent

Type Parameters

T extends never

Parameters

event: BaseEvent<T> & {}[T]

Returns void

dispose

Returns void

focus

Parameters

_object: Object3D<Object3DEventMap>

Rest ..._args: any[]

Returns void

hasEventListener

Type Parameters

T extends never

Parameters

type: T

listener: EventListener<{}[T], T, AbstractViewportControls>

Returns boolean

removeEventListener

Type Parameters

T extends never

Parameters

type: T

listener: EventListener<{}[T], T, AbstractViewportControls>

Returns void

setCamera

Parameters

_camera: Camera

Returns void

test

Returns boolean

update

Parameters

_delta: number

Returns void

Settings

Member Visibility

Theme

On This Page

`Protected` _enabled

`Rest` ..._args: any[]