SiteObject
Extends
AdsumObject3D
Properties
isSite
Used to check whether this or derived classes are site. 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 | 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 |
Methods
getAltitude
async getAltitude(): Promise<number, Error>
Returns:
Type: Promise<number, Error>
getBuildings
async getBuildings(): Promise<BuildingObject[], Error>
Returns:
Type: Promise<BuildingObject[], Error>
getLabels
async getLabels(): Promise<LabelObject[], Error>
Returns:
Type: Promise<LabelObject[], Error>
getSpaces
async getSpaces(): Promise<SpaceObject[], Error>
Returns:
Type: Promise<SpaceObject[], Error>
Overwritten Methods
getType
getType(): ADSUM_OBJECT_TYPES.SiteObject
Returns:
Type: ADSUM_OBJECT_TYPES.SiteObject
Inherited Methods
getPlaceId
async getPlaceId(): Promise<number, Error>
Returns:
Type: Promise<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 >