interface
AmbientLightOptions
Options for an ambient light
Color of the ambient light.
Numeric value of the light's strength/intensity.
BuildingFloorOptions
Options for a floor's plan on the realty scene
Icon to add to the floors' control
Identifier of the floor's plan
Specifies whether a floor's plan is underground.
If value is
true
the map will be covered with a ground geometry
so that only the floor's plan will stay visible.
Map's options to apply after selecting the particular floor
Url of a model that represents the current floor's plan
List of poi groups connected with the floor's plan
Text to add to the floors' control
BuildingOptions
Options for a building on the realty scene
Geographical coordinates [longitude, latitude]
List of the floors' plans connected with the particular building
Interactivity of model. All models are interactive by default
List of buildings' identifiers that should be hidden
Map's options to apply after selecting the particular building
Identifier of the model should be unique for every model
Url where the model is located
Offset of the model along the X axis in meters
Offset of the model along the Y axis in meters
Offset of the model along the Z axis in meters
Popup options
Rotation of the model in degrees about the X axis
Rotation of the model in degrees about the Y axis
Rotation of the model in degrees about the Z axis
Scale of the model
User specific data
BuildingState
State for the building's scene
ControlOptions
Control initialization options.
Position of the control.
GltfPluginEventTable
The list of events that can be emitted by the glTF plugin instance
Emitted when model or poi are clicked
Emitted when the user moves the pointer over the model or the poi
Emitted when the user moves the mouse away from the model or the poi
Emitted when the user hovers over the model or the poi
GltfPluginModelEvent
The event type for pointer-related plugin events emitted by the model
Geographical coordinates of the event
The original DOM event
Screen coordinates of the event
Target of the model event
GltfPluginPoiEvent
The event type for pointer-related plugin events emitted by the poi
Geographical coordinates of the event
The original DOM event
Screen coordinates of the event
Target of the poi event
HightlightOptions
Options for the highlight color of hovered models
Color of the hover
Intensity of the color on the hover in the range from 0 to 1
MapOptions
Options for the map
Geographical center of the map
Map's pitch angle in degrees
Map's rotation angle in degrees
Map's zoom
ModelOptions
Options for a model
Geographical coordinates [longitude, latitude]
Interactivity of model. All models are interactive by default
List of buildings' identifiers that should be hidden
Identifier of the model should be unique for every model
Url where the model is located
Offset of the model along the X axis in meters
Offset of the model along the Y axis in meters
Offset of the model along the Z axis in meters
Rotation of the model in degrees about the X axis
Rotation of the model in degrees about the Y axis
Rotation of the model in degrees about the Z axis
Scale of the model
User specific data
ModelTarget
The targeted model
Identifier of the current floor
Identifier of the building's model
Type of the target
PluginOptions
Options for the plugin
Settings for an ambient light
The url where scripts for the draco decoder are located
Settings for floors' control
Color for the ground covering when an underground floor's plan is shown.
Settings of the highlighted models
The url which is used for resolving of a model's relative url
Strategies for the loading of models:
- dontWaitAll - show models as soon as possible
- waitAll - show models only when all models are ready for the rendering
Configuration of poi
PoiConfig
Configuration the primary poi
Configuration the secondary poi
PoiConfigGranular
Configuration of the poi
Color of the font
Size of the font
PoiGroupOptions
Options for a poi group
Array of poi to add on the map
Elevation of the group of poi
Color of the poi's font
Size of the poi's font
Identifier of the poi group to add
Maximum display styleZoom of the poi group
Minimum display styleZoom of the poi group
Type of the poi
PoiOptions
Options for a poi
Coordinate of the poi
Elevation of the poi
Elevation of the poi
User specific data
PoiTarget
The targeted poi
Identifier of the current floor
Identifier of the building's model
Type of the target
PopupOptions
Options of popup that appears on hover of buildings
Popup's coordinates
Popup's description
Popup's title