API Reference › Globals › PlanObjectViewModel
# Class: PlanObjectViewModel
# Hierarchy
↳ PlanObjectViewModel
↳ ConfiguratorPlanObjectViewModel
# Index
# Constructors
# Methods
- addMesh
- clear
- clearReference
- deselect
- getBoundingBox
- getBounds
- getContainer
- getId
- getKernelObject
- getMesh
- getObject
- getObjectAsync
- getPlanElement
- getPlanObject
- getPosition
- getRotation
- getSize
- hidePreviewBox
- remove
- select
- setObject
- setPrimaryColor
- update
# Constructors
# constructor
+ new PlanObjectViewModel(planObject: PlanObject): PlanObjectViewModel
Overrides PlanElementViewModel.constructor
Defined in packages/common-core/src/view-model/plan-object-view-model.ts:5
Parameters:
| Name | Type |
|---|---|
planObject | PlanObject |
Returns: PlanObjectViewModel
# Methods
# addMesh
▸ addMesh(mesh: Mesh): void
Inherited from PlanElementViewModel.addMesh
Defined in packages/common-core/src/view-model/plan-element-view-model.ts:106
Parameters:
| Name | Type |
|---|---|
mesh | Mesh |
Returns: void
# clear
▸ clear(): void
Inherited from PlanElementViewModel.clear
Defined in packages/common-core/src/view-model/plan-element-view-model.ts:127
Returns: void
# clearReference
▸ clearReference(): void
Inherited from KernelViewModel.clearReference
Defined in packages/common-core/src/view-model/kernel-view-model.ts:10
Returns: void
# deselect
▸ deselect(): void
Inherited from PlanElementViewModel.deselect
Defined in packages/common-core/src/view-model/plan-element-view-model.ts:181
Returns: void
# getBoundingBox
▸ getBoundingBox(): Mesh
Inherited from PlanElementViewModel.getBoundingBox
Defined in packages/common-core/src/view-model/plan-element-view-model.ts:82
Returns: Mesh
# getBounds
▸ getBounds(): Box3
Inherited from PlanElementViewModel.getBounds
Defined in packages/common-core/src/view-model/plan-element-view-model.ts:70
Returns: Box3
# getContainer
▸ getContainer(): Object3D
Inherited from PlanElementViewModel.getContainer
Defined in packages/common-core/src/view-model/plan-element-view-model.ts:119
Returns: Object3D
# getId
▸ getId(): number
Inherited from PlanElementViewModel.getId
Defined in packages/common-core/src/view-model/plan-element-view-model.ts:123
Returns: number
# getKernelObject
▸ getKernelObject(): KernelObject
Inherited from KernelViewModel.getKernelObject
Defined in packages/common-core/src/view-model/kernel-view-model.ts:15
Returns: KernelObject
# getMesh
▸ getMesh(material: any): Mesh
Inherited from PlanElementViewModel.getMesh
Defined in packages/common-core/src/view-model/plan-element-view-model.ts:111
Parameters:
| Name | Type |
|---|---|
material | any |
Returns: Mesh
# getObject
▸ getObject(): Object3D‹›
Inherited from PlanElementViewModel.getObject
Defined in packages/common-core/src/view-model/plan-element-view-model.ts:95
Returns: Object3D‹›
# getObjectAsync
▸ getObjectAsync(): Promise‹Object3D‹››
Inherited from PlanElementViewModel.getObjectAsync
Defined in packages/common-core/src/view-model/plan-element-view-model.ts:99
Returns: Promise‹Object3D‹››
# getPlanElement
▸ getPlanElement(): PlanObject
Inherited from PlanElementViewModel.getPlanElement
Defined in packages/common-core/src/view-model/plan-element-view-model.ts:86
Returns: PlanObject
# getPlanObject
▸ getPlanObject(): PlanObject
Defined in packages/common-core/src/view-model/plan-object-view-model.ts:12
Returns: PlanObject
# getPosition
▸ getPosition(): Vector3
Inherited from PlanElementViewModel.getPosition
Defined in packages/common-core/src/view-model/plan-element-view-model.ts:62
Returns: Vector3
# getRotation
▸ getRotation(): number
Inherited from PlanElementViewModel.getRotation
Defined in packages/common-core/src/view-model/plan-element-view-model.ts:66
Returns: number
# getSize
▸ getSize(): Vector3
Overrides PlanElementViewModel.getSize
Defined in packages/common-core/src/view-model/plan-object-view-model.ts:16
Returns: Vector3
# hidePreviewBox
▸ hidePreviewBox(): void
Inherited from PlanElementViewModel.hidePreviewBox
Defined in packages/common-core/src/view-model/plan-element-view-model.ts:139
Returns: void
# remove
▸ remove(): void
Inherited from PlanElementViewModel.remove
Defined in packages/common-core/src/view-model/plan-element-view-model.ts:134
Returns: void
# select
▸ select(): void
Inherited from PlanElementViewModel.select
Defined in packages/common-core/src/view-model/plan-element-view-model.ts:166
Returns: void
# setObject
▸ setObject(object: Object3D): void
Inherited from PlanElementViewModel.setObject
Defined in packages/common-core/src/view-model/plan-element-view-model.ts:90
Parameters:
| Name | Type |
|---|---|
object | Object3D |
Returns: void
# setPrimaryColor
▸ setPrimaryColor(color: string): void
Inherited from PlanElementViewModel.setPrimaryColor
Defined in packages/common-core/src/view-model/plan-element-view-model.ts:187
Parameters:
| Name | Type |
|---|---|
color | string |
Returns: void
# update
▸ update(): void
Overrides PlanElementViewModel.update
Defined in packages/common-core/src/view-model/plan-object-view-model.ts:20
Returns: void