Class: CameraController

Core-API.CameraController

Hierarchy

• SimpleEventDispatcher<"update">

  ↳ CameraController

Implements

• ICamera<IPerspectiveCameraOptions | IOrthographicCameraOptions, PerspectiveCamera | OrthographicCamera, TCameraControls>

Accessors

controls

• get controls(): undefined | TCameraControls

Returns

undefined | TCameraControls

Implementation of

ICamera.controls

Defined in

webgi/src/core/threejs/CameraController.ts:39

---

userData

• get userData(): any

Returns

any

Implementation of

ICamera.userData

Defined in

webgi/src/core/threejs/CameraController.ts:52

• set userData(value): void

Parameters

Name	Type
value	any

Returns

void

Implementation of

ICamera.userData

Defined in

webgi/src/core/threejs/CameraController.ts:55

---

isActiveCamera

• get isActiveCamera(): boolean

Returns

boolean

Implementation of

ICamera.isActiveCamera

Defined in

webgi/src/core/threejs/CameraController.ts:59

---

target

• get target(): Vector3

Returns

Vector3

Implementation of

ICamera.target

Defined in

webgi/src/core/threejs/CameraController.ts:63

• set target(target): void

Parameters

Name	Type
target	Vector3

Returns

void

Implementation of

ICamera.target

Defined in

webgi/src/core/threejs/CameraController.ts:67

---

position

• get position(): Vector3

Returns

Vector3

Implementation of

ICamera.position

Defined in

webgi/src/core/threejs/CameraController.ts:73

• set position(position): void

Parameters

Name	Type
position	Vector3

Returns

void

Implementation of

ICamera.position

Defined in

webgi/src/core/threejs/CameraController.ts:76

---

name

• get name(): string

Returns

string

Implementation of

ICamera.name

Defined in

webgi/src/core/threejs/CameraController.ts:82

• set name(name): void

Parameters

Name	Type
name	string

Returns

void

Implementation of

ICamera.name

Defined in

webgi/src/core/threejs/CameraController.ts:85

---

interactionsEnabled

• get interactionsEnabled(): boolean

If interactions are enabled for this camera. It can be disabled by some code or plugin. see also setInteractions

Returns

boolean

Implementation of

ICamera.interactionsEnabled

Defined in

webgi/src/core/threejs/CameraController.ts:197

• set interactionsEnabled(value): void

If interactions are enabled for this camera. It can be disabled by some code or plugin. see also setInteractions

deprecated

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

ICamera.interactionsEnabled

Defined in

webgi/src/core/threejs/CameraController.ts:205

---

cameraObject

• get cameraObject(): OrthographicCamera | PerspectiveCamera

Returns

OrthographicCamera | PerspectiveCamera

Implementation of

ICamera.cameraObject

Defined in

webgi/src/core/threejs/CameraController.ts:461

---

modelObject

• get modelObject(): OrthographicCamera | PerspectiveCamera

Internal three.js Object3D instance (like Mesh, Group, etc)

Returns

OrthographicCamera | PerspectiveCamera

Implementation of

ICamera.modelObject

Defined in

webgi/src/core/threejs/CameraController.ts:465

---

visible

• get visible(): boolean

Returns

boolean

Implementation of

ICamera.visible

Defined in

webgi/src/core/threejs/CameraController.ts:656

• set visible(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

ICamera.visible

Defined in

webgi/src/core/threejs/CameraController.ts:659

Methods

getControls

▸ getControls<T>(): undefined | T

Type parameters

Name	Type
T	extends ICameraControls<string, T>

Returns

undefined | T

Defined in

webgi/src/core/threejs/CameraController.ts:42

---

getCameraOptions

▸ getCameraOptions(): IPerspectiveCameraOptions | IOrthographicCameraOptions

Returns

IPerspectiveCameraOptions | IOrthographicCameraOptions

Implementation of

ICamera.getCameraOptions

Defined in

webgi/src/core/threejs/CameraController.ts:89

---

setCameraOptions

▸ setCameraOptions<T>(value, setDirty?): void

Type parameters

Name	Type
T	extends Partial<IPerspectiveCameraOptions | IOrthographicCameraOptions>

Parameters

Name	Type	Default value
value	T	undefined
setDirty	boolean	true

Returns

void

Implementation of

ICamera.setCameraOptions

Defined in

webgi/src/core/threejs/CameraController.ts:97

---

setInteractions

▸ setInteractions(enabled, by): void

Parameters

Name	Type
enabled	boolean
by	string

Returns

void

Implementation of

ICamera.setInteractions

Defined in

webgi/src/core/threejs/CameraController.ts:212

---

refreshAspect

▸ refreshAspect(setDirty?): void

Parameters

Name	Type	Default value
setDirty	boolean	true

Returns

void

Defined in

webgi/src/core/threejs/CameraController.ts:324

---

refreshTarget

▸ refreshTarget(distanceFromTarget?): void

Parameters

Name	Type	Default value
distanceFromTarget	number	4

Returns

void

Implementation of

ICamera.refreshTarget

Defined in

webgi/src/core/threejs/CameraController.ts:329

---

setControlsCtor

▸ setControlsCtor(key, ctor, replace?): void

Parameters

Name	Type	Default value
key	string	undefined
ctor	TControlsCtor	undefined
replace	boolean	false

Returns

void

Defined in

webgi/src/core/threejs/CameraController.ts:352

---

removeControlsCtor

▸ removeControlsCtor(key): void

Parameters

Name	Type
key	string

Returns

void

Defined in

webgi/src/core/threejs/CameraController.ts:359

---

refreshCameraControls

▸ refreshCameraControls(setDirty?): void

Parameters

Name	Type	Default value
setDirty	boolean	true

Returns

void

Defined in

webgi/src/core/threejs/CameraController.ts:387

---

setDirty

▸ setDirty(options?): void

Parameters

Name	Type
options?	AnyOptions

Returns

void

Implementation of

ICamera.setDirty

Defined in

webgi/src/core/threejs/CameraController.ts:415

---

activateMain

▸ activateMain(refresh?): void

Parameters

Name	Type	Default value
refresh	boolean	true

Returns

void

Implementation of

ICamera.activateMain

Defined in

webgi/src/core/threejs/CameraController.ts:436

---

deactivateMain

▸ deactivateMain(refresh?): void

Parameters

Name	Type	Default value
refresh	boolean	true

Returns

void

Implementation of

ICamera.deactivateMain

Defined in

webgi/src/core/threejs/CameraController.ts:449

---

dispose

▸ dispose(): void

Returns

void

Implementation of

ICamera.dispose

Defined in

webgi/src/core/threejs/CameraController.ts:560

---

targetUpdated

▸ targetUpdated(setDirty?): void

Parameters

Name	Type	Default value
setDirty	boolean	true

Returns

void

Implementation of

ICamera.targetUpdated

Defined in

webgi/src/core/threejs/CameraController.ts:565

---

positionUpdated

▸ positionUpdated(setDirty?): void

Parameters

Name	Type	Default value
setDirty	boolean	true

Returns

void

Implementation of

ICamera.positionUpdated

Defined in

webgi/src/core/threejs/CameraController.ts:581

---

positionTargetUpdated

▸ positionTargetUpdated(setDirty?): void

deprecated - use positionUpdated instead

Parameters

Name	Type	Default value
setDirty	boolean	true

Returns

void

Defined in

webgi/src/core/threejs/CameraController.ts:591

---

copyFromCamera

▸ copyFromCamera(camera, distanceFromTarget?): void

Parameters

Name	Type	Default value
camera	OrthographicCamera | PerspectiveCamera	undefined
distanceFromTarget	number	4

Returns

void

Defined in

webgi/src/core/threejs/CameraController.ts:595

---

updateShaderProperties

▸ updateShaderProperties(material): CameraController

Parameters

Name	Type
material	Object
material.defines	Record<string, undefined | string | number>
material.uniforms	Object

Returns

CameraController

Implementation of

ICamera.updateShaderProperties

Defined in

webgi/src/core/threejs/CameraController.ts:608

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Implementation of

ICamera.toJSON

Defined in

webgi/src/core/threejs/CameraController.ts:617

---

fromJSON

▸ fromJSON(data, meta?): null | CameraController

Parameters

Name	Type
data	any
meta?	any

Returns

null | CameraController

Implementation of

ICamera.fromJSON

Defined in

webgi/src/core/threejs/CameraController.ts:625

---

refreshCameraOptions

▸ refreshCameraOptions(setDirty?): void

Parameters

Name	Type	Default value
setDirty	boolean	true

Returns

void

Defined in

webgi/src/core/threejs/CameraController.ts:650

---

_nearFarChanged

▸ Protected _nearFarChanged(): void

Returns

void

Defined in

webgi/src/core/threejs/CameraController.ts:238

Properties

autoLookAtTarget

• autoLookAtTarget: boolean = false

Defined in

webgi/src/core/threejs/CameraController.ts:225

---

near

• near: number = 0.01

Implementation of

ICamera.near

Defined in

webgi/src/core/threejs/CameraController.ts:231

---

far

• far: number = 50

Implementation of

ICamera.far

Defined in

webgi/src/core/threejs/CameraController.ts:236

---

uiConfig

• uiConfig: UiObjectConfig<any, string>

Implementation of

ICamera.uiConfig

Defined in

webgi/src/core/threejs/CameraController.ts:535

---

assetType

• assetType: "model"

Implementation of

ICamera.assetType

Defined in

webgi/src/core/threejs/CameraController.ts:558

---

uuid

• Readonly uuid: string

Implementation of

ICamera.uuid

Defined in

webgi/src/core/threejs/CameraController.ts:654

Constructors

constructor

• new CameraController(camera?, options?, domElement?)

Parameters

Name	Type
camera?	OrthographicCamera | PerspectiveCamera
options?	Partial<IPerspectiveCameraOptions | IOrthographicCameraOptions>
domElement?	HTMLElement

Overrides

SimpleEventDispatcher<'update'\>.constructor

Defined in

webgi/src/core/threejs/CameraController.ts:270