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 widget containing a Cesium scene.
* ```
* // For each example, include a link to CesiumWidget.css stylesheet in HTML head,
* // and in the body, include:
*
* //Widget with no terrain and default Bing Maps imagery provider.
* var widget = new CesiumWidget('cesiumContainer');
*
* //Widget with ion imagery and Cesium World Terrain.
* var widget = new CesiumWidget('cesiumContainer', {
* imageryProvider : createWorldImagery(),
* terrainProvider : createWorldTerrain(),
* 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
* sceneMode : SceneMode.COLUMBUS_VIEW,
* mapProjection : new WebMercatorProjection()
* });
* ```
* @see Online Documentation
*
* @constructor
* @property [container] The DOM element that will contain the widget.
* @see Online Documentation
*/
@JsName("\$cesium__CesiumWidget")
external class CesiumWidget(
val container: org.w3c.dom.Element,
options: ConstructorOptions? = definedExternally,
) {
/**
* @property [clock] The clock to use to control current time.
* Default value - [Clock()][Clock]
* @property [imageryProvider] The imagery provider to serve as the base layer. If set to `false`, no imagery provider will be added.
* Default value - [createWorldImagery()][createWorldImagery]
* @property [terrainProvider] The terrain provider.
* 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 [sceneMode] The initial scene mode.
* Default value - [SceneMode.SCENE3D]
* @property [scene3DOnly] When `true`, each geometry instance will only be rendered in 3D to save GPU memory.
* Default value - `false`
* @property [orderIndependentTranslucency] If true and the configuration supports it, use order independent translucency.
* Default value - `true`
* @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 [useDefaultRenderLoop] True if this widget should control the render loop, false otherwise.
* Default value - `true`
* @property [useBrowserRecommendedResolution] If true, render at the browser's recommended resolution and ignore `window.devicePixelRatio`.
* 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 [contextOptions] Context and WebGL creation properties corresponding to `options` passed to [Scene].
* @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 [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 [requestRenderMode] If true, rendering a frame will only occur when needed as determined by changes within the scene. Enabling improves performance of the application, 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`
*/
interface ConstructorOptions {
var clock: Clock?
var imageryProvider: dynamic
var terrainProvider: TerrainProvider?
var skyBox: dynamic
var skyAtmosphere: dynamic
var sceneMode: SceneMode?
var scene3DOnly: Boolean?
var orderIndependentTranslucency: Boolean?
var mapProjection: MapProjection?
var globe: dynamic
var useDefaultRenderLoop: Boolean?
var useBrowserRecommendedResolution: Boolean?
var targetFrameRate: Int?
var showRenderLoopErrors: Boolean?
var contextOptions: Any?
var creditContainer: org.w3c.dom.Element?
var creditViewport: org.w3c.dom.Element?
var shadows: Boolean?
var terrainShadows: ShadowMode?
var mapMode2D: MapMode2D?
var requestRenderMode: Boolean?
var maximumRenderTimeChange: Double?
}
/**
* Gets the canvas.
* @see Online Documentation
*/
val canvas: org.w3c.dom.HTMLCanvasElement
/**
* Gets the credit container.
* @see Online Documentation
*/
val creditContainer: org.w3c.dom.Element
/**
* Gets the credit viewport
* @see Online Documentation
*/
val creditViewport: org.w3c.dom.Element
/**
* Gets the scene.
* @see Online Documentation
*/
val scene: Scene
/**
* 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 clock.
* @see Online Documentation
*/
val clock: Clock
/**
* 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. [CesiumWidget.resolutionScale] will still take effect whether
* this flag is true or false.
* @see Online Documentation
*/
var useBrowserRecommendedResolution: Boolean
/**
* Show an error panel to the user containing a title and a longer error message,
* which can be dismissed using an OK button. This panel is displayed automatically
* when a render loop error occurs, if showRenderLoopErrors was not false when the
* widget was constructed.
* @param [title] The title to be displayed on the error panel. This string is interpreted as text.
* @param [message] A helpful, user-facing message to display prior to the detailed error information. This string is interpreted as HTML.
* @param [error] The error to be displayed on the error panel. This string is formatted using [formatError] and then displayed as text.
* @see Online Documentation
*/
fun showErrorPanel(
title: String,
message: String? = definedExternally,
error: String? = definedExternally,
)
/**
* @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()
/**
* Updates the canvas size, camera aspect ratio, and viewport size.
* This function is called automatically as needed unless
* `useDefaultRenderLoop` is set to false.
* @see Online Documentation
*/
fun resize()
/**
* Renders the scene. This function is called automatically
* unless `useDefaultRenderLoop` is set to false;
* @see Online Documentation
*/
fun render()
}
