Class SceneState

Represents the state of a scene.

Index

Constructors

Constructors

constructor

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

Properties

`Static` `Readonly`DEFAULT_LATITUDE

DEFAULT_LATITUDE: number = 38.009476

`Static` `Readonly`DEFAULT_LONGITUDE

DEFAULT_LONGITUDE: 23.794963

`Static` `Readonly`DEFAULT_TIMEZONE

DEFAULT_TIMEZONE: number = ...

Accessors

alignment

get alignment(): WGS84Alignment
Gets the alignment of the bounding box in WGS84 coordinates.

Returns WGS84Alignment
- Defined in renderer/base.ts:9925

sceneOffset

get sceneOffset(): SceneOffset
Gets the scene offset.

Returns SceneOffset
The scene offset.
- Defined in renderer/base.ts:9993

sceneDateTime

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

Returns Date
The scene date and time.
- Defined in renderer/base.ts:10001
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:10009

defaultModelLocation

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

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

latitude

get latitude(): number
Gets the latitude.

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

longitude

get longitude(): number
Gets the longitude.

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

wgs84

get wgs84(): WGS84
Gets the WGS84 coordinates ( latitude, longitude, elevation ).

Returns WGS84
The WGS84 coordinates.
- Defined in renderer/base.ts:10065

timezone

get timezone(): number
Gets the timezone.

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

elevation

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

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

altitude

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

Returns number
- Defined in renderer/base.ts:10104
set altitude(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:10113

angleToTrueNorth

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

Returns number
The angle to true north.
- Defined in renderer/base.ts:10121
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:10129

cloudsDegrees

get cloudsDegrees(): number
Gets the clouds degrees.

Returns number
The clouds degrees.
- Defined in renderer/base.ts:10137
set cloudsDegrees(cloudsDegrees: number): void
Sets the clouds degrees.
Parameters
- cloudsDegrees: number
  The clouds degrees.
Returns void
- Defined in renderer/base.ts:10145

models

get models(): ModelInfo[]
Gets the loaded models.

Returns ModelInfo[]
The loaded models.
- Defined in renderer/base.ts:10276

has2DModels

get has2DModels(): boolean
Checks if the scene contains any 2D models.

Returns boolean
- Defined in renderer/base.ts:10490

elements

get elements(): ElementInfo[]
Gets the elements of a model.

Returns ElementInfo[]
- Defined in renderer/base.ts:10497

selectedElements

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

Methods

registerPatternTexture

registerPatternTexture(
    renderer: BaseRenderer,
    patternKey: string,
    color: string,
    fillPattern: FillPattern,
): Promise<number>
Registers a pattern texture.
Parameters
- renderer: BaseRenderer
  The renderer instance.
- patternKey: string
  The pattern key.
- color: string
  The color of the pattern.
- fillPattern: FillPattern
  The fill pattern.
Returns Promise<number>
The texture ID.
- Defined in renderer/base.ts:9819

unregisterPatternTexture

unregisterPatternTexture(
    renderer: BaseRenderer,
    _textureId: number,
    _textureName: string,
): Promise<void>
Unregisters a pattern texture.
Parameters
- renderer: BaseRenderer
  The renderer instance.
- _textureId: number
  The texture ID.
- _textureName: string
  The texture name.
Returns Promise<void>
- Defined in renderer/base.ts:9841

getShapeById

getShapeById(id: string): { shape: ShapeText; color: RGBA; elementId: Int64 }
Gets the shape associated with the given ID.
Parameters
- id: string
  The shape ID.
Returns { shape: ShapeText; color: RGBA; elementId: Int64 }
The shape associated with the ID, or undefined if not found.
- Defined in renderer/base.ts:9857

getExtrusionById

getExtrusionById(id: Int64): Measurement
Gets the extrusion associated with the given ID.
Parameters
- id: Int64
  The extrusion ID.
Returns Measurement
The extrusion associated with the ID, or undefined if not found.
- Defined in renderer/base.ts:9866

hasExtrusions

hasExtrusions(): boolean
Checks if there are any extrusions in the scene.

Returns boolean
Whether there are any extrusions in the scene.
- Defined in renderer/base.ts:9875

getExtrusionIds

getExtrusionIds(): Int64[]
Gets all extrusion IDs in the scene.

Returns Int64[]
All extrusion IDs in the scene.
- Defined in renderer/base.ts:9883

getMeasurementByExtrusionId

getMeasurementByExtrusionId(id: Int64): Measurement
Gets the measurement associated with the given extrusion ID.
Parameters
- id: Int64
  The extrusion ID.
Returns Measurement
The measurement associated with the extrusion ID, or undefined if not found.
- Defined in renderer/base.ts:9892

calculateBoundingBoxAlignment

calculateBoundingBoxAlignment(
    bBox?: BoundingBox3D,
    firstPointCenter?: boolean,
    rotateWGS84ToNorth?: boolean,
): WGS84Alignment
Calculates the alignment of the bounding box in WGS84 coordinates.
Parameters
- OptionalbBox: BoundingBox3D
  The bounding box to align.
- OptionalfirstPointCenter: boolean
  Whether to use the first point as the center.
- OptionalrotateWGS84ToNorth: boolean
  Whether to rotate the WGS84 coordinates to true north.
Returns WGS84Alignment
The calculated alignment.
- Defined in renderer/base.ts:9939

hasPointClouds

hasPointClouds(): boolean
Checks if the scene contains point clouds.

Returns boolean
True if the scene contains point clouds, false otherwise.
- Defined in renderer/base.ts:10153

moveTimeBySeconds

moveTimeBySeconds(seconds: number): void
Moves the scene time by the given seconds.
Parameters
- seconds: number
  Seconds to move the scene time by.
Returns void
- Defined in renderer/base.ts:10168

moveTimeByMinutes

moveTimeByMinutes(minutes: number): void
Moves the scene time by the given minutes.
Parameters
- minutes: number
  Minutes to move the scene time by.
Returns void
- Defined in renderer/base.ts:10176

moveCloudsPositionBy

moveCloudsPositionBy(degrees: number): Promise<void>
Moves the clouds position by the given degrees.
Parameters
- degrees: number
  Degrees to move the clouds position by.
Returns Promise<void>
- Defined in renderer/base.ts:10184

syncWithCurrentTime

syncWithCurrentTime(withTimeZone?: boolean): void
Synchronizes the scene time with the current time.
Parameters
- withTimeZone: boolean = false
  If true, also sets the timezone to the current timezone.
Returns void
- Defined in renderer/base.ts:10198

is2DElement

is2DElement(e: ElementInfo): boolean
Checks if the given element is a 2D element.
Parameters
- e: ElementInfo
  The element to check.
Returns boolean
True if the element is a 2D element, false otherwise.
- Defined in renderer/base.ts:10214

isPointCloudElement

isPointCloudElement(e: ElementInfo): boolean
Checks if the given element is a point cloud element.
Parameters
- e: ElementInfo
  The element to check.
Returns boolean
True if the element is a point cloud element, false otherwise.
- Defined in renderer/base.ts:10224

is2DPaperId

is2DPaperId(id: Int64): boolean
Checks if the given paper ID is a 2D paper ID.
Parameters
- id: Int64
  The paper ID to check.
Returns boolean
True if the paper ID is a 2D paper ID, false otherwise.
- Defined in renderer/base.ts:10233

setModelPaperId

setModelPaperId(modelId: Int64, paperId: Int64): void
Sets the paper ID for a given model ID.
Parameters
- modelId: Int64
  The model ID.
- paperId: Int64
  The paper ID.
Returns void
- Defined in renderer/base.ts:10285

getPaperIdFromModelId

getPaperIdFromModelId(modelId: Int64): Int64
Gets the paper ID for a given model ID.
Parameters
- modelId: Int64
  The model ID.
Returns Int64
The paper ID for the model, or null if not found.
- Defined in renderer/base.ts:10294

getAllPaperIds

getAllPaperIds(): Int64[]
Gets all paper element IDs from all 2D models.

Returns Int64[]
All paper element IDs from all 2D models.
- Defined in renderer/base.ts:10302

excludePaperElementsFromSelection

excludePaperElementsFromSelection(IDS: number[] | Int64[]): void
Excludes paper elements from selection.
Parameters
- IDS: number[] | Int64[]
  Array of Int64 or number IDs
Returns void
- Defined in renderer/base.ts:10315

getModelById

getModelById(id: Int64): ModelInfo
Gets the model with the specified ID.
Parameters
- id: Int64
  The ID of the model to find.
Returns ModelInfo
The model with the specified ID, or null if not found.
- Defined in renderer/base.ts:10462

getModelByURL

getModelByURL(url: string): ModelInfo
Gets the model with the specified URL.
Parameters
- url: string
  The URL of the model to find.
Returns ModelInfo
The model with the specified URL, or null if not found.
- Defined in renderer/base.ts:10471

isFirstModel

isFirstModel(id64: Int64): boolean
Parameters
- id64: Int64
Returns boolean
- Defined in renderer/base.ts:10480

hasSplittedModels

hasSplittedModels(): boolean
Gets the elements of a model.

Returns boolean
The elements of the model, or an empty array if none found.
- Defined in renderer/base.ts:10505

isElementSplitted

isElementSplitted(internalId: Int64): boolean
Checks if the given internal ID belongs to a splitted element.
Parameters
- internalId: Int64
  The internal ID of the element to check.
Returns boolean
True if the element is splitted, false otherwise.
- Defined in renderer/base.ts:10514

isSplittedElementPart

isSplittedElementPart(internalId: Int64): boolean
Checks if the given internal ID belongs to a splitted element part.
Parameters
- internalId: Int64
  The internal ID of the element to check.
Returns boolean
True if the element is a part of a splitted element, false otherwise.
- Defined in renderer/base.ts:10539

getSplittedElementModelId

getSplittedElementModelId(internalId: Int64): Int64
Returns the model ID of the splitted element part with the given internal ID.
Parameters
- internalId: Int64
  The internal ID of the element to get.
Returns Int64
The model ID of the splitted element part with the given internal ID, or null if not found.
- Defined in renderer/base.ts:10557

getSplittedElementPartOriginalModelId

getSplittedElementPartOriginalModelId(internalId: Int64): Int64
Returns the original model ID of the splitted element part with the given internal ID.
Parameters
- internalId: Int64
  The internal ID of the element to get.
Returns Int64
The original model ID of the splitted element part with the given internal ID, or null if not found.
- Defined in renderer/base.ts:10577

getSplittedElementPartByInternalId

getSplittedElementPartByInternalId(internalId: Int64): SplitPartInfo
Returns the splitted element part with the given internal ID.
Parameters
- internalId: Int64
  The internal ID of the element to get.
Returns SplitPartInfo
The splitted element part with the given internal ID, or null if not found.
- Defined in renderer/base.ts:10596

getSplittedElementPartBySplitId

getSplittedElementPartBySplitId(splitId: string): SplitPartInfo
Returns the splitted element part with the given split ID.
Parameters
- splitId: string
  The split ID of the element to get.
Returns SplitPartInfo
The splitted element part with the given split ID, or null if not found.
- Defined in renderer/base.ts:10614

getSplittedElementPartsBySplitIds

getSplittedElementPartsBySplitIds(splitIds: string[]): SplitPartInfo[]
Returns the splitted element parts with the given split IDs.
Parameters
- splitIds: string[]
  The split IDs of the elements to get.
Returns SplitPartInfo[]
An array of splitted element parts with the given split IDs.
- Defined in renderer/base.ts:10634

getElementPartsByInternalId

getElementPartsByInternalId(internalId: Int64): SplitPartInfo[]
Returs all the bottom line parts of a splitted element.
Parameters
- internalId: Int64
Returns SplitPartInfo[]
- Defined in renderer/base.ts:10662

toSplittedInternalIds

toSplittedInternalIds(
ids: Int64[],
): { bottomSplitIds: Int64[]; topSplitIds: Int64[] }
Returns all the bottom line splitted elements part internal ids of a splitted element. Additionally returns the top split internal ids that must be hidden.
Parameters
- ids: Int64[]
Returns { bottomSplitIds: Int64[]; topSplitIds: Int64[] }
- Defined in renderer/base.ts:10730

getElementByInternalId

getElementByInternalId(
id: Int64,
checkIntoSplittedModels?: boolean,
): ElementInfo
Returns the element with the given internal ID. If the internal ID belongs to a part of a splitted element, it returns the parent element.
Parameters
- id: Int64
  The internal ID of the element to get.
- checkIntoSplittedModels: boolean = true
Returns ElementInfo
- Defined in renderer/base.ts:10777

elementIdsToInternalIds

elementIdsToInternalIds(elementIds: (number | Int64)[]): Int64[]
Returns the internal IDs of the elements with the given element IDs.
Parameters
- elementIds: (number | Int64)[]
Returns Int64[]
- Defined in renderer/base.ts:10809

getElementByElementId

getElementByElementId(id: string | number | Int64): ElementInfo
Returns the element with the given element ID.
Parameters
- id: string | number | Int64
  The element ID of the element to get.
Returns ElementInfo
- Defined in renderer/base.ts:10825

getElementsByModelId

getElementsByModelId(id: Int64): ElementInfo[]
Returns all elements that belong to the given model ID.
Parameters
- id: Int64
  The model ID.
Returns ElementInfo[]
An array of elements that belong to the given model ID.
- Defined in renderer/base.ts:10842

getElementByGlobalId

getElementByGlobalId(id: string): ElementInfo
Returns the element with the given global ID.
Parameters
- id: string
  The global ID of the element to get.
Returns ElementInfo
The element with the given global ID.
- Defined in renderer/base.ts:10851

getElementsByGlobalIds

getElementsByGlobalIds(ids: string[]): ElementInfo[]
Returns the elements with the given global IDs.
Parameters
- ids: string[]
  The global IDs of the elements to get.
Returns ElementInfo[]
An array of elements with the given global IDs.
- Defined in renderer/base.ts:10860

getElementsByElementIds

getElementsByElementIds(ids: (number | Int64)[]): ElementInfo[]
Returns the elements with the given element IDs.
Parameters
- ids: (number | Int64)[]
  The element IDs of the elements to get.
Returns ElementInfo[]
An array of elements with the given element IDs.
- Defined in renderer/base.ts:10871

getElementsByInternalIds

getElementsByInternalIds(ids: Int64[], unique?: boolean): ElementInfo[]
Returns the elements with the given internal IDs.
Parameters
- ids: Int64[]
  The internal IDs of the elements to get.
- unique: boolean = false
  If true, only unique elements are returned.
Returns ElementInfo[]
An array of elements with the given internal IDs.
- Defined in renderer/base.ts:10883

getElementParts

getElementParts(element: ElementInfo): SplitPartInfo[]
Returns the parts of a given element (it must be a splitted element).
Parameters
- element: ElementInfo
  The element to get its parts.
Returns SplitPartInfo[]
The parts of the element.
- Defined in renderer/base.ts:10914

getElementMissingParts

getElementMissingParts(elementWithParts: ElementInfoWithParts): SplitPartInfo[]
Returns the missing parts for a given element with parts. You can pass an elemnent eith no parts to get all its parts.
Parameters
- elementWithParts: ElementInfoWithParts
  The element with its parts.
Returns SplitPartInfo[]
The missing parts.
- Defined in renderer/base.ts:10927

getElementWithPartsByInternalIds

getElementWithPartsByInternalIds(
internalIds: Int64[],
skipElementsWithoutParts?: boolean,
): ElementInfoWithParts[]
Returns the elements with their splitted parts (if any). If the model has no splitted elements, it returns the elements without parts. Usually call this method after getting the internal IDs using getHighlightedInternalIds to get IDs of parts as well.
Parameters
- internalIds: Int64[]
  the internal IDs of the elements or the parts to get.
- skipElementsWithoutParts: boolean = false
  if true, it skips elements that have no parts default is false.
Returns ElementInfoWithParts[]
- Defined in renderer/base.ts:10958

selectElementsByInternalIds

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

selectElementsByElementIds

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

selectElementsByGlobalIds

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

getElements

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

getElementIds

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

getModelCamera

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

Class SceneState

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns SceneState

Properties

Static ReadonlyDEFAULT_LATITUDE

Static ReadonlyDEFAULT_LONGITUDE

Static ReadonlyDEFAULT_TIMEZONE

Accessors

alignment

Returns WGS84Alignment

sceneOffset

Returns SceneOffset

sceneDateTime

Returns Date

Parameters

Returns void

defaultModelLocation

Returns ModelLocation

Parameters

Returns void

latitude

Returns number

Parameters

Returns void

longitude

Returns number

Parameters

Returns void

wgs84

Returns WGS84

timezone

Returns number

Parameters

Returns void

elevation

Returns number

Parameters

Returns void

altitude

Returns number

Parameters

Returns void

angleToTrueNorth

Returns number

Parameters

Returns void

cloudsDegrees

Returns number

Parameters

Returns void

models

Returns ModelInfo[]

has2DModels

Returns boolean

elements

Returns ElementInfo[]

selectedElements

Returns ElementInfo[]

Methods

registerPatternTexture

Parameters

Returns Promise<number>

unregisterPatternTexture

Parameters

Returns Promise<void>

getShapeById

Parameters

Returns { shape: ShapeText; color: RGBA; elementId: Int64 }

getExtrusionById

Parameters

Returns Measurement

hasExtrusions

Returns boolean

getExtrusionIds

`Static` `Readonly`DEFAULT_LATITUDE

`Static` `Readonly`DEFAULT_LONGITUDE

`Static` `Readonly`DEFAULT_TIMEZONE