BuildingObject
Extends
AdsumObject3D
Properties
isBuilding
Used to check whether this or derived classes are buildings. Default is true.
You should not change this, as it used internally by the renderer for optimisation.
| Type | Read-Only | Defaults | Description |
|---|---|---|---|
| boolean | YES | True |
Inherited Properties
id
| Type | Read-Only | Description |
|---|---|---|
| number | null | YES |
isAdsumObject
Used to check whether this or derived classes are Adsum object 3D. Default is true.
You should not change this, as it used internally by the renderer for optimisation.
| Type | Read-Only | Defaults | Description |
|---|---|---|---|
| boolean | YES | True |
Methods
getFloors
async getFloors(): Promise<FloorObject[], Error>
Returns:
Type: Promise<FloorObject[], Error>
getLabels
async getLabels(): Promise<LabelObject[], Error>
Returns:
Type: Promise<LabelObject[], Error>
getName
async getName(): Promise<string, Error>
Returns:
Type: Promise<string, Error>
getSite
async getSite(): Promise<SiteObject, Error>
Returns:
Type: Promise<SiteObject[], Error>
isInitialColor
async isInitialColor(): Promise<boolean, Error>
Returns:
Type: Promise<boolean, Error>
resetColor
async resetColor(): Promise<void, Error>
Returns:
Type: Promise<void, Error>
setColor
setColor(color: number|string): void
Parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| color | number | string | Yes | - | hex triplet number (0xffffff) or color as a CSS-style string like (#ffffff) |
Returns:
Type: Promise<void, Error>
Overwritten Methods
getType
getType(): ADSUM_OBJECT_TYPES.BuildingObject
Returns:
Type: ADSUM_OBJECT_TYPES.BuildingObject
Inherited Methods
getPlaceId
async getPlaceId(): Promise<number, Error>
Returns:
Type: Promise<number, Error>
getPosition
async getPosition(): Promise<{ x: number, y: number, z: number }, Error>
Gets the position relative to parent.
Returns:
Type: Promise<{ x: number, y: number, z: number }, Error>
setDisplayMode
async setDisplayMode(displayMode: DISPLAY_MODES.NONE|DISPLAY_MODES.VISIBLE|DISPLAY_MODES.TRANSPARENT): Promise<void, Error>
Parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| displayMode | DISPLAY_MODES.NONE | DISPLAY_MODES.VISIBLE | DISPLAY_MODES.TRANSPARENT | Yes | - |
Returns:
Type: Promise<void, Error>
getDisplayMode
async getDisplayMode(): Promise<DISPLAY_MODES.NONE|DISPLAY_MODES.VISIBLE|DISPLAY_MODES.TRANSPARENT, Error>
Returns:
Type: Promise< DISPLAY_MODES.NONE | DISPLAY_MODES.VISIBLE | DISPLAY_MODES.TRANSPARENT, Error >