# Class: default

configurator-core/src/roomle-configurator..default

# Hierarchy

# Table of contents

# Constructors

# Properties

# Accessors

# Methods

# Constructors

# constructor

new default(creator, inputManager, initialCameraPosition?, camera?)

# Parameters

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

# Overrides

default.constructor

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:83 (opens new window)

# Properties

# _creator_

_creator_: string

# Inherited from

default.creator

# Defined in

packages/common-core/src/cameracontrol/camera-control.ts:87 (opens new window)


# maxAzimuthAngle

maxAzimuthAngle: number = Number.POSITIVE_INFINITY

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:69 (opens new window)


# maxDistance

maxDistance: number = 5

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:62 (opens new window)


# maxPolarAngle

maxPolarAngle: number

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:65 (opens new window)


# minAzimuthAngle

minAzimuthAngle: number = Number.NEGATIVE_INFINITY

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:68 (opens new window)


# minDistance

minDistance: number = 0

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:61 (opens new window)


# minPolarAngle

minPolarAngle: number

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:64 (opens new window)

# Accessors

# domHelper

get domHelper(): default

# Returns

default

# Inherited from

CameraControl.domHelper

# Defined in

packages/common-core/src/cameracontrol/camera-control.ts:455 (opens new window)

# Methods

# addEventListener

addEventListener(eventName, callback, scope): void

# Parameters

Name Type
eventName number
callback ListenerFunction<any>
scope any

# Returns

void

# Inherited from

default.addEventListener

# Defined in

packages/configurator-core/src/utils/event-dispatcher.ts:32 (opens new window)


# addLightContainer

addLightContainer(container): void

# Parameters

Name Type
container Object3D<Object3DEventMap>

# Returns

void

# Inherited from

default.addLightContainer

# Defined in

packages/common-core/src/cameracontrol/camera-control.ts:428 (opens new window)


# adjustToBoundsWithoutChangingDistance

adjustToBoundsWithoutChangingDistance(boundingBox): void

# Parameters

Name Type
boundingBox Box3

# Returns

void

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:348 (opens new window)


# animateCamera

animateCamera(delta): boolean

# Parameters

Name Type
delta number

# Returns

boolean

# Overrides

default.animateCamera

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:187 (opens new window)


# checkBoundsAndPlaceCamera

checkBoundsAndPlaceCamera(boundingBox, reset?): void

# Parameters

Name Type Default value
boundingBox Box3 undefined
reset boolean true

# Returns

void

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:336 (opens new window)


# checkNearFarDistance

checkNearFarDistance(point): void

# Parameters

Name Type
point Vector3

# Returns

void

# Inherited from

default.checkNearFarDistance

# Defined in

packages/common-core/src/cameracontrol/camera-control.ts:440 (opens new window)


# cleanUp

cleanUp(): void

# Returns

void

# Inherited from

default.cleanUp

# Defined in

packages/common-core/src/cameracontrol/camera-control.ts:180 (opens new window)


# clear

clear(): void

# Returns

void

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:768 (opens new window)


# disableEvents

disableEvents(): void

# Returns

void

# Inherited from

default.disableEvents

# Defined in

packages/configurator-core/src/utils/event-dispatcher.ts:73 (opens new window)


# disablePanning

disablePanning(): void

# Returns

void

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:808 (opens new window)


# dispatchEvent

dispatchEvent(eventName, arg?): void

# Parameters

Name Type
eventName number
arg? any

# Returns

void

# Inherited from

default.dispatchEvent

# Defined in

packages/configurator-core/src/utils/event-dispatcher.ts:40 (opens new window)


# enableEvents

enableEvents(): void

# Returns

void

# Inherited from

default.enableEvents

# Defined in

packages/configurator-core/src/utils/event-dispatcher.ts:69 (opens new window)


# enablePanning

enablePanning(): void

# Returns

void

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:803 (opens new window)


# getCamera

getCamera(): PerspectiveOffsetCamera

# Returns

PerspectiveOffsetCamera

# Overrides

default.getCamera

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:153 (opens new window)


# getCurrentCameraParameters

getCurrentCameraParameters(): CameraParameter

# Returns

CameraParameter

# Inherited from

default.getCurrentCameraParameters

# Defined in

packages/common-core/src/cameracontrol/camera-control.ts:298 (opens new window)


# getInputPosition

getInputPosition(position): Vector3

# Parameters

Name Type
position Position2

# Returns

Vector3

# Inherited from

default.getInputPosition

# Defined in

packages/common-core/src/cameracontrol/camera-control.ts:419 (opens new window)


# getKernelZoomFactor

getKernelZoomFactor(): number

# Returns

number

# Overrides

default.getKernelZoomFactor

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:813 (opens new window)


# getObjectRotation

getObjectRotation(): number

# Returns

number

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:177 (opens new window)


# getTargetPosition

getTargetPosition(): Vector3

# Returns

Vector3

# Inherited from

default.getTargetPosition

# Defined in

packages/common-core/src/cameracontrol/camera-control.ts:409 (opens new window)


# hasSavedState

hasSavedState(): boolean

# Returns

boolean

# Inherited from

default.hasSavedState

# Defined in

packages/common-core/src/cameracontrol/camera-control.ts:393 (opens new window)


# isLocked

isLocked(): boolean

# Returns

boolean

# Inherited from

default.isLocked

# Defined in

packages/common-core/src/cameracontrol/camera-control.ts:405 (opens new window)


# lock

lock(): void

# Returns

void

# Inherited from

default.lock

# Defined in

packages/common-core/src/cameracontrol/camera-control.ts:397 (opens new window)


# moveCamera

moveCamera(cameraParameter): Promise<void>

Move camera based on provided camera parameters

  • Uses center when target is not set
  • Uses ideal distance when no distance is provided
  • For other properties it used current camera parameters if not provided

# Parameters

Name Type
cameraParameter CameraParameter

# Returns

Promise<void>

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:784 (opens new window)


# removeEventListener

removeEventListener(eventName, fun): void

# Parameters

Name Type
eventName number
fun ListenerFunction<any>

# Returns

void

# Inherited from

default.removeEventListener

# Defined in

packages/configurator-core/src/utils/event-dispatcher.ts:55 (opens new window)


# reset

reset(bounds, target?, yaw?, pitch?, animate?): void

# Parameters

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

# Returns

void

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:546 (opens new window)


# resetToState

resetToState(): void

# Returns

void

# Inherited from

default.resetToState

# Defined in

packages/common-core/src/cameracontrol/camera-control.ts:369 (opens new window)


# saveState

saveState(override): CameraParameter

# Parameters

Name Type
override boolean

# Returns

CameraParameter

# Inherited from

default.saveState

# Defined in

packages/common-core/src/cameracontrol/camera-control.ts:343 (opens new window)


# setBounds

setBounds(boundingBox): void

# Parameters

Name Type
boundingBox Box3

# Returns

void

# Inherited from

default.setBounds

# Defined in

packages/common-core/src/cameracontrol/camera-control.ts:451 (opens new window)


# setObjectRotation

setObjectRotation(objectRotation): void

# Parameters

Name Type
objectRotation number

# Returns

void

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:173 (opens new window)


# setToState

setToState(start, state): void

# Parameters

Name Type
start CameraParameter
state CameraParameter

# Returns

void

# Inherited from

default.setToState

# Defined in

packages/common-core/src/cameracontrol/camera-control.ts:389 (opens new window)


# unlock

unlock(): void

# Returns

void

# Inherited from

default.unlock

# Defined in

packages/common-core/src/cameracontrol/camera-control.ts:401 (opens new window)


# updateAndReset

updateAndReset(boundingBox, animate?): void

# Parameters

Name Type Default value
boundingBox Box3 undefined
animate boolean true

# Returns

void

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:607 (opens new window)


# updateCamera

updateCamera(): void

# Returns

void

# Overrides

default.updateCamera

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:181 (opens new window)


# updateToBounds

updateToBounds(boundingBox, isPreview, changeCamera?, target?): void

# Parameters

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

# Returns

void

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:403 (opens new window)


# zoomIn

zoomIn(value?): void

# Parameters

Name Type
value? number

# Returns

void

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:752 (opens new window)


# zoomOut

zoomOut(value?): void

# Parameters

Name Type
value? number

# Returns

void

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:760 (opens new window)


# zoomTo

zoomTo(cameraParameters): Promise<void>

# Parameters

Name Type
cameraParameters CameraParameter

# Returns

Promise<void>

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:737 (opens new window)


# zoomToFitBounds

zoomToFitBounds(boundingBox, reset?): void

# Parameters

Name Type Default value
boundingBox Box3 undefined
reset boolean true

# Returns

void

# Defined in

packages/common-core/src/cameracontrol/camera-control-3d.ts:375 (opens new window)