Class OLCSCamera

Constructors

constructor

new OLCSCamera(scene, map): OLCSCamera
This object takes care of additional 3d-specific properties of the view and ensures proper synchronization with the underlying raw Cesium.Camera object.
Parameters
- scene: Scene
- map: Map
Returns OLCSCamera
- Defined in src/olcs/Camera.ts:52

Properties

`Private` cam_

cam_: Camera

`Private` distance_

distance_: number = 0

`Private` fromLonLat_

fromLonLat_: ((input, opt_output?, opt_dimension?) => number[]) = identityProjection

Type declaration

- (input, opt_output?, opt_dimension?): number[]
- Parameters
  - input: number[]
    Input coordinate array.
  - Optional opt_output: number[]
    Output array of coordinate values.
  - Optional opt_dimension: number
    Dimension.
  Returns number[]

`Private` lastCameraViewMatrix_

lastCameraViewMatrix_: Matrix4 = null

`Private` map_

map_: Map

`Private` scene_

scene_: Scene

`Private` tilt_

tilt_: number = 0

0 -- topdown, PI/2 -- the horizon

`Private` toLonLat_

toLonLat_: ((input, opt_output?, opt_dimension?) => number[]) = identityProjection

Type declaration

- (input, opt_output?, opt_dimension?): number[]
- Parameters
  - input: number[]
    Input coordinate array.
  - Optional opt_output: number[]
    Output array of coordinate values.
  - Optional opt_dimension: number
    Dimension.
  Returns number[]

`Private` viewListenKey_

viewListenKey_: EventsKey = null

`Private` viewUpdateInProgress_

viewUpdateInProgress_: boolean = false

This is used to discard change events on view caused by updateView method.

`Private` view_

view_: View

Methods

calcDistanceForResolution

calcDistanceForResolution(resolution, latitude): number
calculate the distance between camera and centerpoint based on the resolution and latitude value
Parameters
- resolution: number
  Number of map units per pixel.
- latitude: number
  Latitude in radians.
Returns number
The calculated distance.
- Defined in src/olcs/Camera.ts:401

calcResolutionForDistance

calcResolutionForDistance(distance, latitude): number
calculate the resolution based on a distance(camera to position) and latitude value
Parameters
- distance: number
- latitude: number
Returns number
} The calculated resolution.
- Defined in src/olcs/Camera.ts:411

checkCameraChange

checkCameraChange(opt_dontSync?): void
Check if the underlying camera state has changed and ensure synchronization.
Parameters
- Optional opt_dontSync: boolean
  Do not synchronize the view.
Returns void
- Defined in src/olcs/Camera.ts:383

destroy

destroy(): void
Returns void
- Defined in src/olcs/Camera.ts:62

getAltitude

getAltitude(): number
Returns number
Altitude in meters.
- Defined in src/olcs/Camera.ts:235

getCenter

getCenter(): Coordinate
Returns Coordinate
Same projection as the ol.View.

Deprecated
Shortcut for ol.View.getCenter().

Api
- Defined in src/olcs/Camera.ts:172

getDistance

getDistance(): number
Returns number
Distance in meters.
- Defined in src/olcs/Camera.ts:150

getHeading

getHeading(): number
Returns number
Heading in radians.

Deprecated
- Defined in src/olcs/Camera.ts:115

getPosition

getPosition(): number[]
Calculates position under the camera.

Returns number[]
Coordinates in same projection as the ol.View.

Api
- Defined in src/olcs/Camera.ts:206

getTilt

getTilt(): number
Returns number
Tilt in radians.
- Defined in src/olcs/Camera.ts:134

`Private` handleViewChangedEvent_

handleViewChangedEvent_(): void
Returns void
- Defined in src/olcs/Camera.ts:93

readFromView

readFromView(): void
Calculates the values of the properties from the current ol.View state.

Returns void
- Defined in src/olcs/Camera.ts:284

setAltitude

setAltitude(altitude): void
Parameters
- altitude: number
  In meters.
Returns void
- Defined in src/olcs/Camera.ts:223

setCenter

setCenter(center): void
Parameters
- center: number[]
  Same projection as the ol.View.
Returns void
Deprecated
Shortcut for ol.View.setCenter().
- Defined in src/olcs/Camera.ts:159

setDistance

setDistance(distance): void
Parameters
- distance: number
  In meters.
Returns void
- Defined in src/olcs/Camera.ts:141

setHeading

setHeading(heading): void
Parameters
- heading: number
  In radians.
Returns void
Deprecated
- Defined in src/olcs/Camera.ts:103

setPosition

setPosition(position): void
Sets the position of the camera.
Parameters
- position: number[]
  Same projection as the ol.View.
Returns void
- Defined in src/olcs/Camera.ts:183

setTilt

setTilt(tilt): void
Parameters
- tilt: number
  In radians.
Returns void
- Defined in src/olcs/Camera.ts:126

`Private` setView_

setView_(view): void
Private
Parameters
- view: View
  New view to use.
Returns void
- Defined in src/olcs/Camera.ts:71

`Private` updateCamera_

updateCamera_(): void
Updates the state of the underlying Cesium.Camera according to the current values of the properties.

Returns void
- Defined in src/olcs/Camera.ts:246

updateView

updateView(): void
Calculates the values of the properties from the current Cesium.Camera state. Modifies the center, resolution and rotation properties of the view.

Returns void
- Defined in src/olcs/Camera.ts:306

Class OLCSCamera

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns OLCSCamera

Properties

Private cam_

Private distance_

Private fromLonLat_

Type declaration

Parameters

Returns number[]

Private lastCameraViewMatrix_

Private map_

Private scene_

Private tilt_

Private toLonLat_

Type declaration

Parameters

Returns number[]

Private viewListenKey_

Private viewUpdateInProgress_

Private view_

Methods

calcDistanceForResolution

Parameters

Returns number

calcResolutionForDistance

Parameters

Returns number

checkCameraChange

Parameters

Returns void

destroy

Returns void

getAltitude

Returns number

getCenter

Returns Coordinate

Deprecated

Api

getDistance

Returns number

getHeading

Returns number

Deprecated

getPosition

Returns number[]

Api

getTilt

Returns number

Private handleViewChangedEvent_

Returns void

readFromView

Returns void

setAltitude

Parameters

Returns void

setCenter

Parameters

Returns void

Deprecated

setDistance

Parameters

Returns void

setHeading

Parameters

Returns void

Deprecated

setPosition

Parameters

Returns void

setTilt

Parameters

Returns void

Private setView_

`Private` cam_

`Private` distance_

`Private` fromLonLat_

`Private` lastCameraViewMatrix_

`Private` map_

`Private` scene_

`Private` tilt_

`Private` toLonLat_

`Private` viewListenKey_

`Private` viewUpdateInProgress_

`Private` view_

`Private` handleViewChangedEvent_

`Private` setView_

`Private` updateCamera_