Class default

Index

Constructors

Accessors

Methods

destroy enableAutoRenderLoop getAutoRenderLoop getCamera getCesiumScene getDataSourceDisplay getDataSources getEnabled getOlMap getOlView setBlockCesiumRendering setEnabled setRefresh2DAfterCameraMoveEndOnly setResolutionScale setTargetFrameRate warmUp

Constructors

constructor

new default(options: OLCesiumOptions): default
Parameters
- options: OLCesiumOptions
Returns default
- Defined in OLCesium.ts:139

Accessors

trackedFeature

get trackedFeature(): Feature
Returns Feature
- Defined in OLCesium.ts:674
set trackedFeature(feature: Feature): void
Parameters
- feature: Feature
Returns void
- Defined in OLCesium.ts:678

Methods

destroy

destroy(): void
Destroys the Cesium resources held by this object.

Returns void
- Defined in OLCesium.ts:300

enableAutoRenderLoop

enableAutoRenderLoop(): void
Render the globe only when necessary in order to save resources. Experimental.

Returns void
- Defined in OLCesium.ts:600

getAutoRenderLoop

getAutoRenderLoop(): AutoRenderLoop
Get the autorender loop.

Returns AutoRenderLoop
- Defined in OLCesium.ts:609

getCamera

getCamera(): OLCSCamera
Returns OLCSCamera
- Defined in OLCesium.ts:452

getCesiumScene

getCesiumScene(): Scene
Returns Scene
- Defined in OLCesium.ts:466

getDataSourceDisplay

getDataSourceDisplay(): DataSourceDisplay
Returns DataSourceDisplay
- Defined in OLCesium.ts:474

getDataSources

getDataSources(): DataSourceCollection
Returns DataSourceCollection
- Defined in OLCesium.ts:470

getEnabled

getEnabled(): boolean
Returns boolean
- Defined in OLCesium.ts:478

getOlMap

getOlMap(): Map
Returns Map
- Defined in OLCesium.ts:456

getOlView

getOlView(): View
Returns View
- Defined in OLCesium.ts:460

setBlockCesiumRendering

setBlockCesiumRendering(block: boolean): void
Block Cesium rendering to save resources.
Parameters
- block: boolean
  True to block.
Returns void
- Defined in OLCesium.ts:587

setEnabled

setEnabled(enable: boolean): void
Enables/disables the Cesium. This modifies the visibility style of the container element.
Parameters
- enable: boolean
Returns void
- Defined in OLCesium.ts:487

setRefresh2DAfterCameraMoveEndOnly

setRefresh2DAfterCameraMoveEndOnly(value: boolean): void
Set if the synchronization back to the OL 2D map happens continuously or only after the camera is at rest again.
Parameters
- value: boolean
  true: synch after camera move end only; false: synch continuously
Returns void
- Defined in OLCesium.ts:656

setResolutionScale

setResolutionScale(value: number): void
The 3D Cesium globe is rendered in a canvas with two different dimensions: clientWidth and clientHeight which are the dimension on the screen and width and height which are the dimensions of the drawing buffer.

By using a resolution scale lower than 1.0, it is possible to render the globe in a buffer smaller than the canvas client dimensions and improve performance, at the cost of quality.

Pixel ratio should also be taken into account; by default, a device with pixel ratio of 2.0 will have a buffer surface 4 times bigger than the client surface.
Parameters
- value: number
Returns void
- Defined in OLCesium.ts:627

setTargetFrameRate

setTargetFrameRate(value: number): void
Set the target frame rate for the renderer. Set to Number.POSITIVE_INFINITY to render as quickly as possible.
Parameters
- value: number
  The frame rate, in frames per second.
Returns void
- Defined in OLCesium.ts:643

warmUp

warmUp(height: number, timeout: number): void
Preload Cesium so that it is ready when transitioning from 2D to 3D.
Parameters
- height: number
  Target height of the camera
- timeout: number
  Milliseconds after which the warming will stop
Returns void
- Defined in OLCesium.ts:560