API ReferenceGlobalsAdjustableCameraControl3D

# Class: AdjustableCameraControl3D

# Hierarchy

CameraControl3D

AdjustableCameraControl3D

# Implements

# Index

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new AdjustableCameraControl3D(creator: string, inputManager: InputManager, initialCameraPosition?: Vector3, camera?: PerspectiveOffsetCamera): AdjustableCameraControl3D

Inherited from CameraControl3D.constructor

Overrides CameraControl.constructor

Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:65

Parameters:

Name Type
creator string
inputManager InputManager
initialCameraPosition? Vector3
camera? PerspectiveOffsetCamera

Returns: AdjustableCameraControl3D

# Properties

# creator

creator: string

Implementation of Context.creator

Inherited from CameraControl.creator

Defined in packages/common-core/src/cameracontrol/camera-control.ts:77


# maxAzimuthAngle

maxAzimuthAngle: number = Number.POSITIVE_INFINITY

Inherited from CameraControl3D.maxAzimuthAngle

Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:53


# maxDistance

maxDistance: number = 5

Inherited from CameraControl3D.maxDistance

Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:46


# maxPolarAngle

maxPolarAngle: number = toRadiant(MAX_POLAR_ANGLE)

Inherited from CameraControl3D.maxPolarAngle

Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:49


# minAzimuthAngle

minAzimuthAngle: number = Number.NEGATIVE_INFINITY

Inherited from CameraControl3D.minAzimuthAngle

Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:52


# minDistance

minDistance: number = 0

Inherited from CameraControl3D.minDistance

Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:45


# minPolarAngle

minPolarAngle: number = toRadiant(0)

Inherited from CameraControl3D.minPolarAngle

Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:48


# shouldIgnoreStandardBehavior

shouldIgnoreStandardBehavior: boolean = false

Defined in packages/glb-viewer-core/src/camera-control/adjustable-camera-control-3d.ts:5

# Methods

# addEventListener

addEventListener(eventName: number, callback: ListenerFunction‹any›, scope: any): void

Inherited from EventDispatcher.addEventListener

Defined in packages/configurator-core/src/utils/event-dispatcher.ts:29

Parameters:

Name Type
eventName number
callback ListenerFunction‹any›
scope any

Returns: void


# addLightContainer

addLightContainer(container: Object3D): void

Inherited from CameraControl.addLightContainer

Defined in packages/common-core/src/cameracontrol/camera-control.ts:368

Parameters:

Name Type
container Object3D

Returns: void


# adjust

adjust(bounds: Vector3, position: Vector3, yaw: number, pitch: number, _fov: number): void

Defined in packages/glb-viewer-core/src/camera-control/adjustable-camera-control-3d.ts:7

Parameters:

Name Type
bounds Vector3
position Vector3
yaw number
pitch number
_fov number

Returns: void


# animateCamera

animateCamera(delta: number): boolean

Overrides CameraControl3D.animateCamera

Defined in packages/glb-viewer-core/src/camera-control/adjustable-camera-control-3d.ts:31

Parameters:

Name Type
delta number

Returns: boolean


# checkNearFarDistance

checkNearFarDistance(point: Vector3): void

Inherited from CameraControl.checkNearFarDistance

Defined in packages/common-core/src/cameracontrol/camera-control.ts:378

Parameters:

Name Type
point Vector3

Returns: void


# cleanUp

cleanUp(): void

Inherited from CameraControl.cleanUp

Defined in packages/common-core/src/cameracontrol/camera-control.ts:159

Returns: void


# clear

clear(): void

Inherited from CameraControl3D.clear

Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:599

Returns: void


# disableEvents

disableEvents(): void

Inherited from EventDispatcher.disableEvents

Defined in packages/configurator-core/src/utils/event-dispatcher.ts:67

Returns: void


# disablePanning

disablePanning(): void

Inherited from CameraControl3D.disablePanning

Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:617

Returns: void


# dispatchEvent

dispatchEvent(eventName: number, arg?: any): void

Inherited from EventDispatcher.dispatchEvent

Defined in packages/configurator-core/src/utils/event-dispatcher.ts:33

Parameters:

Name Type
eventName number
arg? any

Returns: void


# enableEvents

enableEvents(): void

Inherited from EventDispatcher.enableEvents

Defined in packages/configurator-core/src/utils/event-dispatcher.ts:63

Returns: void


# enablePanning

enablePanning(): void

Inherited from CameraControl3D.enablePanning

Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:612

Returns: void


# getCamera

getCamera(): PerspectiveOffsetCamera

Inherited from CameraControl3D.getCamera

Overrides CameraControl.getCamera

Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:120

Returns: PerspectiveOffsetCamera


# getInputPosition

getInputPosition(position: Position2): Vector3‹›

Inherited from CameraControl.getInputPosition

Defined in packages/common-core/src/cameracontrol/camera-control.ts:361

Parameters:

Name Type
position Position2

Returns: Vector3‹›


# getKernelZoomFactor

getKernelZoomFactor(): number

Inherited from CameraControl3D.getKernelZoomFactor

Overrides CameraControl.getKernelZoomFactor

Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:622

Returns: number


# getObjectRotation

getObjectRotation(): number

Inherited from CameraControl3D.getObjectRotation

Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:143

Returns: number


# getTargetPosition

getTargetPosition(): Vector3

Inherited from CameraControl.getTargetPosition

Defined in packages/common-core/src/cameracontrol/camera-control.ts:351

Returns: Vector3


# hasSavedState

hasSavedState(): boolean

Inherited from CameraControl.hasSavedState

Defined in packages/common-core/src/cameracontrol/camera-control.ts:335

Returns: boolean


# isLocked

isLocked(): boolean

Inherited from CameraControl.isLocked

Defined in packages/common-core/src/cameracontrol/camera-control.ts:347

Returns: boolean


# lock

lock(): void

Inherited from CameraControl.lock

Defined in packages/common-core/src/cameracontrol/camera-control.ts:339

Returns: void


# moveCamera

moveCamera(cameraParameter: CameraParameter): Promise‹void›

Inherited from CameraControl3D.moveCamera

Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:608

Parameters:

Name Type
cameraParameter CameraParameter

Returns: Promise‹void›


# removeEventListener

removeEventListener(eventName: number, fun: ListenerFunction‹any›): void

Inherited from EventDispatcher.removeEventListener

Defined in packages/configurator-core/src/utils/event-dispatcher.ts:49

Parameters:

Name Type
eventName number
fun ListenerFunction‹any›

Returns: void


# reset

reset(bounds: Box3, target?: Vector3, yaw?: number, pitch?: number, animate: boolean): void

Inherited from CameraControl3D.reset

Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:397

Parameters:

Name Type Default
bounds Box3 -
target? Vector3 -
yaw? number -
pitch? number -
animate boolean true

Returns: void


# resetToState

resetToState(): void

Inherited from CameraControl.resetToState

Defined in packages/common-core/src/cameracontrol/camera-control.ts:315

Returns: void


# saveState

saveState(override: boolean): CameraParameter

Inherited from CameraControl.saveState

Defined in packages/common-core/src/cameracontrol/camera-control.ts:289

Parameters:

Name Type
override boolean

Returns: CameraParameter


# setBounds

setBounds(boundingBox: Box3): void

Inherited from CameraControl.setBounds

Defined in packages/common-core/src/cameracontrol/camera-control.ts:389

Parameters:

Name Type
boundingBox Box3

Returns: void


# setObjectRotation

setObjectRotation(objectRotation: number): void

Inherited from CameraControl3D.setObjectRotation

Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:139

Parameters:

Name Type
objectRotation number

Returns: void


# setToState

setToState(start: CameraParameter, state: CameraParameter): void

Inherited from CameraControl.setToState

Defined in packages/common-core/src/cameracontrol/camera-control.ts:331

Parameters:

Name Type
start CameraParameter
state CameraParameter

Returns: void


# unlock

unlock(): void

Inherited from CameraControl.unlock

Defined in packages/common-core/src/cameracontrol/camera-control.ts:343

Returns: void


# updateAndReset

updateAndReset(bounds: Vector3, target?: Vector3, yaw?: number, pitch?: number, spacing?: number, animate: boolean): void

Inherited from CameraControl3D.updateAndReset

Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:448

Parameters:

Name Type Default
bounds Vector3 -
target? Vector3 -
yaw? number -
pitch? number -
spacing? number -
animate boolean true

Returns: void


# updateCamera

updateCamera(): void

Inherited from CameraControl3D.updateCamera

Overrides CameraControl.updateCamera

Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:147

Returns: void


# updateToBounds

updateToBounds(boundingBox: Box3, isPreview: boolean, changeCamera: boolean, target?: Vector3): void

Inherited from CameraControl3D.updateToBounds

Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:303

Parameters:

Name Type Default
boundingBox Box3 -
isPreview boolean -
changeCamera boolean true
target? Vector3 -

Returns: void


# zoomIn

zoomIn(value?: number): void

Inherited from CameraControl3D.zoomIn

Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:583

Parameters:

Name Type
value? number

Returns: void


# zoomOut

zoomOut(value?: number): void

Inherited from CameraControl3D.zoomOut

Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:591

Parameters:

Name Type
value? number

Returns: void


# zoomTo

zoomTo(bounds: Vector3, windowWidth: number, windowHeight: number, yaw: number, pitch: number, target: Vector3): Promise‹void›

Inherited from CameraControl3D.zoomTo

Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:566

Parameters:

Name Type
bounds Vector3
windowWidth number
windowHeight number
yaw number
pitch number
target Vector3

Returns: Promise‹void›


# zoomToFitBounds

zoomToFitBounds(boundingBox: Box3): void

Inherited from CameraControl3D.zoomToFitBounds

Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:279

Parameters:

Name Type
boundingBox Box3

Returns: void