Class MapContainer

Create a new plane with a map texture using leaflet

Hierarchy (View Summary)

RaycastableSceneObject
- MapContainer

Constructors

constructor

new MapContainer(_viewer: Viewer): MapContainer
Create an empty map container
Parameters
- _viewer: Viewer
Returns MapContainer
Overrides RaycastableSceneObject.constructor
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:116

Properties

`Readonly`children

children: SceneObject[] = ...

`Readonly`container

container: Group

`Readonly`isDisplayable

isDisplayable: true

isInit

isInit: boolean = false

`Readonly`isMapContainer

isMapContainer: true

isRaycastable

isRaycastable: boolean = true

`Readonly`isSceneObject

isSceneObject: true

isSelectable

isSelectable: boolean = true

Indicates whether the object is selectable in the scene

isTransformable

isTransformable: boolean = true

mapType

mapType: MapType = MapType.default

name

name: string = ''

parent

parent: SceneObject | null = null

shape

shape: MapShape = MapShape.square

`Readonly`signals

signals: {
    onLatLngChanged: ViewerSignal<(latLng: LatLng) => void>;
    onOpacityChanged: ViewerSignal<(opacity: number) => void>;
    onRotationChanged: ViewerSignal<(angle: number) => void>;
    onSelectedChanged: ViewerSignal<(...args: any[]) => any>;
    onShapeChanged: ViewerSignal<(shape: MapShape) => void>;
    onSizeChanged: ViewerSignal<(size: number) => void>;
    onTransformChanged: ViewerSignal<() => void>;
    onTypeChanged: ViewerSignal<(shape: MapType) => void>;
    onVisibilityChanged: ViewerSignal<(...args: any[]) => any>;
} = ...

size

size: number = 0

`Readonly`transformConfig

transformConfig: ObjectTransformConfig = ...

userData

userData: Record<string, any> = {}

`Readonly`uuid

uuid: string

Unique identifier of the object

Accessors

active

get active(): boolean
Returns boolean
Inherited from RaycastableSceneObject.active
- Defined in viewer/src/scene/objects/SceneObject.ts:164

azimuth

get azimuth(): number
Current map rotation in degrees

Returns number
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:248

center

get center(): LatLng
Current map latitude and map longitude

Returns LatLng
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:241

elevation

get elevation(): number
Elevation of the map : its position on the Y axis

Returns number
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:262

initLat

get initLat(): number
Returns number
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:266

initLng

get initLng(): number
Returns number
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:270

mapDeltaCoordinates

get mapDeltaCoordinates(): Vector3
Center of the map when the twin is entirely loaded (no filters)

Returns Vector3
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:277
set mapDeltaCoordinates(mapDeltaCoordinates: Vector3): void
Parameters
- mapDeltaCoordinates: Vector3
Returns void
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:281

maxSizeMeters

get maxSizeMeters(): number
Max map size available in meters

Returns number
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:255

opacity

get opacity(): number
Current opacity

Returns number
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:232

selected

get selected(): boolean
Returns boolean
Inherited from RaycastableSceneObject.selected
- Defined in viewer/src/scene/objects/SceneObject.ts:175
set selected(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from RaycastableSceneObject.selected
- Defined in viewer/src/scene/objects/SceneObject.ts:168

type

get type(): string
Returns string
Inherited from RaycastableSceneObject.type
- Defined in viewer/src/scene/objects/SceneObject.ts:86

visible

get visible(): boolean
Whether the map is visible or not

Returns boolean
Overrides RaycastableSceneObject.visible
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:213
set visible(visible: boolean): void
Set the visibility of the map
Parameters
- visible: boolean
Returns void
Overrides RaycastableSceneObject.visible
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:220

Methods

addChild

addChild(child: SceneObject): void
Parameters
- child: SceneObject
Returns void
Inherited from RaycastableSceneObject.addChild
- Defined in viewer/src/scene/objects/SceneObject.ts:112

applyMatrix

applyMatrix(matrix: Matrix4): void
Parameters
- matrix: Matrix4
Returns void
Inherited from RaycastableSceneObject.applyMatrix
- Defined in viewer/src/scene/objects/SceneObject.ts:106

centerMap

centerMap(center: Vector3): void
center the lat and lng to the mapDeltaCoordinates point in 3D to always have the map lat/lng center in the same position
Parameters
- center: Vector3
  the center of the scene
Returns void
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:298

dispose

dispose(): void
Returns void
Overrides RaycastableSceneObject.dispose
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:866

getBoundingBox

getBoundingBox(box: Box3): Box3
Parameters
- box: Box3
Returns Box3
Overrides RaycastableSceneObject.getBoundingBox
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:458

getBoundingSphere

getBoundingSphere(sphere: Sphere): Sphere
Parameters
- sphere: Sphere
Returns Sphere
Overrides RaycastableSceneObject.getBoundingSphere
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:470

getLatLngToSave

getLatLngToSave(): LatLng
Get the current latLng of the map with the offset removed to save the map in the correct position

Returns LatLng
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:323

getMatrix

getMatrix(target: Matrix4): Matrix4
Parameters
- target: Matrix4
Returns Matrix4
Overrides RaycastableSceneObject.getMatrix
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:193

getPosition

getPosition(target: Vector3): Vector3
Parameters
- target: Vector3
Returns Vector3
Inherited from RaycastableSceneObject.getPosition
- Defined in viewer/src/scene/objects/SceneObject.ts:94

getStateController

getStateController(): ObjectStateController<MapContainer, ObjectState>
Returns ObjectStateController<MapContainer, ObjectState>
Inherited from RaycastableSceneObject.getStateController
- Defined in viewer/src/scene/objects/SceneObject.ts:139

init

init(
    mapDeltaCoordinates: [number, number, number],
    latLng: LatLng,
    azimuth: number,
    position: Vector3,
    initOpacity: number,
    shape: MapShape,
    size: number,
    visible: boolean,
    nbOfPlanesPerLine: number,
    planeSize: number,
    type: MapType,
): Promise<void>
Init the map container with the given data
Parameters
- mapDeltaCoordinates: [number, number, number]
  Center of the map when the twin is entirely loaded (no filters)
- latLng: LatLng
  Coordinates (latitude and longitude)
- azimuth: number
  Rotation in degrees
- position: Vector3
- initOpacity: number
  The initial map opacity
- shape: MapShape
  Map shape
- size: number
  Map size in meters
- visible: boolean
  Map visibility
- nbOfPlanesPerLine: number
  Number of planes (meshes) per line
- planeSize: number
  Size of one plane in meter
- type: MapType
  Type of map to load
Returns Promise<void>
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:147

parentsGenerator

parentsGenerator(): Generator<SceneObject, void, unknown>
Returns Generator<SceneObject, void, unknown>
Inherited from RaycastableSceneObject.parentsGenerator
- Defined in viewer/src/scene/objects/SceneObject.ts:124

projectPointOnEdges

projectPointOnEdges(
    point: Vector3,
    target: Vector3,
    maxEdgeDistance: number,
): boolean
Parameters
- point: Vector3
- target: Vector3
- maxEdgeDistance: number
Returns boolean
Overrides RaycastableSceneObject.projectPointOnEdges
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:452

raycast

raycast(raycaster: Raycaster, intersects: SceneIntersection[]): void
Performs raycasting on the mesh.
Parameters
- raycaster: Raycaster
  The raycaster to use
- intersects: SceneIntersection[]
  The array of resulting intersections
Returns void
Overrides RaycastableSceneObject.raycast
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:448

removeFromParent

removeFromParent(): void
Returns void
Inherited from RaycastableSceneObject.removeFromParent
- Defined in viewer/src/scene/objects/SceneObject.ts:132

resetToInitialLatLng

resetToInitialLatLng(): void
Reset the offset

Returns void
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:335

setLatLng

setLatLng(latLng: LatLng): void
Set the new map coordinates
Parameters
- latLng: LatLng
  new Latitude and Longitude for the map
Returns void
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:345

setMatrix

setMatrix(matrix: Matrix4): void
Parameters
- matrix: Matrix4
Returns void
Overrides RaycastableSceneObject.setMatrix
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:197

setNbOfPlanesPerLine

setNbOfPlanesPerLine(nbOfPlanes: number): void
Set the number of planes per line
Parameters
- nbOfPlanes: number
Returns void
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:424

setOpacity

setOpacity(opacity: number): void
Set the new map opacity
Parameters
- opacity: number
  new map opacity
Returns void
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:372

setPlaneSize

setPlaneSize(size: number): void
Set the size of one plane (in meters)
Parameters
- size: number
Returns void
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:438

setPosition

setPosition(position: Vector3): void
Parameters
- position: Vector3
Returns void
Inherited from RaycastableSceneObject.setPosition
- Defined in viewer/src/scene/objects/SceneObject.ts:100

setRotation

setRotation(angle: number): void
Set the new map rotation
Parameters
- angle: number
  new map angle in degrees
Returns void
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:357

setShape

setShape(shape: MapShape): void
Set the new map shape
Parameters
- shape: MapShape
  new map shape
Returns void
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:410

setSize

setSize(size: number): void
Set the new map size
Parameters
- size: number
  new map size in meters
Returns void
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:382

setType

setType(type: MapType): void
set the new map type
Parameters
- type: MapType
Returns void
- Defined in plugins/src/MapPlugin/objects/MapContainer.ts:397

toJson

toJson(): Record<string, any>
Returns Record<string, any>
Inherited from RaycastableSceneObject.toJson
- Defined in viewer/src/scene/objects/SceneObject.ts:179

Class MapContainer

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MapContainer

Properties

Readonlychildren

Readonlycontainer

ReadonlyisDisplayable

isInit

ReadonlyisMapContainer

isRaycastable

ReadonlyisSceneObject

isSelectable

isTransformable

mapType

name

parent

shape

Readonlysignals

size

ReadonlytransformConfig

userData

Readonlyuuid

Accessors

active

Returns boolean

azimuth

Returns number

center

Returns LatLng

elevation

Returns number

initLat

Returns number

initLng

Returns number

mapDeltaCoordinates

Returns Vector3

Parameters

Returns void

maxSizeMeters

Returns number

opacity

Returns number

selected

Returns boolean

Parameters

Returns void

type

Returns string

visible

Returns boolean

Parameters

Returns void

Methods

addChild

Parameters

Returns void

applyMatrix

Parameters

Returns void

centerMap

Parameters

Returns void

dispose

Returns void

getBoundingBox

Parameters

Returns Box3

getBoundingSphere

Parameters

Returns Sphere

getLatLngToSave

`Readonly`children

`Readonly`container

`Readonly`isDisplayable

`Readonly`isMapContainer

`Readonly`isSceneObject

`Readonly`signals

`Readonly`transformConfig

`Readonly`uuid