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 |
site
| Type | Read-Only | Defaults | Description |
|---|---|---|---|
| SiteObject | YES | True |
floors
| Type | Read-Only | Defaults | Description |
|---|---|---|---|
| Set<FloorObject> | YES | True |
labels
| Type | Read-Only | Defaults | Description |
|---|---|---|---|
| Set<LabelObject> | YES | True |
name
| Type | Read-Only | Defaults | Description |
|---|---|---|---|
| string | YES | - |
Inherited Properties
id
| Type | Read-Only | Description |
|---|---|---|
| number | symbol | 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 |
placeId
| Type | Read-Only | Description |
|---|---|---|
| number | symbol | null | YES |
Methods
isInitialColor
isInitialColor(): boolean
Returns:
Type: boolean
resetColor
resetColor(): BuildingObject
Returns:
Type: BuildingObject
setColor
setColor(color: number|string): BuildingObject
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: BuildingObject
Overwritten Methods
getType
getType(): ADSUM_OBJECT_TYPES.BuildingObject
Returns:
Type: ADSUM_OBJECT_TYPES.BuildingObject
Inherited Methods
getPosition
getPosition(): { x: number, y: number, z: number }
Gets the position relative to parent.
Returns:
Type: { x: number, y: number, z: number }
setDisplayMode
setDisplayMode(displayMode: DISPLAY_MODES.NONE|DISPLAY_MODES.VISIBLE|DISPLAY_MODES.TRANSPARENT): void
Parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| displayMode | DISPLAY_MODES.NONE | DISPLAY_MODES.VISIBLE | DISPLAY_MODES.TRANSPARENT | Yes | - |
Returns:
Type: void
getDisplayMode
getDisplayMode(): DISPLAY_MODES.NONE|DISPLAY_MODES.VISIBLE|DISPLAY_MODES.TRANSPARENT
Returns:
Type: DISPLAY_MODES.NONE | DISPLAY_MODES.VISIBLE | DISPLAY_MODES.TRANSPARENT