RoomlePlanner.Internal.default-15

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

Hierarchy

• default

  ↳ default

Table of contents

Constructors

• constructor

Methods

• addChildEntityComponent

• addMesh

• addRootComponent

• clear

• clearReference

• deselect

• failConstruction

• finishConstruction

• getBoundingBox

• getBounds

• getConfigurationRuntimeId

• getConstructionElementMeasurements

• getContainer

• getId

• getKernelObject

• getMesh

• getName

• getObject

• getObjectAsync

• getObjectMeasurements

• getPlanElement

• getPlanObject

• getPosition

• getRootComponentId

• getRootComponentRuntimeId

• getRotation

• getSize

• getTopViewContainer

• hidePreviewBox

• hoverOff

• hoverOn

• isInitDone

• remove

• select

• setObject

• setRapiItem

• setTopView

• toJSON

• update

Constructors

constructor

• new default(planObject)

Parameters

Name	Type
planObject	PlanObject

Overrides

default.constructor

Methods

addChildEntityComponent

▸ addChildEntityComponent(component): void

Parameters

Name	Type
component	RoomleComponent

Returns

void

Inherited from

default.addChildEntityComponent

---

addMesh

▸ addMesh(mesh): void

Parameters

Name	Type
mesh	Object3D<Object3DEventMap>

Returns

void

Inherited from

default.addMesh

---

addRootComponent

▸ addRootComponent(component): void

Parameters

Name	Type
component	RoomleComponent

Returns

void

Inherited from

default.addRootComponent

---

clear

▸ clear(): void

Returns

void

Inherited from

default.clear

---

clearReference

▸ clearReference(): void

Returns

void

Inherited from

default.clearReference

---

deselect

▸ deselect(): void

Returns

void

Inherited from

default.deselect

---

failConstruction

▸ failConstruction(): Promise<void>

Returns

Promise<void>

Inherited from

default.failConstruction

---

finishConstruction

▸ finishConstruction(): Promise<void>

Returns

Promise<void>

Inherited from

default.finishConstruction

---

getBoundingBox

▸ getBoundingBox(): RoomleEventedMesh

Returns

RoomleEventedMesh

Inherited from

default.getBoundingBox

---

getBounds

▸ getBounds(): Box3

Returns

Box3

Inherited from

default.getBounds

---

getConfigurationRuntimeId

▸ getConfigurationRuntimeId(): number

Returns

number

Inherited from

default.getConfigurationRuntimeId

---

getConstructionElementMeasurements

▸ getConstructionElementMeasurements(zoomFactor, clientWidth, clientHeight): ConstructionMeasurements

Parameters

Name	Type
zoomFactor	number
clientWidth	number
clientHeight	number

Returns

ConstructionMeasurements

---

getContainer

▸ getContainer(): Object3D<Object3DEventMap>

Returns

Object3D<Object3DEventMap>

Inherited from

default.getContainer

---

getId

▸ getId(): number

Returns

number

Inherited from

default.getId

---

getKernelObject

▸ getKernelObject(): KernelObject

Returns

KernelObject

Inherited from

default.getKernelObject

---

getMesh

▸ getMesh(material): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

Parameters

Name	Type
material	any

Returns

Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

Inherited from

default.getMesh

---

getName

▸ getName(): string

Returns

string

Inherited from

default.getName

---

getObject

▸ getObject(): RoomleEventedObject3D

Returns

RoomleEventedObject3D

Inherited from

default.getObject

---

getObjectAsync

▸ getObjectAsync(): Promise<Object3D<Object3DEventMap>>

Returns

Promise<Object3D<Object3DEventMap>>

Inherited from

default.getObjectAsync

---

getObjectMeasurements

▸ getObjectMeasurements(zoomFactor, clientWidth, clientHeight): ObjectMeasurements

Parameters

Name	Type
zoomFactor	number
clientWidth	number
clientHeight	number

Returns

ObjectMeasurements

Inherited from

default.getObjectMeasurements

---

getPlanElement

▸ getPlanElement(): ConstructionPlanObject

Returns

ConstructionPlanObject

Overrides

default.getPlanElement

---

getPlanObject

▸ getPlanObject(): PlanObject

Returns

PlanObject

Inherited from

default.getPlanObject

---

getPosition

▸ getPosition(): Vector3

Returns

Vector3

Inherited from

default.getPosition

---

getRootComponentId

▸ getRootComponentId(): number

Returns

number

Inherited from

default.getRootComponentId

---

getRootComponentRuntimeId

▸ getRootComponentRuntimeId(): number

Returns

number

Inherited from

default.getRootComponentRuntimeId

---

getRotation

▸ getRotation(): number

Returns

number

Inherited from

default.getRotation

---

getSize

▸ getSize(): Vector3

Returns

Vector3

Inherited from

default.getSize

---

getTopViewContainer

▸ getTopViewContainer(): default

Returns

default

---

hidePreviewBox

▸ hidePreviewBox(): void

Returns

void

Inherited from

default.hidePreviewBox

---

hoverOff

▸ hoverOff(): void

Returns

void

Inherited from

default.hoverOff

---

hoverOn

▸ hoverOn(): void

Returns

void

Inherited from

default.hoverOn

---

isInitDone

▸ isInitDone(): Promise<void>

Returns

Promise<void>

Inherited from

default.isInitDone

---

remove

▸ remove(): void

Returns

void

Inherited from

default.remove

---

select

▸ select(): void

Returns

void

Inherited from

default.select

---

setObject

▸ setObject(object): void

Parameters

Name	Type
object	RoomleEventedObject3D

Returns

void

Inherited from

default.setObject

---

setRapiItem

▸ setRapiItem(rapiItem): void

Parameters

Name	Type
rapiItem	RapiItem

Returns

void

---

setTopView

▸ setTopView(enabled): Promise<void>

Parameters

Name	Type
enabled	boolean

Returns

Promise<void>

Overrides

default.setTopView

---

toJSON

▸ toJSON(): Object

Returns

Object

Name	Type
rootComponentRuntimeId	number
rootElementId	number

Inherited from

default.toJSON

---

update

▸ update(): void

Returns

void

Overrides

default.update