RoomleConfigurator.Internal.default-35

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

Hierarchy

• default

  ↳ default

  ↳↳ default

Table of contents

Constructors

• constructor

Properties

• _creator_

• maxAzimuthAngle

• maxDistance

• maxPolarAngle

• minAzimuthAngle

• minDistance

• minPolarAngle

Accessors

• domHelper

Methods

• addEventListener

• addLightContainer

• adjustToBoundsWithoutChangingDistance

• animateCamera

• checkBoundsAndPlaceCamera

• checkNearFarDistance

• cleanUp

• clear

• disableEvents

• disablePanning

• dispatchEvent

• enableEvents

• enablePanning

• getCamera

• getCurrentCameraParameters

• getInputPosition

• getKernelZoomFactor

• getObjectRotation

• getTargetPosition

• hasSavedState

• isLocked

• lock

• moveCamera

• removeEventListener

• reset

• resetToState

• saveState

• setBounds

• setCurrentCameraParameters

• setObjectRotation

• setToState

• setUp

• unlock

• updateAndReset

• updateCamera

• updateDistanceAndRangesBasedOnBounds

• updateToBounds

• zoomIn

• zoomOut

• zoomTo

• zoomToFitBounds

Constructors

constructor

• new default(creator, inputManager, initialCameraParameters?, camera?)

Parameters

Name	Type
creator	string
inputManager	default
initialCameraParameters?	CameraParameter
camera?	PerspectiveOffsetCamera

Overrides

default.constructor

Properties

_creator_

• _creator_: string

Inherited from

default.creator

---

maxAzimuthAngle

• maxAzimuthAngle: number = Number.POSITIVE_INFINITY

---

maxDistance

• maxDistance: number = 5

---

maxPolarAngle

• maxPolarAngle: number

---

minAzimuthAngle

• minAzimuthAngle: number = Number.NEGATIVE_INFINITY

---

minDistance

• minDistance: number = 0

---

minPolarAngle

• minPolarAngle: number

Accessors

domHelper

• get domHelper(): default

Returns

default

Inherited from

CameraControl.domHelper

Methods

addEventListener

▸ addEventListener(eventName, callback, scope): void

Parameters

Name	Type
eventName	number
callback	ListenerFunction<any>
scope	any

Returns

void

Inherited from

default.addEventListener

---

addLightContainer

▸ addLightContainer(container): void

Parameters

Name	Type
container	Object3D<Object3DEventMap>

Returns

void

Inherited from

default.addLightContainer

---

adjustToBoundsWithoutChangingDistance

▸ adjustToBoundsWithoutChangingDistance(boundingBox): void

Parameters

Name	Type
boundingBox	Box3

Returns

void

---

animateCamera

▸ animateCamera(delta): boolean

Parameters

Name	Type
delta	number

Returns

boolean

Overrides

default.animateCamera

---

checkBoundsAndPlaceCamera

▸ checkBoundsAndPlaceCamera(boundingBox, reset?): void

Parameters

Name	Type	Default value
boundingBox	Box3	undefined
reset	boolean	true

Returns

void

---

checkNearFarDistance

▸ checkNearFarDistance(point): void

Parameters

Name	Type
point	Vector3

Returns

void

Inherited from

default.checkNearFarDistance

---

cleanUp

▸ cleanUp(): void

Returns

void

Inherited from

default.cleanUp

---

clear

▸ clear(): void

Returns

void

---

disableEvents

▸ disableEvents(): void

Returns

void

Inherited from

default.disableEvents

---

disablePanning

▸ disablePanning(): void

Returns

void

---

dispatchEvent

▸ dispatchEvent(eventName, arg?): void

Parameters

Name	Type
eventName	number
arg?	any

Returns

void

Inherited from

default.dispatchEvent

---

enableEvents

▸ enableEvents(): void

Returns

void

Inherited from

default.enableEvents

---

enablePanning

▸ enablePanning(): void

Returns

void

---

getCamera

▸ getCamera(): PerspectiveOffsetCamera

Returns

PerspectiveOffsetCamera

Overrides

default.getCamera

---

getCurrentCameraParameters

▸ getCurrentCameraParameters(): CameraParameter

Returns

CameraParameter

Inherited from

default.getCurrentCameraParameters

---

getInputPosition

▸ getInputPosition(position): Vector3

Parameters

Name	Type
position	Position2

Returns

Vector3

Inherited from

default.getInputPosition

---

getKernelZoomFactor

▸ getKernelZoomFactor(): number

Returns

number

Overrides

default.getKernelZoomFactor

---

getObjectRotation

▸ getObjectRotation(): number

Returns

number

---

getTargetPosition

▸ getTargetPosition(): Vector3

Returns

Vector3

Inherited from

default.getTargetPosition

---

hasSavedState

▸ hasSavedState(): boolean

Returns

boolean

Inherited from

default.hasSavedState

---

isLocked

▸ isLocked(): boolean

Returns

boolean

Inherited from

default.isLocked

---

lock

▸ lock(): void

Returns

void

Inherited from

default.lock

---

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>

---

removeEventListener

▸ removeEventListener(eventName, fun): void

Parameters

Name	Type
eventName	number
fun	ListenerFunction<any>

Returns

void

Inherited from

default.removeEventListener

---

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

---

resetToState

▸ resetToState(): void

Returns

void

Inherited from

default.resetToState

---

saveState

▸ saveState(override): CameraParameter

Parameters

Name	Type
override	boolean

Returns

CameraParameter

Inherited from

default.saveState

---

setBounds

▸ setBounds(boundingBox): void

Parameters

Name	Type
boundingBox	Box3

Returns

void

Inherited from

default.setBounds

---

setCurrentCameraParameters

▸ setCurrentCameraParameters(cameraParameters): void

Parameters

Name	Type
cameraParameters	CameraParameter

Returns

void

Inherited from

default.setCurrentCameraParameters

---

setObjectRotation

▸ setObjectRotation(objectRotation): void

Parameters

Name	Type
objectRotation	number

Returns

void

---

setToState

▸ setToState(start, state): Promise<void>

Parameters

Name	Type
start	CameraParameter
state	CameraParameter

Returns

Promise<void>

Inherited from

default.setToState

---

setUp

▸ setUp(): void

Returns

void

Inherited from

default.setUp

---

unlock

▸ unlock(): void

Returns

void

Inherited from

default.unlock

---

updateAndReset

▸ updateAndReset(boundingBox, animate?): Promise<void>

Parameters

Name	Type	Default value
boundingBox	Box3	undefined
animate	boolean	true

Returns

Promise<void>

---

updateCamera

▸ updateCamera(): void

Returns

void

Overrides

default.updateCamera

---

updateDistanceAndRangesBasedOnBounds

▸ updateDistanceAndRangesBasedOnBounds(boundingBox): void

Parameters

Name	Type
boundingBox	Box3

Returns

void

---

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

---

zoomIn

▸ zoomIn(value?): void

Parameters

Name	Type
value?	number

Returns

void

---

zoomOut

▸ zoomOut(value?): void

Parameters

Name	Type
value?	number

Returns

void

---

zoomTo

▸ zoomTo(cameraParameters): Promise<void>

Parameters

Name	Type
cameraParameters	CameraParameter

Returns

Promise<void>

---

zoomToFitBounds

▸ zoomToFitBounds(boundingBox, reset?): void

Parameters

Name	Type	Default value
boundingBox	Box3	undefined
reset	boolean	true

Returns

void