Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
// Automatically generated - do not modify!
@file:Suppress(
"NON_EXTERNAL_DECLARATION_IN_INAPPROPRIATE_FILE",
"EXTERNAL_CLASS_CONSTRUCTOR_PROPERTY_PARAMETER",
)
package cesium
/**
* A base widget for building applications. It composites all of the standard Cesium widgets into one reusable package.
* The widget can always be extended by using mixins, which add functionality useful for a variety of applications.
* ```
* //Initialize the viewer widget with several custom options and mixins.
* var viewer = new Viewer('cesiumContainer', {
* //Start in Columbus Viewer
* sceneMode : SceneMode.COLUMBUS_VIEW,
* //Use Cesium World Terrain
* terrainProvider : createWorldTerrain(),
* //Hide the base layer picker
* baseLayerPicker : false,
* //Use OpenStreetMaps
* imageryProvider : new OpenStreetMapImageryProvider({
* url : 'https://a.tile.openstreetmap.org/'
* }),
* skyBox : new SkyBox({
* sources : {
* positiveX : 'stars/TychoSkymapII.t3_08192x04096_80_px.jpg',
* negativeX : 'stars/TychoSkymapII.t3_08192x04096_80_mx.jpg',
* positiveY : 'stars/TychoSkymapII.t3_08192x04096_80_py.jpg',
* negativeY : 'stars/TychoSkymapII.t3_08192x04096_80_my.jpg',
* positiveZ : 'stars/TychoSkymapII.t3_08192x04096_80_pz.jpg',
* negativeZ : 'stars/TychoSkymapII.t3_08192x04096_80_mz.jpg'
* }
* }),
* // Show Columbus View map with Web Mercator projection
* mapProjection : new WebMercatorProjection()
* });
*
* //Add basic drag and drop functionality
* viewer.extend(viewerDragDropMixin);
*
* //Show a pop-up alert if we encounter an error when processing a dropped file
* viewer.dropError.addEventListener(function(dropHandler, name, error) {
* console.log(error);
* window.alert(error);
* });
* ```
* @see Online Documentation
*
* @constructor
* @property [container] The DOM element that will contain the widget.
* @see Online Documentation
*/
@JsName("\$cesium__Viewer")
external class Viewer(
val container: org.w3c.dom.Element,
options: ConstructorOptions? = definedExternally,
) {
/**
* Gets the DOM element for the area at the bottom of the window containing the
* [CreditDisplay] and potentially other things.
* @see Online Documentation
*/
val bottomContainer: org.w3c.dom.Element
/**
* Gets the CesiumWidget.
* @see Online Documentation
*/
val cesiumWidget: CesiumWidget
/**
* Gets the selection indicator.
* @see Online Documentation
*/
val selectionIndicator: SelectionIndicator
/**
* Gets the info box.
* @see Online Documentation
*/
val infoBox: InfoBox
/**
* Gets the Geocoder.
* @see Online Documentation
*/
val geocoder: Geocoder
/**
* Gets the HomeButton.
* @see Online Documentation
*/
val homeButton: HomeButton
/**
* Gets the SceneModePicker.
* @see Online Documentation
*/
val sceneModePicker: SceneModePicker
/**
* Gets the ProjectionPicker.
* @see Online Documentation
*/
val projectionPicker: ProjectionPicker
/**
* Gets the BaseLayerPicker.
* @see Online Documentation
*/
val baseLayerPicker: BaseLayerPicker
/**
* Gets the NavigationHelpButton.
* @see Online Documentation
*/
val navigationHelpButton: NavigationHelpButton
/**
* Gets the Animation widget.
* @see Online Documentation
*/
val animation: Animation
/**
* Gets the Timeline widget.
* @see Online Documentation
*/
val timeline: Timeline
/**
* Gets the FullscreenButton.
* @see Online Documentation
*/
val fullscreenButton: FullscreenButton
/**
* Gets the VRButton.
* @see Online Documentation
*/
val vrButton: VRButton
/**
* Gets the display used for [DataSource] visualization.
* @see Online Documentation
*/
val dataSourceDisplay: DataSourceDisplay
/**
* Gets the collection of entities not tied to a particular data source.
* This is a shortcut to [dataSourceDisplay.defaultDataSource.entities][Viewer.dataSourceDisplay].
* @see Online Documentation
*/
val entities: EntityCollection
/**
* Gets the set of [DataSource] instances to be visualized.
* @see Online Documentation
*/
val dataSources: DataSourceCollection
/**
* Gets the canvas.
* @see Online Documentation
*/
val canvas: org.w3c.dom.HTMLCanvasElement
/**
* Gets the scene.
* @see Online Documentation
*/
val scene: Scene
/**
* Determines if shadows are cast by light sources.
* @see Online Documentation
*/
var shadows: Boolean
/**
* Determines if the terrain casts or shadows from light sources.
* @see Online Documentation
*/
var terrainShadows: ShadowMode
/**
* Get the scene's shadow map
* @see Online Documentation
*/
val shadowMap: ShadowMap
/**
* Gets the collection of image layers that will be rendered on the globe.
* @see Online Documentation
*/
val imageryLayers: ImageryLayerCollection
/**
* The terrain provider providing surface geometry for the globe.
* @see Online Documentation
*/
var terrainProvider: TerrainProvider
/**
* Gets the camera.
* @see Online Documentation
*/
val camera: Camera
/**
* Gets the post-process stages.
* @see Online Documentation
*/
val postProcessStages: PostProcessStageCollection
/**
* Gets the clock.
* @see Online Documentation
*/
val clock: Clock
/**
* Gets the clock view model.
* @see Online Documentation
*/
val clockViewModel: ClockViewModel
/**
* Gets the screen space event handler.
* @see Online Documentation
*/
val screenSpaceEventHandler: ScreenSpaceEventHandler
/**
* Gets or sets the target frame rate of the widget when `useDefaultRenderLoop`
* is true. If undefined, the browser's [requestAnimationFrame] implementation
* determines the frame rate. If defined, this value must be greater than 0. A value higher
* than the underlying requestAnimationFrame implementation will have no effect.
* @see Online Documentation
*/
var targetFrameRate: Int
/**
* Gets or sets whether or not this widget should control the render loop.
* If set to true the widget will use [requestAnimationFrame] to
* perform rendering and resizing of the widget, as well as drive the
* simulation clock. If set to false, you must manually call the
* `resize`, `render` methods
* as part of a custom render loop. If an error occurs during rendering, [Scene]'s
* `renderError` event will be raised and this property
* will be set to false. It must be set back to true to continue rendering
* after the error.
* @see Online Documentation
*/
var useDefaultRenderLoop: Boolean
/**
* Gets or sets a scaling factor for rendering resolution. Values less than 1.0 can improve
* performance on less powerful devices while values greater than 1.0 will render at a higher
* resolution and then scale down, resulting in improved visual fidelity.
* For example, if the widget is laid out at a size of 640x480, setting this value to 0.5
* will cause the scene to be rendered at 320x240 and then scaled up while setting
* it to 2.0 will cause the scene to be rendered at 1280x960 and then scaled down.
* @see Online Documentation
*/
var resolutionScale: Double
/**
* Boolean flag indicating if the browser's recommended resolution is used.
* If true, the browser's device pixel ratio is ignored and 1.0 is used instead,
* effectively rendering based on CSS pixels instead of device pixels. This can improve
* performance on less powerful devices that have high pixel density. When false, rendering
* will be in device pixels. [Viewer.resolutionScale] will still take effect whether
* this flag is true or false.
* @see Online Documentation
*/
var useBrowserRecommendedResolution: Boolean
/**
* Gets or sets whether or not data sources can temporarily pause
* animation in order to avoid showing an incomplete picture to the user.
* For example, if asynchronous primitives are being processed in the
* background, the clock will not advance until the geometry is ready.
* @see Online Documentation
*/
var allowDataSourcesToSuspendAnimation: Boolean
/**
* Gets or sets the Entity instance currently being tracked by the camera.
* @see Online Documentation
*/
var trackedEntity: Entity?
/**
* Gets or sets the object instance for which to display a selection indicator.
*
* If a user interactively picks a Cesium3DTilesFeature instance, then this property
* will contain a transient Entity instance with a property named "feature" that is
* the instance that was picked.
* @see Online Documentation
*/
var selectedEntity: Entity?
/**
* Gets the event that is raised when the selected entity changes.
* @see Online Documentation
*/
val selectedEntityChanged: Event
/**
* Gets the event that is raised when the tracked entity changes.
* @see Online Documentation
*/
val trackedEntityChanged: Event
/**
* Gets or sets the data source to track with the viewer's clock.
* @see Online Documentation
*/
var clockTrackedDataSource: DataSource
/**
* Extends the base viewer functionality with the provided mixin.
* A mixin may add additional properties, functions, or other behavior
* to the provided viewer instance.
* @param [mixin] The Viewer mixin to add to this instance.
* @param [options] The options object to be passed to the mixin function.
* @see Online Documentation
*/
fun extend(
mixin: ViewerMixin,
options: Any? = definedExternally,
)
/**
* Resizes the widget to match the container size.
* This function is called automatically as needed unless
* `useDefaultRenderLoop` is set to false.
* @see Online Documentation
*/
fun resize()
/**
* This forces the widget to re-think its layout, including
* widget sizes and credit placement.
* @see Online Documentation
*/
fun forceResize()
/**
* Renders the scene. This function is called automatically
* unless `useDefaultRenderLoop` is set to false;
* @see Online Documentation
*/
fun render()
/**
* @return true if the object has been destroyed, false otherwise.
* @see Online Documentation
*/
fun isDestroyed(): Boolean
/**
* Destroys the widget. Should be called if permanently
* removing the widget from layout.
* @see Online Documentation
*/
fun destroy()
/**
* Asynchronously sets the camera to view the provided entity, entities, or data source.
* If the data source is still in the process of loading or the visualization is otherwise still loading,
* this method waits for the data to be ready before performing the zoom.
*
* The offset is heading/pitch/range in the local east-north-up reference frame centered at the center of the bounding sphere.
* The heading and the pitch angles are defined in the local east-north-up reference frame.
* The heading is the angle from y axis and increasing towards the x axis. Pitch is the rotation from the xy-plane. Positive pitch
* angles are above the plane. Negative pitch angles are below the plane. The range is the distance from the center. If the range is
* zero, a range will be computed such that the whole bounding sphere is visible.
*
* In 2D, there must be a top down view. The camera will be placed above the target looking down. The height above the
* target will be the range. The heading will be determined from the offset. If the heading cannot be
* determined from the offset, the heading will be north.
* @param [target] The entity, array of entities, entity collection, data source, Cesium3DTileset, point cloud, or imagery layer to view. You can also pass a promise that resolves to one of the previously mentioned types.
* @param [offset] The offset from the center of the entity in the local east-north-up reference frame.
* @return A Promise that resolves to true if the zoom was successful or false if the target is not currently visualized in the scene or the zoom was cancelled.
* @see Online Documentation
*/
fun zoomTo(
target: Entity,
offset: HeadingPitchRange? = definedExternally,
): kotlin.js.Promise
fun zoomTo(
target: Array,
offset: HeadingPitchRange? = definedExternally,
): kotlin.js.Promise
fun zoomTo(
target: EntityCollection,
offset: HeadingPitchRange? = definedExternally,
): kotlin.js.Promise
fun zoomTo(
target: DataSource,
offset: HeadingPitchRange? = definedExternally,
): kotlin.js.Promise
fun zoomTo(
target: ImageryLayer,
offset: HeadingPitchRange? = definedExternally,
): kotlin.js.Promise
fun zoomTo(
target: Cesium3DTileset,
offset: HeadingPitchRange? = definedExternally,
): kotlin.js.Promise
fun zoomTo(
target: TimeDynamicPointCloud,
offset: HeadingPitchRange? = definedExternally,
): kotlin.js.Promise
fun zoomTo(
target: kotlin.js.Promise,
offset: HeadingPitchRange? = definedExternally,
): kotlin.js.Promise
fun zoomTo(
target: kotlin.js.Promise>,
offset: HeadingPitchRange? = definedExternally,
): kotlin.js.Promise
fun zoomTo(
target: kotlin.js.Promise,
offset: HeadingPitchRange? = definedExternally,
): kotlin.js.Promise
fun zoomTo(
target: kotlin.js.Promise,
offset: HeadingPitchRange? = definedExternally,
): kotlin.js.Promise
fun zoomTo(
target: kotlin.js.Promise,
offset: HeadingPitchRange? = definedExternally,
): kotlin.js.Promise
fun zoomTo(
target: kotlin.js.Promise,
offset: HeadingPitchRange? = definedExternally,
): kotlin.js.Promise
fun zoomTo(
target: kotlin.js.Promise,
offset: HeadingPitchRange? = definedExternally,
): kotlin.js.Promise
/**
* Flies the camera to the provided entity, entities, or data source.
* If the data source is still in the process of loading or the visualization is otherwise still loading,
* this method waits for the data to be ready before performing the flight.
*
* The offset is heading/pitch/range in the local east-north-up reference frame centered at the center of the bounding sphere.
* The heading and the pitch angles are defined in the local east-north-up reference frame.
* The heading is the angle from y axis and increasing towards the x axis. Pitch is the rotation from the xy-plane. Positive pitch
* angles are above the plane. Negative pitch angles are below the plane. The range is the distance from the center. If the range is
* zero, a range will be computed such that the whole bounding sphere is visible.
*
* In 2D, there must be a top down view. The camera will be placed above the target looking down. The height above the
* target will be the range. The heading will be determined from the offset. If the heading cannot be
* determined from the offset, the heading will be north.
* @param [target] The entity, array of entities, entity collection, data source, Cesium3DTileset, point cloud, or imagery layer to view. You can also pass a promise that resolves to one of the previously mentioned types.
* @return A Promise that resolves to true if the flight was successful or false if the target is not currently visualized in the scene or the flight was cancelled. //TODO: Cleanup entity mentions
* @see Online Documentation
*/
fun flyTo(
target: Entity,
options: FlyToOptions? = definedExternally,
): kotlin.js.Promise
/**
* @property [duration] The duration of the flight in seconds.
* Default value - `3.0`
* @property [maximumHeight] The maximum height at the peak of the flight.
* @property [offset] The offset from the target in the local east-north-up reference frame centered at the target.
*/
interface FlyToOptions {
var duration: Double?
var maximumHeight: Double?
var offset: HeadingPitchRange?
}
fun flyTo(
target: Array,
options: FlyToOptions? = definedExternally,
): kotlin.js.Promise
fun flyTo(
target: EntityCollection,
options: FlyToOptions? = definedExternally,
): kotlin.js.Promise
fun flyTo(
target: DataSource,
options: FlyToOptions? = definedExternally,
): kotlin.js.Promise
fun flyTo(
target: ImageryLayer,
options: FlyToOptions? = definedExternally,
): kotlin.js.Promise
fun flyTo(
target: Cesium3DTileset,
options: FlyToOptions? = definedExternally,
): kotlin.js.Promise
fun flyTo(
target: TimeDynamicPointCloud,
options: FlyToOptions? = definedExternally,
): kotlin.js.Promise
fun flyTo(
target: kotlin.js.Promise,
options: FlyToOptions? = definedExternally,
): kotlin.js.Promise
fun flyTo(
target: kotlin.js.Promise>,
options: FlyToOptions? = definedExternally,
): kotlin.js.Promise
fun flyTo(
target: kotlin.js.Promise,
options: FlyToOptions? = definedExternally,
): kotlin.js.Promise
fun flyTo(
target: kotlin.js.Promise,
options: FlyToOptions? = definedExternally,
): kotlin.js.Promise
fun flyTo(
target: kotlin.js.Promise,
options: FlyToOptions? = definedExternally,
): kotlin.js.Promise
fun flyTo(
target: kotlin.js.Promise,
options: FlyToOptions? = definedExternally,
): kotlin.js.Promise
fun flyTo(
target: kotlin.js.Promise,
options: FlyToOptions? = definedExternally,
): kotlin.js.Promise
/**
* Initialization options for the Viewer constructor
* @property [animation] If set to false, the Animation widget will not be created.
* Default value - `true`
* @property [baseLayerPicker] If set to false, the BaseLayerPicker widget will not be created.
* Default value - `true`
* @property [fullscreenButton] If set to false, the FullscreenButton widget will not be created.
* Default value - `true`
* @property [vrButton] If set to true, the VRButton widget will be created.
* Default value - `false`
* @property [geocoder] If set to false, the Geocoder widget will not be created.
* Default value - `true`
* @property [homeButton] If set to false, the HomeButton widget will not be created.
* Default value - `true`
* @property [infoBox] If set to false, the InfoBox widget will not be created.
* Default value - `true`
* @property [sceneModePicker] If set to false, the SceneModePicker widget will not be created.
* Default value - `true`
* @property [selectionIndicator] If set to false, the SelectionIndicator widget will not be created.
* Default value - `true`
* @property [timeline] If set to false, the Timeline widget will not be created.
* Default value - `true`
* @property [navigationHelpButton] If set to false, the navigation help button will not be created.
* Default value - `true`
* @property [navigationInstructionsInitiallyVisible] True if the navigation instructions should initially be visible, or false if the should not be shown until the user explicitly clicks the button.
* Default value - `true`
* @property [scene3DOnly] When `true`, each geometry instance will only be rendered in 3D to save GPU memory.
* Default value - `false`
* @property [shouldAnimate] `true` if the clock should attempt to advance simulation time by default, `false` otherwise. This option takes precedence over setting [Viewer.clockViewModel].
* Default value - `false`
* @property [clockViewModel] The clock view model to use to control current time.
* Default value - [ClockViewModel(clock)][ClockViewModel]
* @property [selectedImageryProviderViewModel] The view model for the current base imagery layer, if not supplied the first available base layer is used. This value is only valid if `baseLayerPicker` is set to true.
* @property [imageryProviderViewModels] The array of ProviderViewModels to be selectable from the BaseLayerPicker. This value is only valid if `baseLayerPicker` is set to true.
* Default value - `createDefaultImageryProviderViewModels()`
* @property [selectedTerrainProviderViewModel] The view model for the current base terrain layer, if not supplied the first available base layer is used. This value is only valid if `baseLayerPicker` is set to true.
* @property [terrainProviderViewModels] The array of ProviderViewModels to be selectable from the BaseLayerPicker. This value is only valid if `baseLayerPicker` is set to true.
* Default value - `createDefaultTerrainProviderViewModels()`
* @property [imageryProvider] The imagery provider to use. This value is only valid if `baseLayerPicker` is set to false.
* Default value - [createWorldImagery()][createWorldImagery]
* @property [terrainProvider] The terrain provider to use
* Default value - [EllipsoidTerrainProvider()][EllipsoidTerrainProvider]
* @property [skyBox] The skybox used to render the stars. When `undefined`, the default stars are used. If set to `false`, no skyBox, Sun, or Moon will be added.
* @property [skyAtmosphere] Blue sky, and the glow around the Earth's limb. Set to `false` to turn it off.
* @property [fullscreenElement] The element or id to be placed into fullscreen mode when the full screen button is pressed.
* Default value - `document.body`
* @property [useDefaultRenderLoop] True if this widget should control the render loop, false otherwise.
* Default value - `true`
* @property [targetFrameRate] The target frame rate when using the default render loop.
* @property [showRenderLoopErrors] If true, this widget will automatically display an HTML panel to the user containing the error, if a render loop error occurs.
* Default value - `true`
* @property [useBrowserRecommendedResolution] If true, render at the browser's recommended resolution and ignore `window.devicePixelRatio`.
* Default value - `true`
* @property [automaticallyTrackDataSourceClocks] If true, this widget will automatically track the clock settings of newly added DataSources, updating if the DataSource's clock changes. Set this to false if you want to configure the clock independently.
* Default value - `true`
* @property [contextOptions] Context and WebGL creation properties corresponding to `options` passed to [Scene].
* @property [sceneMode] The initial scene mode.
* Default value - [SceneMode.SCENE3D]
* @property [mapProjection] The map projection to use in 2D and Columbus View modes.
* Default value - [GeographicProjection()][GeographicProjection]
* @property [globe] The globe to use in the scene. If set to `false`, no globe will be added.
* Default value - [Globe(mapProjection.ellipsoid)][Globe]
* @property [orderIndependentTranslucency] If true and the configuration supports it, use order independent translucency.
* Default value - `true`
* @property [creditContainer] The DOM element that will contain the [CreditDisplay]. If not specified, the credits are added to the bottom of the widget itself.
* @property [creditViewport] The DOM element that will contain the credit pop up created by the [CreditDisplay]. If not specified, it will appear over the widget itself.
* @property [dataSources] The collection of data sources visualized by the widget. If this parameter is provided,
* the instance is assumed to be owned by the caller and will not be destroyed when the viewer is destroyed.
* Default value - [DataSourceCollection()][DataSourceCollection]
* @property [shadows] Determines if shadows are cast by light sources.
* Default value - `false`
* @property [terrainShadows] Determines if the terrain casts or receives shadows from light sources.
* Default value - [ShadowMode.RECEIVE_ONLY]
* @property [mapMode2D] Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction.
* Default value - [MapMode2D.INFINITE_SCROLL]
* @property [projectionPicker] If set to true, the ProjectionPicker widget will be created.
* Default value - `false`
* @property [requestRenderMode] If true, rendering a frame will only occur when needed as determined by changes within the scene. Enabling reduces the CPU/GPU usage of your application and uses less battery on mobile, but requires using [Scene.requestRender] to render a new frame explicitly in this mode. This will be necessary in many cases after making changes to the scene in other parts of the API. See [Improving Performance with Explicit Rendering](https://cesium.com/blog/2018/01/24/cesium-scene-rendering-performance/).
* Default value - `false`
* @property [maximumRenderTimeChange] If requestRenderMode is true, this value defines the maximum change in simulation time allowed before a render is requested. See [Improving Performance with Explicit Rendering](https://cesium.com/blog/2018/01/24/cesium-scene-rendering-performance/).
* Default value - `0.0`
* @see Online Documentation
*/
interface ConstructorOptions {
var animation: Boolean?
var baseLayerPicker: Boolean?
var fullscreenButton: Boolean?
var vrButton: Boolean?
var geocoder: dynamic
var homeButton: Boolean?
var infoBox: Boolean?
var sceneModePicker: Boolean?
var selectionIndicator: Boolean?
var timeline: Boolean?
var navigationHelpButton: Boolean?
var navigationInstructionsInitiallyVisible: Boolean?
var scene3DOnly: Boolean?
var shouldAnimate: Boolean?
var clockViewModel: ClockViewModel?
var selectedImageryProviderViewModel: ProviderViewModel?
var imageryProviderViewModels: Array?
var selectedTerrainProviderViewModel: ProviderViewModel?
var terrainProviderViewModels: Array?
var imageryProvider: ImageryProvider?
var terrainProvider: TerrainProvider?
var skyBox: dynamic
var skyAtmosphere: dynamic
var fullscreenElement: org.w3c.dom.Element?
var useDefaultRenderLoop: Boolean?
var targetFrameRate: Int?
var showRenderLoopErrors: Boolean?
var useBrowserRecommendedResolution: Boolean?
var automaticallyTrackDataSourceClocks: Boolean?
var contextOptions: Any?
var sceneMode: SceneMode?
var mapProjection: MapProjection?
var globe: dynamic
var orderIndependentTranslucency: Boolean?
var creditContainer: org.w3c.dom.Element?
var creditViewport: org.w3c.dom.Element?
var dataSources: DataSourceCollection?
var shadows: Boolean?
var terrainShadows: ShadowMode?
var mapMode2D: MapMode2D?
var projectionPicker: Boolean?
var requestRenderMode: Boolean?
var maximumRenderTimeChange: Double?
}
}
/**
* A function that augments a Viewer instance with additional functionality.
* @param [viewer] The viewer instance.
* @param [options] Options object to be passed to the mixin function.
* @see Online Documentation
*/
typealias ViewerMixin = (viewer: Viewer, options: Any) -> Unit
