FloorObject
Extends
AdsumObject3D
Properties
isFloor
Used to check whether this or derived classes are floors. 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 |
altitude
| Type | Read-Only | Defaults | Description |
|---|---|---|---|
| Number | YES | - | The altitude in meters |
building
| Type | Read-Only | Defaults | Description |
|---|---|---|---|
| BuildingObject | YES | - |
spaces
| Type | Read-Only | Defaults | Description |
|---|---|---|---|
| Set<SpaceObject> | 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: FloorObject
isBounced
isBounced(): boolean
Returns:
Type: boolean
getBounceFactor
getBounceFactor(): number
Returns:
Type: number
Overwritten Methods
getType
getType(): ADSUM_OBJECT_TYPES.FloorObject
Returns:
Type: ADSUM_OBJECT_TYPES.FloorObject
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