API Reference › Globals › CameraControl2D
# Class: CameraControl2D
# Hierarchy
↳ CameraControl2D
# Implements
# Index
# Constructors
# Properties
# Methods
- addEventListener
- addLightContainer
- animateCamera
- checkNearFarDistance
- cleanUp
- disableEvents
- dispatchEvent
- enableEvents
- getCamera
- getInputPosition
- getTargetPosition
- hasSavedState
- lock
- removeEventListener
- resetToState
- saveState
- setToState
- unlock
- updateCamera
- zoomToFitBounds
# Constructors
# constructor
+ new CameraControl2D(creator: string, inputManager: InputManager, initialCameraPosition?: Vector3): CameraControl2D
Overrides CameraControl.constructor
Defined in packages/common-core/src/cameracontrol/camera-control-2d.ts:26
Parameters:
| Name | Type |
|---|---|
creator | string |
inputManager | InputManager |
initialCameraPosition? | Vector3 |
Returns: CameraControl2D
# Properties
# creator
• creator: string
_Implementation of Context.creator_
_Inherited from CameraControl.creator_
Defined in packages/common-core/src/cameracontrol/camera-control.ts:77
# 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
# animateCamera
▸ animateCamera(delta: number): boolean
Overrides CameraControl.animateCamera
Defined in packages/common-core/src/cameracontrol/camera-control-2d.ts:183
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
# disableEvents
▸ disableEvents(): void
Inherited from EventDispatcher.disableEvents
Defined in packages/configurator-core/src/utils/event-dispatcher.ts:67
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
# getCamera
▸ getCamera(): Camera
Inherited from CameraControl.getCamera
Defined in packages/common-core/src/cameracontrol/camera-control.ts:134
Returns: Camera
# 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‹›
# 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
# 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
# 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
# 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
# updateCamera
▸ updateCamera(): void
Overrides CameraControl.updateCamera
Defined in packages/common-core/src/cameracontrol/camera-control-2d.ts:54
Returns: void
# zoomToFitBounds
▸ zoomToFitBounds(bounds: Box3, zoomInAllowed: boolean): void
Defined in packages/common-core/src/cameracontrol/camera-control-2d.ts:144
Parameters:
| Name | Type |
|---|---|
bounds | Box3 |
zoomInAllowed | boolean |
Returns: void