Skip to main content

Class: CameraController

Core-API.CameraController

Hierarchy

  • SimpleEventDispatcher<"update">

    CameraController

Implements

Accessors

controls

get controls(): undefined | TCameraControls

Returns

undefined | TCameraControls

Implementation of

ICamera.controls

Defined in

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


userData

get userData(): any

Returns

any

Implementation of

ICamera.userData

Defined in

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

set userData(value): void

Parameters

NameType
valueany

Returns

void

Implementation of

ICamera.userData

Defined in

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


isActiveCamera

get isActiveCamera(): boolean

Returns

boolean

Implementation of

ICamera.isActiveCamera

Defined in

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


target

get target(): Vector3

Returns

Vector3

Implementation of

ICamera.target

Defined in

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

set target(target): void

Parameters

NameType
targetVector3

Returns

void

Implementation of

ICamera.target

Defined in

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


position

get position(): Vector3

Returns

Vector3

Implementation of

ICamera.position

Defined in

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

set position(position): void

Parameters

NameType
positionVector3

Returns

void

Implementation of

ICamera.position

Defined in

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


name

get name(): string

Returns

string

Implementation of

ICamera.name

Defined in

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

set name(name): void

Parameters

NameType
namestring

Returns

void

Implementation of

ICamera.name

Defined in

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


interactionsEnabled

get interactionsEnabled(): boolean

Returns

boolean

Implementation of

ICamera.interactionsEnabled

Defined in

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

set interactionsEnabled(value): void

Parameters

NameType
valueboolean

Returns

void

Implementation of

ICamera.interactionsEnabled

Defined in

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


cameraObject

get cameraObject(): OrthographicCamera | PerspectiveCamera

Returns

OrthographicCamera | PerspectiveCamera

Implementation of

ICamera.cameraObject

Defined in

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


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:434


visible

get visible(): boolean

Returns

boolean

Implementation of

ICamera.visible

Defined in

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

set visible(value): void

Parameters

NameType
valueboolean

Returns

void

Implementation of

ICamera.visible

Defined in

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

Methods

getControls

getControls<T>(): undefined | T

Type parameters

NameType
Textends ICameraControls<string, T>

Returns

undefined | T

Defined in

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


getCameraOptions

getCameraOptions(): IPerspectiveCameraOptions | IOrthographicCameraOptions

Returns

IPerspectiveCameraOptions | IOrthographicCameraOptions

Implementation of

ICamera.getCameraOptions

Defined in

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


setCameraOptions

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

Type parameters

NameType
Textends Partial<IPerspectiveCameraOptions | IOrthographicCameraOptions>

Parameters

NameTypeDefault value
valueTundefined
setDirtybooleantrue

Returns

void

Implementation of

ICamera.setCameraOptions

Defined in

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


refreshAspect

refreshAspect(setDirty?): void

Parameters

NameTypeDefault value
setDirtybooleantrue

Returns

void

Defined in

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


refreshTarget

refreshTarget(distanceFromTarget?): void

Parameters

NameTypeDefault value
distanceFromTargetnumber4

Returns

void

Implementation of

ICamera.refreshTarget

Defined in

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


setControlsCtor

setControlsCtor(key, ctor, replace?): void

Parameters

NameTypeDefault value
keystringundefined
ctorTControlsCtorundefined
replacebooleanfalse

Returns

void

Defined in

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


removeControlsCtor

removeControlsCtor(key): void

Parameters

NameType
keystring

Returns

void

Defined in

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


refreshCameraControls

refreshCameraControls(setDirty?): void

Parameters

NameTypeDefault value
setDirtybooleantrue

Returns

void

Defined in

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


setDirty

setDirty(options?): void

Parameters

NameType
options?AnyOptions

Returns

void

Implementation of

ICamera.setDirty

Defined in

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


activateMain

activateMain(refresh?): void

Parameters

NameTypeDefault value
refreshbooleantrue

Returns

void

Implementation of

ICamera.activateMain

Defined in

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


deactivateMain

deactivateMain(refresh?): void

Parameters

NameTypeDefault value
refreshbooleantrue

Returns

void

Implementation of

ICamera.deactivateMain

Defined in

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


dispose

dispose(): void

Returns

void

Implementation of

ICamera.dispose

Defined in

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


targetUpdated

targetUpdated(setDirty?): void

Parameters

NameTypeDefault value
setDirtybooleantrue

Returns

void

Implementation of

ICamera.targetUpdated

Defined in

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


positionUpdated

positionUpdated(setDirty?): void

Parameters

NameTypeDefault value
setDirtybooleantrue

Returns

void

Implementation of

ICamera.positionUpdated

Defined in

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


positionTargetUpdated

positionTargetUpdated(setDirty?): void

deprecated - use positionUpdated instead

Parameters

NameTypeDefault value
setDirtybooleantrue

Returns

void

Defined in

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


copyFromCamera

copyFromCamera(camera, distanceFromTarget?): void

Parameters

NameTypeDefault value
cameraOrthographicCamera | PerspectiveCameraundefined
distanceFromTargetnumber4

Returns

void

Defined in

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


updateShaderProperties

updateShaderProperties(material): CameraController

Parameters

NameType
materialObject
material.definesRecord<string, undefined | string | number>
material.uniformsObject

Returns

CameraController

Implementation of

ICamera.updateShaderProperties

Defined in

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


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Implementation of

ICamera.toJSON

Defined in

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


fromJSON

fromJSON(data, meta?): null | CameraController

Parameters

NameType
dataany
meta?any

Returns

null | CameraController

Implementation of

ICamera.fromJSON

Defined in

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


refreshCameraOptions

refreshCameraOptions(setDirty?): void

Parameters

NameTypeDefault value
setDirtybooleantrue

Returns

void

Defined in

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


_nearFarChanged

Protected _nearFarChanged(): void

Returns

void

Defined in

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

Properties

autoLookAtTarget

autoLookAtTarget: boolean = false

Defined in

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


near

near: number = 0.01

Implementation of

ICamera.near

Defined in

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


far

far: number = 50

Implementation of

ICamera.far

Defined in

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


uiConfig

uiConfig: UiObjectConfig<any, string>

Implementation of

ICamera.uiConfig

Defined in

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


assetType

assetType: "model"

Implementation of

ICamera.assetType

Defined in

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


uuid

Readonly uuid: string

Implementation of

ICamera.uuid

Defined in

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

Constructors

constructor

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

Parameters

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

Overrides

SimpleEventDispatcher<'update'\>.constructor

Defined in

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