API Reference › Globals › AdjustableCameraControl3D
# Class: AdjustableCameraControl3D
# Hierarchy
↳ AdjustableCameraControl3D
# Implements
# Index
# Constructors
# Properties
- creator
- maxAzimuthAngle
- maxDistance
- maxPolarAngle
- minAzimuthAngle
- minDistance
- minPolarAngle
- shouldIgnoreStandardBehavior
# Methods
- addEventListener
- addLightContainer
- adjust
- animateCamera
- checkNearFarDistance
- cleanUp
- clear
- disableEvents
- disablePanning
- dispatchEvent
- enableEvents
- enablePanning
- getCamera
- getInputPosition
- getObjectRotation
- getTargetPosition
- hasSavedState
- lock
- moveCamera
- removeEventListener
- reset
- resetToState
- saveState
- setBounds
- setObjectRotation
- setToState
- unlock
- updateAndReset
- updateCamera
- updateToBounds
- zoomIn
- zoomOut
- zoomTo
- zoomToFitBounds
# 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:54
# maxDistance
• maxDistance: number = 5
Inherited from CameraControl3D.maxDistance
Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:47
# maxPolarAngle
• maxPolarAngle: number = toRadiant(MAX_POLAR_ANGLE)
Inherited from CameraControl3D.maxPolarAngle
Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:50
# minAzimuthAngle
• minAzimuthAngle: number = Number.NEGATIVE_INFINITY
Inherited from CameraControl3D.minAzimuthAngle
Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:53
# minDistance
• minDistance: number = 0
Inherited from CameraControl3D.minDistance
Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:46
# minPolarAngle
• minPolarAngle: number = toRadiant(0)
Inherited from CameraControl3D.minPolarAngle
Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:49
# 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:362
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:372
Parameters:
| Name | Type |
|---|---|
point | Vector3 |
Returns: void
# cleanUp
▸ cleanUp(): void
Inherited from CameraControl.cleanUp
Defined in packages/common-core/src/cameracontrol/camera-control.ts:157
Returns: void
# clear
▸ clear(): void
Inherited from CameraControl3D.clear
Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:593
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:610
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:605
Returns: void
# getCamera
▸ getCamera(): PerspectiveOffsetCamera
Inherited from CameraControl3D.getCamera
Overrides CameraControl.getCamera
Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:119
Returns: PerspectiveOffsetCamera
# getInputPosition
▸ getInputPosition(position: Position2): Vector3‹›
Inherited from CameraControl.getInputPosition
Defined in packages/common-core/src/cameracontrol/camera-control.ts:355
Parameters:
| Name | Type |
|---|---|
position | Position2 |
Returns: Vector3‹›
# getObjectRotation
▸ getObjectRotation(): number
Inherited from CameraControl3D.getObjectRotation
Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:142
Returns: number
# getTargetPosition
▸ getTargetPosition(): Vector3
Inherited from CameraControl.getTargetPosition
Defined in packages/common-core/src/cameracontrol/camera-control.ts:345
Returns: Vector3
# hasSavedState
▸ hasSavedState(): boolean
Inherited from CameraControl.hasSavedState
Defined in packages/common-core/src/cameracontrol/camera-control.ts:333
Returns: boolean
# lock
▸ lock(): void
Inherited from CameraControl.lock
Defined in packages/common-core/src/cameracontrol/camera-control.ts:337
Returns: void
# moveCamera
▸ moveCamera(cameraParameter: CameraParameter): Promise‹void›
Inherited from CameraControl3D.moveCamera
Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:601
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:394
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:313
Returns: void
# saveState
▸ saveState(override: boolean): CameraParameter
Inherited from CameraControl.saveState
Defined in packages/common-core/src/cameracontrol/camera-control.ts:287
Parameters:
| Name | Type |
|---|---|
override | boolean |
Returns: CameraParameter
# setBounds
▸ setBounds(boundingBox: Box3): void
Inherited from CameraControl3D.setBounds
Defined in packages/common-core/src/cameracontrol/camera-control-3d.ts:277
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:138
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:329
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:341
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:445
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:146
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:301
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:577
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:585
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:560
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:281
Parameters:
| Name | Type |
|---|---|
boundingBox | Box3 |
Returns: void