Class: CameraController<TE>

Core-API.CameraController

Type parameters

Name	Type
TE	extends CameraControllerEventMap = CameraControllerEventMap

Hierarchy

• EventDispatcher<TE & CameraControllerEventMap>

  ↳ CameraController

Implements

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

Accessors

controls

• get controls(): undefined | TCameraControls

Returns

undefined | TCameraControls

Implementation of

ICamera.controls

---

userData

• get userData(): any

Returns

any

Implementation of

ICamera.userData

• set userData(value): void

Parameters

Name	Type
value	any

Returns

void

Implementation of

ICamera.userData

---

isActiveCamera

• get isActiveCamera(): boolean

Returns

boolean

Implementation of

ICamera.isActiveCamera

---

target

• get target(): Vector3

Returns

Vector3

Implementation of

ICamera.target

• set target(target): void

Parameters

Name	Type
target	Vector3

Returns

void

Implementation of

ICamera.target

---

position

• get position(): Vector3

Returns

Vector3

Implementation of

ICamera.position

• set position(position): void

Parameters

Name	Type
position	Vector3

Returns

void

Implementation of

ICamera.position

---

name

• get name(): string

Returns

string

Implementation of

ICamera.name

• set name(name): void

Parameters

Name	Type
name	string

Returns

void

Implementation of

ICamera.name

---

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

• 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

---

cameraObject

• get cameraObject(): OrthographicCamera<Object3DEventMap> | PerspectiveCamera<Object3DEventMap>

Returns

OrthographicCamera<Object3DEventMap> | PerspectiveCamera<Object3DEventMap>

Implementation of

ICamera.cameraObject

---

modelObject

• get modelObject(): OrthographicCamera<Object3DEventMap> | PerspectiveCamera<Object3DEventMap>

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

Returns

OrthographicCamera<Object3DEventMap> | PerspectiveCamera<Object3DEventMap>

Implementation of

ICamera.modelObject

---

visible

• get visible(): boolean

Returns

boolean

Implementation of

ICamera.visible

• set visible(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

ICamera.visible

Methods

getControls

▸ getControls<T>(): undefined | T

Type parameters

Name	Type
T	extends ICameraControls<{ change: {} }, T>

Returns

undefined | T

---

getCameraOptions

▸ getCameraOptions(): IPerspectiveCameraOptions | IOrthographicCameraOptions

Returns

IPerspectiveCameraOptions | IOrthographicCameraOptions

Implementation of

ICamera.getCameraOptions

---

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

---

setInteractions

▸ setInteractions(enabled, by): void

Parameters

Name	Type
enabled	boolean
by	string

Returns

void

Implementation of

ICamera.setInteractions

---

refreshAspect

▸ refreshAspect(setDirty?): void

Parameters

Name	Type	Default value
setDirty	boolean	true

Returns

void

---

refreshTarget

▸ refreshTarget(distanceFromTarget?): void

Parameters

Name	Type	Default value
distanceFromTarget	number	4

Returns

void

Implementation of

ICamera.refreshTarget

---

setControlsCtor

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

Parameters

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

Returns

void

---

removeControlsCtor

▸ removeControlsCtor(key): void

Parameters

Name	Type
key	string

Returns

void

---

refreshCameraControls

▸ refreshCameraControls(setDirty?): void

Parameters

Name	Type	Default value
setDirty	boolean	true

Returns

void

---

setDirty

▸ setDirty(options?): void

Parameters

Name	Type
options?	AnyOptions

Returns

void

Implementation of

ICamera.setDirty

---

activateMain

▸ activateMain(refresh?): void

Parameters

Name	Type	Default value
refresh	boolean	true

Returns

void

Implementation of

ICamera.activateMain

---

deactivateMain

▸ deactivateMain(refresh?): void

Parameters

Name	Type	Default value
refresh	boolean	true

Returns

void

Implementation of

ICamera.deactivateMain

---

dispose

▸ dispose(): void

Returns

void

Implementation of

ICamera.dispose

---

getFittingDistance

▸ getFittingDistance(box): number

Find distance of camera at which the camera's fov fits the given bounding box dimensions

Parameters

Name	Type
box	Box3B

Returns

number

---

targetUpdated

▸ targetUpdated(setDirty?): void

Parameters

Name	Type	Default value
setDirty	boolean	true

Returns

void

Implementation of

ICamera.targetUpdated

---

positionUpdated

▸ positionUpdated(setDirty?): void

Parameters

Name	Type	Default value
setDirty	boolean	true

Returns

void

Implementation of

ICamera.positionUpdated

---

positionTargetUpdated

▸ positionTargetUpdated(setDirty?): void

deprecated - use positionUpdated instead

Parameters

Name	Type	Default value
setDirty	boolean	true

Returns

void

---

copyFromCamera

▸ copyFromCamera(camera, distanceFromTarget?): void

Parameters

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

Returns

void

---

updateShaderProperties

▸ updateShaderProperties(material): CameraController<TE>

Parameters

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

Returns

CameraController<TE>

Implementation of

ICamera.updateShaderProperties

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

---

fromJSON

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

Parameters

Name	Type
data	any
meta?	any

Returns

null | CameraController<TE>

---

refreshCameraOptions

▸ refreshCameraOptions(setDirty?): void

Parameters

Name	Type	Default value
setDirty	boolean	true

Returns

void

---

_nearFarChanged

▸ Protected _nearFarChanged(): void

Returns

void

Properties

autoLookAtTarget

• autoLookAtTarget: boolean = false

---

near

• near: number = 0.01

Implementation of

ICamera.near

---

far

• far: number = 50

Implementation of

ICamera.far

---

uiConfig

• uiConfig: UiObjectConfig<any, string>

Implementation of

ICamera.uiConfig

---

assetType

• assetType: "model"

Implementation of

ICamera.assetType

---

uuid

• Readonly uuid: string

Implementation of

ICamera.uuid

Constructors

constructor

• new CameraController<TE>(camera?, options?, domElement?)

Type parameters

Name	Type
TE	extends CameraControllerEventMap = CameraControllerEventMap

Parameters

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

Overrides

EventDispatcher<TE&CameraControllerEventMap\>.constructor