Documentation

planner-core/src/roomle-planner..default

# Hierarchy

default

↳ default

# Table of contents

# Methods

# Constructors

# constructor

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

# Parameters

Name	Type
`creator`	`string`
`inputManager`	`default`
`initialCameraPosition?`	`Vector3`
`camera?`	`OrthographicOffsetCamera`

# Overrides

default.constructor

# Properties

# _creator_

• _creator_: string

# Inherited from

default.creator

# 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

# animateCamera

▸ animateCamera(delta): boolean

# Parameters

Name	Type
`delta`	`number`

# Returns

boolean

# Overrides

default.animateCamera

# checkNearFarDistance

▸ checkNearFarDistance(point): void

# Parameters

Name	Type
`point`	`Vector3`

# Returns

void

# Inherited from

default.checkNearFarDistance

# cleanUp

▸ cleanUp(): void

# Returns

void

# Inherited from

default.cleanUp

# disableEvents

▸ disableEvents(): void

# Returns

void

# Inherited from

default.disableEvents

# 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

# getCamera

▸ getCamera(): PerspectiveOrOrthographicCamera

# Returns

PerspectiveOrOrthographicCamera

# Inherited from

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

# 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

# removeEventListener

▸ removeEventListener(eventName, fun): void

# Parameters

Name	Type
`eventName`	`number`
`fun`	`ListenerFunction`<`any`>

# Returns

void

# Inherited from

default.removeEventListener

# 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

# setToState

▸ setToState(start, state): void

# Parameters

Name	Type
`start`	`CameraParameter`
`state`	`CameraParameter`

# Returns

void

# Inherited from

default.setToState

# unlock

▸ unlock(): void

# Returns

void

# Inherited from

default.unlock

# updateCamera

▸ updateCamera(): void

# Returns

void

# Overrides

default.updateCamera

# zoomToFitBounds

▸ zoomToFitBounds(bounds, zoomInAllowed, force?): void

# Parameters

Name	Type
`bounds`	`Box3`
`zoomInAllowed`	`boolean`
`force?`	`boolean`

# Returns

void