RoomlePlanner.Internal.default-1

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

Hierarchy

• default

  ↳ default

Table of contents

Constructors

• constructor

Properties

• isActivatedDuringDragIn

Accessors

• isSelected

Methods

• addMesh

• clear

• clearReference

• deselect

• getBoundingBox

• getBounds

• getContainer

• getId

• getKernelObject

• getMesh

• getName

• getObject

• getObjectAsync

• getPlanElement

• getPosition

• getRotation

• getSize

• getWallDimension

• hide

• hidePreviewBox

• hoverOff

• hoverOn

• remove

• select

• setObject

• setTopView

• show

• toJSON

• update

Constructors

constructor

• new default(planObject)

Parameters

Name	Type
planObject	PlanObject

Overrides

default.constructor

Properties

isActivatedDuringDragIn

• isActivatedDuringDragIn: boolean = false

Inherited from

default.isActivatedDuringDragIn

Accessors

isSelected

• get isSelected(): boolean

Returns

boolean

Methods

addMesh

▸ addMesh(mesh): void

Parameters

Name	Type
mesh	Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

Returns

void

Overrides

default.addMesh

---

clear

▸ clear(): void

Returns

void

Inherited from

default.clear

---

clearReference

▸ clearReference(): void

Returns

void

Inherited from

default.clearReference

---

deselect

▸ deselect(): void

Returns

void

Overrides

default.deselect

---

getBoundingBox

▸ getBoundingBox(): RoomleEventedMesh

Returns

RoomleEventedMesh

Inherited from

default.getBoundingBox

---

getBounds

▸ getBounds(): Box3

Returns

Box3

Inherited from

default.getBounds

---

getContainer

▸ getContainer(): Object3D<Object3DEventMap>

Returns

Object3D<Object3DEventMap>

Inherited from

default.getContainer

---

getId

▸ getId(): number

Returns

number

Inherited from

default.getId

---

getKernelObject

▸ getKernelObject(): KernelWall

Returns

KernelWall

Overrides

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

---

getPlanElement

▸ getPlanElement(): PlanObject

Returns

PlanObject

Inherited from

default.getPlanElement

---

getPosition

▸ getPosition(): Vector3

Returns

Vector3

Inherited from

default.getPosition

---

getRotation

▸ getRotation(): number

Returns

number

Inherited from

default.getRotation

---

getSize

▸ getSize(): Vector3

Returns

Vector3

Inherited from

default.getSize

---

getWallDimension

▸ getWallDimension(zoomFactor, clientWidth, clientHeight): WallDimension

Parameters

Name	Type
zoomFactor	number
clientWidth	number
clientHeight	number

Returns

WallDimension

---

hide

▸ hide(): void

Returns

void

---

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

---

remove

▸ remove(): void

Returns

void

Inherited from

default.remove

---

select

▸ select(): void

Returns

void

Overrides

default.select

---

setObject

▸ setObject(object): void

Parameters

Name	Type
object	RoomleEventedObject3D

Returns

void

Inherited from

default.setObject

---

setTopView

▸ setTopView(enabled): void

Parameters

Name	Type
enabled	boolean

Returns

void

Overrides

default.setTopView

---

show

▸ show(): void

Returns

void

---

toJSON

▸ toJSON(): Object

Returns

Object

Name	Type
rootElementId	number

Inherited from

default.toJSON

---

update

▸ update(): void

Returns

void

Inherited from

default.update