Class SceneState

Represents the state of a scene.

Hierarchy

SceneState

Constructors

constructor

new SceneState(): SceneState
Returns SceneState
- Defined in renderer/base.ts:7954

Properties

`Static` `Readonly` DEFAULT_LATITUDE

DEFAULT_LATITUDE: number = 38.009476

`Static` `Readonly` DEFAULT_LONGITUDE

DEFAULT_LONGITUDE: 23.794963 = 23.794963

`Static` `Readonly` DEFAULT_TIMEZONE

DEFAULT_TIMEZONE: number = ...

Accessors

alignment

get alignment(): WGS84Alignment
Returns WGS84Alignment
- Defined in renderer/base.ts:7989

angleToTrueNorth

get angleToTrueNorth(): number
Gets the angle to true north.

Returns
The angle to true north.

Returns number
- Defined in renderer/base.ts:8170
set angleToTrueNorth(angleToTrueNorth: number): void
Sets the angle to true north.
Parameters
- angleToTrueNorth: number
  
  The angle to true north.
Returns void
- Defined in renderer/base.ts:8178

cloudsDegrees

get cloudsDegrees(): number
Gets the clouds degrees.

Returns
The clouds degrees.

Returns number
- Defined in renderer/base.ts:8186
set cloudsDegrees(cloudsDegrees: number): void
Sets the clouds degrees. @
Parameters
- cloudsDegrees: number
Returns void
- Defined in renderer/base.ts:8194

defaultModelLocation

get defaultModelLocation(): ModelLocation
Gets the default model location.

Returns
The default model location.

Returns ModelLocation
- Defined in renderer/base.ts:8074
set defaultModelLocation(location: ModelLocation): void
Sets the default model location.
Parameters
- location: ModelLocation
  
  The default model location.
Returns void
- Defined in renderer/base.ts:8082

elements

get elements(): ElementInfo[]
Returns ElementInfo[]
- Defined in renderer/base.ts:8389

elevation

get elevation(): number
Gets the elevation in meters.

Returns
The elevation.

Returns number
- Defined in renderer/base.ts:8138
set elevation(elevation: number): void
Sets the elevation.
Parameters
- elevation: number
  
  The elevation in meters.
Returns void
- Defined in renderer/base.ts:8146

has2DModels

get has2DModels(): boolean
Returns boolean
- Defined in renderer/base.ts:8385

heightAboveGround

get heightAboveGround(): number
Gets the elevation in meters.

Returns number
- Defined in renderer/base.ts:8153
set heightAboveGround(heightAboveGround: number): void
Sets the height above ground (the building height above ground). used for extruding the building from the ground or for calculating the height of the building and syncing with the ground terrain.
Parameters
- heightAboveGround: number
  
  The height above ground in meters
Returns void
- Defined in renderer/base.ts:8162

latitude

get latitude(): number
Gets the latitude.

Returns
The latitude.

Returns number
- Defined in renderer/base.ts:8090
set latitude(lat: number): void
Sets the latitude.
Parameters
- lat: number
  
  The latitude.
Returns void
- Defined in renderer/base.ts:8098

longitude

get longitude(): number
Gets the longitude.

Returns
The longitude.

Returns number
- Defined in renderer/base.ts:8106
set longitude(lon: number): void
Sets the longitude.
Parameters
- lon: number
  
  The longitude.
Returns void
- Defined in renderer/base.ts:8114

models

get models(): ModelInfo[]
Returns ModelInfo[]
- Defined in renderer/base.ts:8285

sceneDateTime

get sceneDateTime(): Date
Gets the scene date and time.

Returns
The scene date and time.

Returns Date
- Defined in renderer/base.ts:8058
set sceneDateTime(d: Date): void
Sets the scene date and time.
Parameters
- d: Date
  
  The scene date and time.
Returns void
- Defined in renderer/base.ts:8066

sceneOffset

get sceneOffset(): SceneOffset
Gets the scene offset.

Returns
The scene offset.

Returns SceneOffset
- Defined in renderer/base.ts:8050

selectedElements

get selectedElements(): ElementInfo[]
Returns ElementInfo[]
- Defined in renderer/base.ts:8485

timezone

get timezone(): number
Gets the timezone.

Returns
The timezone.

Returns number
- Defined in renderer/base.ts:8122
set timezone(timezone: number): void
Sets the timezone.
Parameters
- timezone: number
  
  The timezone.
Returns void
- Defined in renderer/base.ts:8130

Methods

calculateBoundingBoxAlignment

calculateBoundingBoxAlignment(bBox?: BoundingBox3D, firstPointCenter?: boolean, rotateWGS84ToNorth?: boolean): WGS84Alignment
Parameters
- Optional bBox: BoundingBox3D
- Optional firstPointCenter: boolean
- Optional rotateWGS84ToNorth: boolean
Returns WGS84Alignment
- Defined in renderer/base.ts:7996

getAllPaperIds

getAllPaperIds(): Int64[]
Returns Int64[]
- Defined in renderer/base.ts:8297

getElementByElementId

getElementByElementId(id: string | number | Int64): ElementInfo
Parameters
- id: string | number | Int64
Returns ElementInfo
- Defined in renderer/base.ts:8405

getElementByGlobalId

getElementByGlobalId(id: string): ElementInfo
Parameters
- id: string
Returns ElementInfo
- Defined in renderer/base.ts:8421

getElementByInternalId

getElementByInternalId(id: Int64): ElementInfo
Parameters
- id: Int64
Returns ElementInfo
- Defined in renderer/base.ts:8393

getElementIds

getElementIds(include3D: boolean, include2D: boolean): Int64[]
Parameters
- include3D: boolean
- include2D: boolean
Returns Int64[]
- Defined in renderer/base.ts:8503

getElements

getElements(include3D: boolean, include2D: boolean): ElementInfo[]
Parameters
- include3D: boolean
- include2D: boolean
Returns ElementInfo[]
- Defined in renderer/base.ts:8489

getElementsByElementIds

getElementsByElementIds(ids: (number | Int64)[]): ElementInfo[]
Parameters
- ids: (number | Int64)[]
Returns ElementInfo[]
- Defined in renderer/base.ts:8431

getElementsByGlobalIds

getElementsByGlobalIds(ids: string[]): ElementInfo[]
Parameters
- ids: string[]
Returns ElementInfo[]
- Defined in renderer/base.ts:8425

getElementsByInternalIds

getElementsByInternalIds(ids: Int64[], unique?: boolean): ElementInfo[]
Parameters
- ids: Int64[]
- unique: boolean = false
Returns ElementInfo[]
- Defined in renderer/base.ts:8437

getElementsByModelId

getElementsByModelId(id: Int64): ElementInfo[]
Parameters
- id: Int64
Returns ElementInfo[]
- Defined in renderer/base.ts:8417

getModelById

getModelById(id: Int64): ModelInfo
Parameters
- id: Int64
Returns ModelInfo
- Defined in renderer/base.ts:8372

getModelByURL

getModelByURL(url: string): ModelInfo
Parameters
- url: string
Returns ModelInfo
- Defined in renderer/base.ts:8376

getModelCamera

getModelCamera(m: ModelInfo): number[]
Parameters
- m: ModelInfo
Returns number[]
- Defined in renderer/base.ts:8518

getPaperIdFromModelId

getPaperIdFromModelId(modelId: Int64): Int64
Parameters
- modelId: Int64
Returns Int64
- Defined in renderer/base.ts:8293

hasPointClouds

hasPointClouds(): boolean
Returns boolean
- Defined in renderer/base.ts:8198

is2DElement

is2DElement(e: ElementInfo): boolean
Parameters
- e: ElementInfo
Returns boolean
- Defined in renderer/base.ts:8238

is2DPaperId

is2DPaperId(id: Int64): boolean
Parameters
- id: Int64
Returns boolean
- Defined in renderer/base.ts:8247

isPointCloudElement

isPointCloudElement(e: ElementInfo): boolean
Parameters
- e: ElementInfo
Returns boolean
- Defined in renderer/base.ts:8243

moveCloudsPositionBy

moveCloudsPositionBy(degrees: number): Promise<void>
Parameters
- degrees: number
Returns Promise<void>
- Defined in renderer/base.ts:8217

moveTimeByMinutes

moveTimeByMinutes(minutes: number): void
Parameters
- minutes: number
Returns void
- Defined in renderer/base.ts:8213

moveTimeBySeconds

moveTimeBySeconds(seconds: number): void
Parameters
- seconds: number
Returns void
- Defined in renderer/base.ts:8209

selectElementsByElementIds

selectElementsByElementIds(ids: (number | Int64)[]): void
Parameters
- ids: (number | Int64)[]
Returns void
- Defined in renderer/base.ts:8470

selectElementsByGlobalIds

selectElementsByGlobalIds(ids: string[]): void
Parameters
- ids: string[]
Returns void
- Defined in renderer/base.ts:8478

selectElementsByInternalIds

selectElementsByInternalIds(ids: Int64[]): void
Parameters
- ids: Int64[]
Returns void
- Defined in renderer/base.ts:8463

setModelPaperId

setModelPaperId(modelId: Int64, paperId: Int64): void
Parameters
- modelId: Int64
- paperId: Int64
Returns void
- Defined in renderer/base.ts:8289

syncWithCurrentTime

syncWithCurrentTime(withTimeZone?: boolean): void
Parameters
- withTimeZone: boolean = false
Returns void
- Defined in renderer/base.ts:8227