Class ViewportCameraControls

Viewport camera controls.

Hierarchy

AbstractViewportControls
- ViewportCameraControls

Implements

ViewportControls

Index

Constructors

constructor

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

Properties

`Protected` _enabled

_enabled: boolean

`Protected` _limitOrographicCameraTo2D

_limitOrographicCameraTo2D: boolean

Whether the orthographic camera should be limited to 2D or not.

If true, the camera will be limited to 2D and only display a view from above - like Google Maps.

`Protected` _previousPolarAngle

_previousPolarAngle: null | number = null

Previous polar angle of the camera.

cameraControls

cameraControls: CameraControls

Reference to the camera-controls instance.

domElement

domElement: HTMLCanvasElement

object

object: Object3D<Object3DEventMap>

Accessors

enabled

set enabled(value): void
Parameters
- value: boolean
Returns void
Implementation of ViewportControls.enabled

Overrides AbstractViewportControls.enabled
- Defined in src/controls/ViewportCameraControls.ts:35

limitOrographicCameraTo2D

get limitOrographicCameraTo2D(): boolean
Returns boolean
- Defined in src/controls/ViewportCameraControls.ts:92
set limitOrographicCameraTo2D(limit): void
Whether the orthographic camera should be limited to 2D or not.

If true, the camera will be limited to 2D and only display a view from above - like Google Maps.
Parameters
- limit: boolean
Returns void
- Defined in src/controls/ViewportCameraControls.ts:62

Methods

addDebug

addDebug(gui): void
Parameters
- gui: GUI
Returns void
Implementation of ViewportControls.addDebug

Overrides AbstractViewportControls.addDebug
- Defined in src/controls/ViewportCameraControls.ts:146

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, ViewportCameraControls>
  
  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

dispose

dispose(): void
Returns void
Implementation of ViewportControls.dispose

Inherited from AbstractViewportControls.dispose
- Defined in src/controls/AbstractViewportControls.ts:42

focus

focus(object): void
Parameters
- object: Object3D<Object3DEventMap>
Returns void
Implementation of ViewportControls.focus

Overrides AbstractViewportControls.focus
- Defined in src/controls/ViewportCameraControls.ts:108

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, ViewportCameraControls>
  
  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

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, ViewportCameraControls>
  
  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

setBoundary

setBoundary(box3?): void
Set the boundary box that encloses the target of the camera. box3 is in THREE.Box3
Parameters
- Optional box3: Box3
  
  THREE.Box3
Returns void
- Defined in src/controls/ViewportCameraControls.ts:154

setCamera

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

Overrides AbstractViewportControls.setCamera
- Defined in src/controls/ViewportCameraControls.ts:118

test

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

Inherited from AbstractViewportControls.test
- Defined in src/controls/AbstractViewportControls.ts:45

update

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

Overrides AbstractViewportControls.update
- Defined in src/controls/ViewportCameraControls.ts:104

Class ViewportCameraControls

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

object: Object3D<Object3DEventMap>

domElement: HTMLCanvasElement

Returns ViewportCameraControls

Properties

Protected _enabled

Protected _limitOrographicCameraTo2D

Protected _previousPolarAngle

cameraControls

domElement

object

Accessors

enabled

Parameters

value: boolean

Returns void

limitOrographicCameraTo2D

Returns boolean

Parameters

limit: boolean

Returns void

Methods

addDebug

Parameters

gui: GUI

Returns void

addEventListener

Type Parameters

T extends never

Parameters

type: T

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

Returns void

dispatchEvent

Type Parameters

T extends never

Parameters

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

Returns void

dispose

Returns void

focus

Parameters

object: Object3D<Object3DEventMap>

Returns void

hasEventListener

Type Parameters

T extends never

Parameters

type: T

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

Returns boolean

removeEventListener

Type Parameters

T extends never

Parameters

type: T

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

Returns void

setBoundary

Parameters

Optional box3: Box3

Returns void

setCamera

Parameters

camera: Camera

Returns void

test

Returns boolean

update

`Protected` _enabled

`Protected` _limitOrographicCameraTo2D

`Protected` _previousPolarAngle

`Optional` box3: Box3