SpaceObject
Extends
AdsumObject3D
Properties
isSpace
Used to check whether this or derived classes are spaces. 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 |
parent
| Type | Read-Only | Defaults | Description |
|---|---|---|---|
| SiteObject | FloorObject | YES | - |
labels
| Type | Read-Only | Defaults | Description |
|---|---|---|---|
| Set<LabelObject> | YES | - |
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
bounceDown
bounceDown(): SpaceObject
Returns:
Type: SpaceObject
bounceUp
bounceUp(factor: number): SpaceObject
Parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| factor | number | Yes | - |
Returns:
Type: SpaceObject
isBounced
isBounced(): boolean
Returns:
Type: boolean
isInitialColor
isInitialColor(): boolean
Returns:
Type: boolean
getBounceFactor
getBounceFactor(): number
Returns:
Type: number
resetColor
resetColor(): BuildingObject
Returns:
Type: BuildingObject
setColor
setColor(color: number|string): SpaceObject
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: SpaceObject
Overwritten Methods
getType
getType(): ADSUM_OBJECT_TYPES.SpaceObject
Returns:
Type: ADSUM_OBJECT_TYPES.SpaceObject
Inherited Methods
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
getPosition
getPosition(): { x: number, y: number, z: number }
Gets the position relative to parent.
Returns:
Type: { x: number, y: number, z: number }