Scene (CesiumJS GWT Wrapper 1.59.4 API)

java.lang.Object
- org.cesiumjs.cs.scene.Scene

@JsType(isNative=true,
        namespace="Cesium",
        name="Scene")
public class Scene
extends Object

Author:: Serge Silaev aka iSergio

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Scene.DebugCommandFilter

static interface Scene.Listener

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Scene.DebugCommandFilter`
`static interface`	`Scene.Listener`

Field Summary

Fields
Modifier and Type	Field and Description
`Color`	`backgroundColor` The background color, which is only visible if there is no sky box, i.e., Scene#skyBox is undefined.
`boolean`	`completeMorphOnUserInput` Determines whether or not to instantly complete the scene transition animation on user input.
`Scene.DebugCommandFilter`	`debugCommandFilter` This property is for debugging only; it is not for production use.
`boolean`	`debugShowCommands` This property is for debugging only; it is not for production use.
`int`	`debugShowDepthFrustum` This property is for debugging only; it is not for production use.
`boolean`	`debugShowFramesPerSecond` This property is for debugging only; it is not for production use.
`boolean`	`debugShowFrustums` This property is for debugging only; it is not for production use.
`boolean`	`debugShowGlobeDepth` This property is for debugging only; it is not for production use.
`double`	`eyeSeparation` The eye separation distance in meters for use with cardboard or WebVR.
`double`	`farToNearRatio` The far-to-near ratio of the multi-frustum.
`double`	`focalLength` The focal length for use when with cardboard or WebVR.
`Fog`	`fog` Blends the atmosphere to geometry far from the camera for horizon views.
`Globe`	`globe` Gets or sets the depth-test ellipsoid.
`double`	`imagerySplitPosition` Gets or sets the position of the Imagery splitter within the viewport.
`boolean`	`invertClassification` When false, 3D Tiles will render normally.
`Color`	`invertClassificationColor` The highlight color of unclassified 3D Tile geometry when Scene#invertClassification is true.
`boolean`	`logarithmicDepthBuffer` Whether or not to use a logarithmic depth buffer.
`double`	`logarithmicDepthFarToNearRatio` The far-to-near ratio of the multi-frustum when using a logarithmic depth buffer.
`boolean`	`mapMode2D` Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction.
`double`	`maximumRenderTimeChange` If `requestRenderMode` is true, this value defines the maximum change in simulation time allowed before a render is requested.
`Number`	`mode` Gets or sets the current mode of the scene.
`Moon`	`moon` The Moon Default: undefined
`Event`	`morphComplete` The event fired at the completion of a scene transition.
`Event`	`morphStart` The event fired at the beginning of a scene transition.
`double`	`morphTime` The current morph transition time between 2D/Columbus View and 3D, with 0.0 being 2D or Columbus View and 1.0 being 3D.
`double`	`nearToFarDistance2D` Determines the uniform depth size in meters of each frustum of the multifrustum in 2D.
`boolean`	`pickTranslucentDepth` When true, enables picking translucent geometry using the depth buffer.
`PostProcessStageCollection`	`postProcessStages` Post processing effects applied to the final render.
`boolean`	`requestRenderMode` When true, rendering a frame will only occur when needed as determined by changes within the scene.
`boolean`	`rethrowRenderErrors` Exceptions occurring in render are always caught in order to raise the renderError event.
`ShadowMap`	`shadowMap` The shadow map in the scene.
`SkyAtmosphere`	`skyAtmosphere` The sky atmosphere drawn around the globe.
`SkyBox`	`skyBox` The SkyBox used to draw the stars.
`String`	`specularEnvironmentMaps` The url to the KTX file containing the specular environment map and convoluted mipmaps for image-based lighting of PBR models.
`Cartesian3[]`	`sphericalHarmonicCoefficients` The spherical harmonic coefficients for image-based lighting of PBR models.
`Sun`	`sun` The Sun.
`boolean`	`sunBloom` Uses a bloom filter on the sun when enabled.
`double`	`terrainExaggeration` Gets the scalar used to exaggerate the terrain.
`TerrainProvider`	`terrainProvider` The terrain provider providing surface geometry for the globe.
`boolean`	`useDepthPicking` When true, enables picking using the depth buffer.
`boolean`	`useWebVR` When true, splits the scene into two viewports with steroscopic views for the left and right eyes.

Constructor Summary

Constructors
Constructor and Description
`Scene()` The container for all 3D graphical objects and state in a Cesium virtual scene.
`Scene(SceneOptions options)` The container for all 3D graphical objects and state in a Cesium virtual scene.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Camera`	`camera()` Gets the camera.
`com.google.gwt.dom.client.CanvasElement`	`canvas()` Gets the canvas element to which this scene is bound.
`Cartesian2`	`cartesianToCanvasCoordinates(Cartesian3 position)` Transforms a position in cartesian coordinates to canvas coordinates.
`Cartesian2`	`cartesianToCanvasCoordinates(Cartesian3 position, Cartesian2 result)` Transforms a position in cartesian coordinates to canvas coordinates.
`Cartesian3`	`clampToHeight(Cartesian3 cartesian)` Clamps the given cartesian position to the scene geometry along the geodetic surface normal.
`Cartesian3`	`clampToHeight(Cartesian3 cartesian, JsObject[] objectsToExclude)` Clamps the given cartesian position to the scene geometry along the geodetic surface normal.
`Cartesian3`	`clampToHeight(Cartesian3 cartesian, JsObject[] objectsToExclude, double width)` Clamps the given cartesian position to the scene geometry along the geodetic surface normal.
`Cartesian3`	`clampToHeight(Cartesian3 cartesian, JsObject[] objectsToExclude, double width, Cartesian3 result)` Clamps the given cartesian position to the scene geometry along the geodetic surface normal.
`Promise<Cartesian3[],Void>`	`clampToHeightMostDetailed(Cartesian3[] cartesians)` Initiates an asynchronous {link Scene#clampToHeight} query for an array of Cartesian3 positions using the maximum level of detail for 3D Tilesets in the scene.
`Promise<Cartesian3[],Void>`	`clampToHeightMostDetailed(Cartesian3[] cartesians, JsObject[] objectsToExclude)` Initiates an asynchronous {link Scene#clampToHeight} query for an array of Cartesian3 positions using the maximum level of detail for 3D Tilesets in the scene.
`Promise<Cartesian3[],Void>`	`clampToHeightMostDetailed(Cartesian3[] cartesians, JsObject[] objectsToExclude, double width)` Initiates an asynchronous {link Scene#clampToHeight} query for an array of Cartesian3 positions using the maximum level of detail for 3D Tilesets in the scene.
`boolean`	`clampToHeightSupported()` Returns true if the clampToHeight function is supported.
`void`	`completeMorph()` Instantly completes an active transition.
`Object`	`debugFrustumStatistics()` This property is for debugging only; it is not for production use.
`void`	`destroy()` Destroys the WebGL resources held by this object.
`double`	`drawingBufferHeight()` The drawingBufferWidth of the underlying GL context.
`double`	`drawingBufferWidth()` The drawingBufferHeight of the underlying GL context.
`PickedObject[]`	`drillPick(Cartesian2 windowPosition)` Returns a list of objects, each containing a `primitive` property, for all primitives at a particular window coordinate position.
`PickedObject[]`	`drillPick(Cartesian2 windowPosition, double limit)` Returns a list of objects, each containing a `primitive` property, for all primitives at a particular window coordinate position.
`PickedObject[]`	`drillPick(Cartesian2 windowPosition, double limit, int width)` Returns a list of objects, each containing a `primitive` property, for all primitives at a particular window coordinate position.
`PickedObject[]`	`drillPick(Cartesian2 windowPosition, double limit, int width, int height)` Returns a list of objects, each containing a `primitive` property, for all primitives at a particular window coordinate position.
`PrimitiveCollection`	`groundPrimitives()` Gets the collection of ground primitives.
`boolean`	`highDynamicRangeSupported()` Whether or not high dynamic range rendering is supported.
`String`	`id()` Gets the unique identifier for this scene.
`ImageryLayerCollection`	`imageryLayers()` Gets the collection of imagery layers that will be rendered on the globe.
`boolean`	`invertClassificationSupported()` Returns true if the `invertClassification` is supported.
`boolean`	`isDestroyed()` Returns true if this object was destroyed; otherwise, false.
`JulianDate`	`lastRenderTime()` Gets the simulation time when the scene was last rendered.
`MapProjection`	`mapProjection()` Get the map projection to use in 2D and Columbus View modes.
`int`	`maximumAliasedLineWidth()` The maximum aliased line width, in pixels, supported by this WebGL implementation.
`int`	`maximumCubeMapSize()` The maximum length in pixels of one edge of a cube map, supported by this WebGL implementation.
`void`	`morphTo2D()` Asynchronously transitions the scene to 2D.
`void`	`morphTo2D(double duration)` Asynchronously transitions the scene to 2D.
`void`	`morphTo3D()` Asynchronously transitions the scene to 3D.
`void`	`morphTo3D(double duration)` Asynchronously transitions the scene to 3D.
`void`	`morphToColumbusView()` Asynchronously transitions the scene to Columbus View.
`void`	`morphToColumbusView(double duration)` Asynchronously transitions the scene to Columbus View.
`boolean`	`orderIndependentTranslucency()` Gets whether or not the scene has order independent translucency enabled.
`PickedObject`	`pick(Cartesian2 windowPosition)` Returns an object with a `primitive` property that contains the first (top) primitive in the scene at a particular window coordinate or undefined if nothing is at the location.
`Cartesian3`	`pickPosition(Cartesian2 windowPosition)` Returns the cartesian position reconstructed from the depth buffer and window position.
`Cartesian3`	`pickPosition(Cartesian2 windowPosition, Cartesian3 result)` Returns the cartesian position reconstructed from the depth buffer and window position.
`boolean`	`pickPositionSupported()` Returns true if the pickPosition function is supported.
`Event`	`postRender()` Gets the event that will be raised at the end of each call to render.
`Event`	`postUpdate()` Gets the event that will be raised immediately after the scene is updated and before the scene is rendered.
`Event`	`preRender()` Gets the event that will be raised at the start of each call to render.
`Event`	`preUpdate()` Gets the event that will be raised before the scene is updated or rendered.
`PrimitiveCollection`	`primitives()` Gets the collection of primitives.
`Event`	`renderError()` Gets the event that will be raised when an error is thrown inside the render function.
`void`	`requestRender()` Requests a new rendered frame when Scene#requestRenderMode is set to true.
`double`	`sampleHeight(Cartographic position)` Returns the height of scene geometry at the given cartographic position or undefined if there was no scene geometry to sample height from.
`double`	`sampleHeight(Cartographic position, JsObject[] objectsToExclude)` Returns the height of scene geometry at the given cartographic position or undefined if there was no scene geometry to sample height from.
`double`	`sampleHeight(Cartographic position, JsObject[] objectsToExclude, double width)` Returns the height of scene geometry at the given cartographic position or undefined if there was no scene geometry to sample height from.
`Promise<double[],Void>`	`sampleHeightMostDetailed(Cartographic[] positions)` Initiates an asynchronous `sampleHeight(org.cesiumjs.cs.core.Cartographic)` query for an array of Cartographic positions using the maximum level of detail for 3D Tilesets in the scene.
`Promise<double[],Void>`	`sampleHeightMostDetailed(Cartographic[] positions, JsObject[] objectsToExclude)` Initiates an asynchronous `sampleHeight(org.cesiumjs.cs.core.Cartographic)` query for an array of Cartographic positions using the maximum level of detail for 3D Tilesets in the scene.
`Promise<double[],Void>`	`sampleHeightMostDetailed(Cartographic[] positions, JsObject[] objectsToExclude, double width)` Initiates an asynchronous `sampleHeight(org.cesiumjs.cs.core.Cartographic)` query for an array of Cartographic positions using the maximum level of detail for 3D Tilesets in the scene.
`boolean`	`sampleHeightSupported()` Returns true if the sampleHeight function is supported.
`boolean`	`scene3DOnly()` Gets whether or not the scene is optimized for 3D only viewing.
`ScreenSpaceCameraController`	`screenSpaceCameraController()` Gets the controller for camera input handling.
`Event`	`terrainProviderChanged()` Gets an event that's raised when the terrain provider is changed

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - backgroundColor
```
@JsProperty
public Color backgroundColor
```
    The background color, which is only visible if there is no sky box, i.e., Scene#skyBox is undefined. Default: Color.BLACK
    
    See Also:
    
    skyBox
  - completeMorphOnUserInput
```
@JsProperty
public boolean completeMorphOnUserInput
```
    Determines whether or not to instantly complete the scene transition animation on user input. Default: true
  - debugCommandFilter
```
@JsProperty
public Scene.DebugCommandFilter debugCommandFilter
```
    This property is for debugging only; it is not for production use. A function that determines what commands are executed. As shown in the examples below, the function receives the command's owner as an argument, and returns a boolean indicating if the command should be executed. The default is undefined, indicating that all commands are executed.
```
     Example:
     
     _viewer.scene().debugCommandFilter = new Scene.DebugCommandFilter() {
         {@literal @}Override
         public boolean function(Object object) {
             return ((JsObject)object).getObject("owner") == _viewer.scene().skyAtmosphere;
         }
     };
     
 
```
    Default: undefined
  - debugShowCommands
```
@JsProperty
public boolean debugShowCommands
```
    This property is for debugging only; it is not for production use. When true, commands are randomly shaded. This is useful for performance analysis to see what parts of a scene or model are command-dense and could benefit from batching. Default: false
  - debugShowDepthFrustum
```
@JsProperty
public int debugShowDepthFrustum
```
    This property is for debugging only; it is not for production use. Indicates which frustum will have depth information displayed. Default: 1
  - debugShowFramesPerSecond
```
@JsProperty
public boolean debugShowFramesPerSecond
```
    This property is for debugging only; it is not for production use. Displays frames per second and time between frames. Default: false
  - debugShowFrustums
```
@JsProperty
public boolean debugShowFrustums
```
    This property is for debugging only; it is not for production use. When true, commands are shaded based on the frustums they overlap. Commands in the closest frustum are tinted red, commands in the next closest are green, and commands in the farthest frustum are blue. If a command overlaps more than one frustum, the color components are combined, e.g., a command overlapping the first two frustums is tinted yellow. Default: false
  - debugShowGlobeDepth
```
@JsProperty
public boolean debugShowGlobeDepth
```
    This property is for debugging only; it is not for production use. Displays depth information for the indicated frustum Default: false
  - eyeSeparation
```
@JsProperty
public double eyeSeparation
```
    The eye separation distance in meters for use with cardboard or WebVR.
  - farToNearRatio
```
@JsProperty
public double farToNearRatio
```
    The far-to-near ratio of the multi-frustum. The default is 1,000.0. Default: 1000.0
  - focalLength
```
@JsProperty
public double focalLength
```
    The focal length for use when with cardboard or WebVR.
  - fog
```
@JsProperty
public Fog fog
```
    Blends the atmosphere to geometry far from the camera for horizon views. Allows for additional performance improvements by rendering less geometry and dispatching less terrain requests.
  - globe
```
@JsProperty
public Globe globe
```
    Gets or sets the depth-test ellipsoid.
  - imagerySplitPosition
```
@JsProperty
public double imagerySplitPosition
```
    Gets or sets the position of the Imagery splitter within the viewport. Valid values are between 0.0 and 1.0.
  - invertClassification
```
@JsProperty
public boolean invertClassification
```
    When false, 3D Tiles will render normally. When true, classified 3D Tile geometry will render normally and unclassified 3D Tile geometry will render with the color multiplied by invertClassificationColor. Default: false
  - invertClassificationColor
```
@JsProperty
public Color invertClassificationColor
```
    The highlight color of unclassified 3D Tile geometry when Scene#invertClassification is true. When the color's alpha is less than 1.0, the unclassified portions of the 3D Tiles will not blend correctly with the classified positions of the 3D Tiles. Also, when the color's alpha is less than 1.0, the WEBGL_depth_texture and EXT_frag_depth WebGL extensions must be supported. Default: Color.WHITE()
  - logarithmicDepthBuffer
```
@JsProperty
public boolean logarithmicDepthBuffer
```
    Whether or not to use a logarithmic depth buffer. Enabling this option will allow for less frustums in the multi-frustum, increasing performance. This property relies on Context#fragmentDepth being supported.
  - logarithmicDepthFarToNearRatio
```
@JsProperty
public double logarithmicDepthFarToNearRatio
```
    The far-to-near ratio of the multi-frustum when using a logarithmic depth buffer. This value is used to create the near and far values for each frustum of the multi-frustum. It is only used when logarithmicDepthBuffer is true. When logarithmicDepthBuffer is false, use farToNearRatio. Default: 1e9
  - mapMode2D
```
@JsProperty
public boolean mapMode2D
```
    Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction.
  - maximumRenderTimeChange
```
@JsProperty
public double maximumRenderTimeChange
```
    If requestRenderMode is true, this value defines the maximum change in simulation time allowed before a render is requested. Lower values increase the number of frames rendered and higher values decrease the number of frames rendered. If undefined, changes to the simulation time will never request a render. This value impacts the rate of rendering for changes in the scene like lighting, entity property updates, and animations. Default: 0.5
  - mode
```
@JsProperty
public Number mode
```
    Gets or sets the current mode of the scene. Default: SceneMode.SCENE3D()
  - moon
```
@JsProperty
public Moon moon
```
    The Moon Default: undefined
  - morphComplete
```
@JsProperty
public Event morphComplete
```
    The event fired at the completion of a scene transition. Default: Event()
  - morphStart
```
@JsProperty
public Event morphStart
```
    The event fired at the beginning of a scene transition. Default: Event()
  - morphTime
```
@JsProperty
public double morphTime
```
    The current morph transition time between 2D/Columbus View and 3D, with 0.0 being 2D or Columbus View and 1.0 being 3D. Default: 1.0
  - nearToFarDistance2D
```
public double nearToFarDistance2D
```
    Determines the uniform depth size in meters of each frustum of the multifrustum in 2D. If a primitive or model close to the surface shows z-fighting, decreasing this will eliminate the artifact, but decrease performance. On the other hand, increasing this will increase performance but may cause z-fighting among primitives close to thesurface. Default: 1.75e6
  - pickTranslucentDepth
```
@JsProperty
public boolean pickTranslucentDepth
```
    When true, enables picking translucent geometry using the depth buffer. useDepthPicking must also be true to enable picking the depth buffer. There is a decrease in performance when enabled. There are extra draw calls to write depth for translucent geometry. Default: false
  - postProcessStages
```
@JsProperty
public PostProcessStageCollection postProcessStages
```
    Post processing effects applied to the final render.
  - requestRenderMode
```
@JsProperty
public boolean requestRenderMode
```
    When 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 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. Default: false
  - rethrowRenderErrors
```
@JsProperty
public boolean rethrowRenderErrors
```
    Exceptions occurring in render are always caught in order to raise the renderError event. If this property is true, the error is rethrown after the event is raised. If this property is false, the render function returns normally after raising the event. Default: false
  - shadowMap
```
@JsProperty
public ShadowMap shadowMap
```
    The shadow map in the scene. When enabled, models, primitives, and the globe may cast and receive shadows. By default the light source of the shadow map is the sun.
  - skyAtmosphere
```
@JsProperty
public SkyAtmosphere skyAtmosphere
```
    The sky atmosphere drawn around the globe. Default: undefined
  - skyBox
```
@JsProperty
public SkyBox skyBox
```
    The SkyBox used to draw the stars. Default: undefined
    
    See Also:
    
    backgroundColor
  - specularEnvironmentMaps
```
@JsProperty
public String specularEnvironmentMaps
```
    The url to the KTX file containing the specular environment map and convoluted mipmaps for image-based lighting of PBR models.
  - sphericalHarmonicCoefficients
```
@JsProperty
public Cartesian3[] sphericalHarmonicCoefficients
```
    The spherical harmonic coefficients for image-based lighting of PBR models.
  - sun
```
@JsProperty
public Sun sun
```
    The Sun. Default: undefined
  - sunBloom
```
@JsProperty
public boolean sunBloom
```
    Uses a bloom filter on the sun when enabled. Default: true
  - terrainExaggeration
```
@JsProperty
public double terrainExaggeration
```
    Gets the scalar used to exaggerate the terrain.
  - terrainProvider
```
@JsProperty
public TerrainProvider terrainProvider
```
    The terrain provider providing surface geometry for the globe.
  - useDepthPicking
```
@JsProperty
public boolean useDepthPicking
```
    When true, enables picking using the depth buffer. Default: true
  - useWebVR
```
@JsProperty
public boolean useWebVR
```
    When true, splits the scene into two viewports with steroscopic views for the left and right eyes. Used for cardboard and WebVR. Default Value: false
- Constructor Detail
  - Scene
```
@JsConstructor
public Scene()
```
    The container for all 3D graphical objects and state in a Cesium virtual scene. Generally, a scene is not created directly; instead, it is implicitly created by CesiumWidget.
  - Scene
```
@JsConstructor
public Scene(SceneOptions options)
```
    The container for all 3D graphical objects and state in a Cesium virtual scene. Generally, a scene is not created directly; instead, it is implicitly created by CesiumWidget.
    
    Parameters:
    
    options - Options.
- Method Detail
  - camera
```
@JsProperty(name="camera")
public Camera camera()
```
    Gets the camera.
  - canvas
```
@JsProperty(name="canvas")
public com.google.gwt.dom.client.CanvasElement canvas()
```
    Gets the canvas element to which this scene is bound.
  - debugFrustumStatistics
```
@JsProperty(name="debugFrustumStatistics")
public Object debugFrustumStatistics()
```
    This property is for debugging only; it is not for production use. When Scene.debugShowFrustums is true, this contains properties with statistics about the number of command execute per frustum. totalCommands is the total number of commands executed, ignoring overlap. commandsInFrustums is an array with the number of times commands are executed redundantly, e.g., how many commands overlap two or three frustums. Default: undefined
  - drawingBufferHeight
```
@JsProperty(name="drawingBufferHeight")
public double drawingBufferHeight()
```
    The drawingBufferWidth of the underlying GL context.
    
    See Also:
    
    drawingBufferHeight()
  - drawingBufferWidth
```
@JsProperty(name="drawingBufferWidth")
public double drawingBufferWidth()
```
    The drawingBufferHeight of the underlying GL context.
    
    See Also:
    
    drawingBufferHeight()
  - groundPrimitives
```
@JsProperty(name="groundPrimitives")
public PrimitiveCollection groundPrimitives()
```
    Gets the collection of ground primitives.
  - highDynamicRangeSupported
```
@JsProperty(name="highDynamicRangeSupported")
public boolean highDynamicRangeSupported()
```
    Whether or not high dynamic range rendering is supported.
  - id
```
@JsProperty(name="id")
public String id()
```
    Gets the unique identifier for this scene.
  - imageryLayers
```
@JsProperty(name="imageryLayers")
public ImageryLayerCollection imageryLayers()
```
    Gets the collection of imagery layers that will be rendered on the globe.
  - lastRenderTime
```
@JsProperty(name="lastRenderTime")
public JulianDate lastRenderTime()
```
    Gets the simulation time when the scene was last rendered. Returns undefined if the scene has not yet been rendered.
  - mapProjection
```
@JsProperty(name="mapProjection")
public MapProjection mapProjection()
```
    Get the map projection to use in 2D and Columbus View modes. Default: GeographicProjection
  - maximumAliasedLineWidth
```
@JsProperty(name="maximumAliasedLineWidth")
public int maximumAliasedLineWidth()
```
    The maximum aliased line width, in pixels, supported by this WebGL implementation. It will be at least one.
  - maximumCubeMapSize
```
@JsProperty(name="maximumCubeMapSize")
public int maximumCubeMapSize()
```
    The maximum length in pixels of one edge of a cube map, supported by this WebGL implementation. It will be at least 16.
  - orderIndependentTranslucency
```
@JsProperty(name="orderIndependentTranslucency")
public boolean orderIndependentTranslucency()
```
    Gets whether or not the scene has order independent translucency enabled. Note that this only reflects the original construction option, and there are other factors that could prevent OIT from functioning on a given system configuration.
  - pickPositionSupported
```
@JsProperty(name="pickPositionSupported")
public boolean pickPositionSupported()
```
    Returns true if the pickPosition function is supported.
  - postRender
```
@JsProperty(name="postRender")
public Event postRender()
```
    Gets the event that will be raised at the end of each call to render. Subscribers to the event receive the Scene instance as the first parameter and the current time as the second parameter.
  - postUpdate
```
@JsProperty(name="postUpdate")
public Event postUpdate()
```
    Gets the event that will be raised immediately after the scene is updated and before the scene is rendered. Subscribers to the event receive the Scene instance as the first parameter and the current time as the second parameter.
    
    See Also:
    
    preUpdate(), preRender(), postRender()
  - preRender
```
@JsProperty(name="preRender")
public Event preRender()
```
    Gets the event that will be raised at the start of each call to render. Subscribers to the event receive the Scene instance as the first parameter and the current time as the second parameter.
  - preUpdate
```
@JsProperty(name="preUpdate")
public Event preUpdate()
```
    Gets the event that will be raised before the scene is updated or rendered. Subscribers to the event receive the Scene instance as the first parameter and the current time as the second parameter.
    
    See Also:
    
    postRender(), preRender(), postRender()
  - primitives
```
@JsProperty(name="primitives")
public PrimitiveCollection primitives()
```
    Gets the collection of primitives.
  - renderError
```
@JsProperty(name="renderError")
public Event renderError()
```
    Gets the event that will be raised when an error is thrown inside the render function. The Scene instance and the thrown error are the only two parameters passed to the event handler. By default, errors are not rethrown after this event is raised, but that can be changed by setting the rethrowRenderErrors property.
  - sampleHeightSupported
```
@JsProperty(name="sampleHeightSupported")
public boolean sampleHeightSupported()
```
    Returns true if the sampleHeight function is supported.
    
    See Also:
    
    sampleHeight(org.cesiumjs.cs.core.Cartographic)
  - clampToHeightSupported
```
@JsProperty(name="clampToHeightSupported")
public boolean clampToHeightSupported()
```
    Returns true if the clampToHeight function is supported.
    
    See Also:
    
    clampToHeight(org.cesiumjs.cs.core.Cartesian3)
  - invertClassificationSupported
```
@JsProperty(name="invertClassificationSupported")
public boolean invertClassificationSupported()
```
    Returns true if the invertClassification is supported.
  - scene3DOnly
```
@JsProperty(name="scene3DOnly")
public boolean scene3DOnly()
```
    Gets whether or not the scene is optimized for 3D only viewing.
  - screenSpaceCameraController
```
@JsProperty(name="screenSpaceCameraController")
public ScreenSpaceCameraController screenSpaceCameraController()
```
    Gets the controller for camera input handling.
  - terrainProviderChanged
```
@JsProperty(name="terrainProviderChanged")
public Event terrainProviderChanged()
```
    Gets an event that's raised when the terrain provider is changed
  - cartesianToCanvasCoordinates
```
@JsMethod
public Cartesian2 cartesianToCanvasCoordinates(Cartesian3 position)
```
    Transforms a position in cartesian coordinates to canvas coordinates. This is commonly used to place an HTML element at the same screen position as an object in the scene.
    Parameters:
    
    position - The position in cartesian coordinates.
    
    Returns:
    The modified result parameter or a new Cartesian2 instance if one was not provided. This may be undefined if the input position is near the center of the ellipsoid.
    Example: ViewerPanel panel = new ViewerPanel(); panel.getViewer().extend(viewerCesiumNavigationMixin.instance(), options); final Scene scene = panel.getViewer().scene(); Ellipsoid ellipsoid = scene.globe.ellipsoid; final Cartesian3 position = Cartesian3.fromDegrees(0.0, 0.0); ScreenSpaceEventHandler handler = new ScreenSpaceEventHandler(scene.canvas()); handler.setInputAction(new ScreenSpaceEventHandler.Listener() { {@literal @}Override public void function(Object event) { Cesium.log(scene.cartesianToCanvasCoordinates(position)); } }, ScreenSpaceEventType.MOUSE_MOVE());
  - cartesianToCanvasCoordinates
```
@JsMethod
public Cartesian2 cartesianToCanvasCoordinates(Cartesian3 position,
                                                         Cartesian2 result)
```
    Transforms a position in cartesian coordinates to canvas coordinates. This is commonly used to place an HTML element at the same screen position as an object in the scene.
    Parameters:
    
    position - The position in cartesian coordinates.
    
    result - An optional object to return the input position transformed to canvas coordinates.
    
    Returns:
    The modified result parameter or a new Cartesian2 instance if one was not provided. This may be undefined if the input position is near the center of the ellipsoid.
    Example: ViewerPanel panel = new ViewerPanel(); panel.getViewer().extend(viewerCesiumNavigationMixin.instance(), options); final Scene scene = panel.getViewer().scene(); Ellipsoid ellipsoid = scene.globe.ellipsoid; final Cartesian3 position = Cartesian3.fromDegrees(0.0, 0.0); ScreenSpaceEventHandler handler = new ScreenSpaceEventHandler(scene.canvas()); handler.setInputAction(new ScreenSpaceEventHandler.Listener() { {@literal @}Override public void function(Object event) { Cesium.log(scene.cartesianToCanvasCoordinates(position)); } }, ScreenSpaceEventType.MOUSE_MOVE());
  - clampToHeight
```
@JsMethod
public Cartesian3 clampToHeight(Cartesian3 cartesian)
```
    Clamps the given cartesian position to the scene geometry along the geodetic surface normal. Returns the clamped position or undefined if there was no scene geometry to clamp to. May be used to clamp objects to the globe, 3D Tiles, or primitives in the scene. This function only clamps to globe tiles and 3D Tiles that are rendered in the current view. Clamps to all other primitives regardless of their visibility.
    
    Parameters:
    
    cartesian - The cartesian position. This may be undefined if there was no scene geometry to clamp to.
    
    See Also:
    
    sampleHeight(org.cesiumjs.cs.core.Cartographic)
  - clampToHeight
```
@JsMethod
public Cartesian3 clampToHeight(Cartesian3 cartesian,
                                          JsObject[] objectsToExclude)
```
    Clamps the given cartesian position to the scene geometry along the geodetic surface normal. Returns the clamped position or undefined if there was no scene geometry to clamp to. May be used to clamp objects to the globe, 3D Tiles, or primitives in the scene. This function only clamps to globe tiles and 3D Tiles that are rendered in the current view. Clamps to all other primitives regardless of their visibility.
    
    Parameters:
    
    cartesian - The cartesian position.
    
    objectsToExclude - A list of primitives, entities, or features to not clamp to.
    
    Returns:
    
    The modified result parameter or a new Cartesian3 instance if one was not provided. This may be undefined if there was no scene geometry to clamp to.
    
    See Also:
    
    sampleHeight(org.cesiumjs.cs.core.Cartographic)
  - clampToHeight
```
@JsMethod
public Cartesian3 clampToHeight(Cartesian3 cartesian,
                                          JsObject[] objectsToExclude,
                                          double width)
```
    Clamps the given cartesian position to the scene geometry along the geodetic surface normal. Returns the clamped position or undefined if there was no scene geometry to clamp to. May be used to clamp objects to the globe, 3D Tiles, or primitives in the scene. This function only clamps to globe tiles and 3D Tiles that are rendered in the current view. Clamps to all other primitives regardless of their visibility.
    
    Parameters:
    
    cartesian - The cartesian position.
    
    objectsToExclude - A list of primitives, entities, or features to not clamp to.
    
    width - Width of the intersection volume in meters.
    
    Returns:
    
    The modified result parameter or a new Cartesian3 instance if one was not provided. This may be undefined if there was no scene geometry to clamp to.
    
    See Also:
    
    sampleHeight(org.cesiumjs.cs.core.Cartographic)
  - clampToHeight
```
@JsMethod
public Cartesian3 clampToHeight(Cartesian3 cartesian,
                                          JsObject[] objectsToExclude,
                                          double width,
                                          Cartesian3 result)
```
    Clamps the given cartesian position to the scene geometry along the geodetic surface normal. Returns the clamped position or undefined if there was no scene geometry to clamp to. May be used to clamp objects to the globe, 3D Tiles, or primitives in the scene. This function only clamps to globe tiles and 3D Tiles that are rendered in the current view. Clamps to all other primitives regardless of their visibility.
    
    Parameters:
    
    cartesian - The cartesian position.
    
    objectsToExclude - A list of primitives, entities, or features to not clamp to.
    
    width - Width of the intersection volume in meters.
    
    result - An optional object to return the clamped position.
    
    Returns:
    
    The modified result parameter or a new Cartesian3 instance if one was not provided. This may be undefined if there was no scene geometry to clamp to.
    
    See Also:
    
    sampleHeight(org.cesiumjs.cs.core.Cartographic)
  - clampToHeightMostDetailed
```
@JsMethod
public Promise<Cartesian3[],Void> clampToHeightMostDetailed(Cartesian3[] cartesians)
```
    Initiates an asynchronous {link Scene#clampToHeight} query for an array of Cartesian3 positions using the maximum level of detail for 3D Tilesets in the scene. Returns a promise that is resolved when the query completes. Each position is modified in place. If a position cannot be clamped because no geometry can be sampled at that location, or another error occurs, the element in the array is set to undefined.
    
    Parameters:
    
    cartesians - The cartesian positions to update with clamped positions.
    
    Returns:
    
    A promise that resolves to the provided list of positions when the query has completed.
    
    See Also:
    
    clampToHeight(org.cesiumjs.cs.core.Cartesian3)
  - clampToHeightMostDetailed
```
@JsMethod
public Promise<Cartesian3[],Void> clampToHeightMostDetailed(Cartesian3[] cartesians,
                                                                      JsObject[] objectsToExclude)
```
    Initiates an asynchronous {link Scene#clampToHeight} query for an array of Cartesian3 positions using the maximum level of detail for 3D Tilesets in the scene. Returns a promise that is resolved when the query completes. Each position is modified in place. If a position cannot be clamped because no geometry can be sampled at that location, or another error occurs, the element in the array is set to undefined.
    
    Parameters:
    
    cartesians - The cartesian positions to update with clamped positions.
    
    objectsToExclude - A list of primitives, entities, or 3D Tiles features to not clamp to.
    
    Returns:
    
    A promise that resolves to the provided list of positions when the query has completed.
    
    See Also:
    
    clampToHeight(org.cesiumjs.cs.core.Cartesian3)
  - clampToHeightMostDetailed
```
@JsMethod
public Promise<Cartesian3[],Void> clampToHeightMostDetailed(Cartesian3[] cartesians,
                                                                      JsObject[] objectsToExclude,
                                                                      double width)
```
    Initiates an asynchronous {link Scene#clampToHeight} query for an array of Cartesian3 positions using the maximum level of detail for 3D Tilesets in the scene. Returns a promise that is resolved when the query completes. Each position is modified in place. If a position cannot be clamped because no geometry can be sampled at that location, or another error occurs, the element in the array is set to undefined.
    
    Parameters:
    
    cartesians - The cartesian positions to update with clamped positions.
    
    objectsToExclude - A list of primitives, entities, or 3D Tiles features to not clamp to.
    
    width - Width of the intersection volume in meters.
    
    Returns:
    
    A promise that resolves to the provided list of positions when the query has completed.
    
    See Also:
    
    clampToHeight(org.cesiumjs.cs.core.Cartesian3)
  - completeMorph
```
@JsMethod
public void completeMorph()
```
    Instantly completes an active transition.
  - destroy
```
@JsMethod
public void destroy()
```
    Destroys the WebGL resources held by this object. Destroying an object allows for deterministic release of WebGL resources, instead of relying on the garbage collector to destroy this object. Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.
    
    See Also:
    
    isDestroyed()
  - drillPick
```
@JsMethod
public PickedObject[] drillPick(Cartesian2 windowPosition)
```
    Returns a list of objects, each containing a `primitive` property, for all primitives at a particular window coordinate position. Other properties may also be set depending on the type of primitive. The primitives in the list are ordered by their visual order in the scene (front to back).
```
     Example:
     
     Object[] pickedObjects = scene.drillPick(new Cartesian2(100.0, 200.0));
     
 
```
    Parameters:
    
    windowPosition - Window coordinates to perform picking on.
    
    Returns:
    
    Array of objects, each containing 1 picked primitives.
  - drillPick
```
@JsMethod
public PickedObject[] drillPick(Cartesian2 windowPosition,
                                          double limit)
```
    Returns a list of objects, each containing a `primitive` property, for all primitives at a particular window coordinate position. Other properties may also be set depending on the type of primitive. The primitives in the list are ordered by their visual order in the scene (front to back).
```
     Example:
     
     Object[] pickedObjects = scene.drillPick(new Cartesian2(100.0, 200.0));
     
 
```
    Parameters:
    
    windowPosition - Window coordinates to perform picking on.
    
    limit - If supplied, stop drilling after collecting this many picks.
    
    Returns:
    
    Array of objects, each containing 1 picked primitives.
  - drillPick
```
@JsMethod
public PickedObject[] drillPick(Cartesian2 windowPosition,
                                          double limit,
                                          int width)
```
    Returns a list of objects, each containing a `primitive` property, for all primitives at a particular window coordinate position. Other properties may also be set depending on the type of primitive. The primitives in the list are ordered by their visual order in the scene (front to back).
```
     Example:
     
     Object[] pickedObjects = scene.drillPick(new Cartesian2(100.0, 200.0));
     
 
```
    Parameters:
    
    windowPosition - Window coordinates to perform picking on.
    
    limit - If supplied, stop drilling after collecting this many picks.
    
    width - Width of the pick rectangle.
    
    Returns:
    
    Array of objects, each containing 1 picked primitives.
  - drillPick
```
@JsMethod
public PickedObject[] drillPick(Cartesian2 windowPosition,
                                          double limit,
                                          int width,
                                          int height)
```
    Returns a list of objects, each containing a `primitive` property, for all primitives at a particular window coordinate position. Other properties may also be set depending on the type of primitive. The primitives in the list are ordered by their visual order in the scene (front to back).
```
     Example:
     
     Object[] pickedObjects = scene.drillPick(new Cartesian2(100.0, 200.0));
     
 
```
    Parameters:
    
    windowPosition - Window coordinates to perform picking on.
    
    limit - If supplied, stop drilling after collecting this many picks.
    
    width - Width of the pick rectangle.
    
    height - Height of the pick rectangle.
    
    Returns:
    
    Array of objects, each containing 1 picked primitives.
  - isDestroyed
```
@JsMethod
public boolean isDestroyed()
```
    Returns true if this object was destroyed; otherwise, false. If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.
    
    Returns:
    
    true if this object was destroyed; otherwise, false.
    
    See Also:
    
    destroy()
  - morphTo2D
```
@JsMethod
public void morphTo2D()
```
    Asynchronously transitions the scene to 2D.
  - morphTo2D
```
@JsMethod
public void morphTo2D(double duration)
```
    Asynchronously transitions the scene to 2D.
    
    Parameters:
    
    duration - The amount of time, in seconds, for transition animations to complete. Default: 2.0
  - morphTo3D
```
@JsMethod
public void morphTo3D()
```
    Asynchronously transitions the scene to 3D.
  - morphTo3D
```
@JsMethod
public void morphTo3D(double duration)
```
    Asynchronously transitions the scene to 3D.
    
    Parameters:
    
    duration - The amount of time, in seconds, for transition animations to complete. Default: 2.0
  - morphToColumbusView
```
@JsMethod
public void morphToColumbusView()
```
    Asynchronously transitions the scene to Columbus View.
  - morphToColumbusView
```
@JsMethod
public void morphToColumbusView(double duration)
```
    Asynchronously transitions the scene to Columbus View.
    
    Parameters:
    
    duration - The amount of time, in seconds, for transition animations to complete. Default: 2.0
  - pick
```
@JsMethod
public PickedObject pick(Cartesian2 windowPosition)
```
    Returns an object with a `primitive` property that contains the first (top) primitive in the scene at a particular window coordinate or undefined if nothing is at the location. Other properties may potentially be set depending on the type of primitive.
    
    Parameters:
    
    windowPosition - Window coordinates to perform picking on.
    
    Returns:
    
    Object containing the picked primitive.
  - pickPosition
```
@JsMethod
public Cartesian3 pickPosition(Cartesian2 windowPosition)
```
    Returns the cartesian position reconstructed from the depth buffer and window position.
    
    Parameters:
    
    windowPosition - Window coordinates to perform picking on.
    
    Returns:
    
    The cartesian position.
  - pickPosition
```
@JsMethod
public Cartesian3 pickPosition(Cartesian2 windowPosition,
                                         Cartesian3 result)
```
    Returns the cartesian position reconstructed from the depth buffer and window position.
    
    Parameters:
    
    windowPosition - Window coordinates to perform picking on.
    
    result - The object on which to restore the result.
    
    Returns:
    
    The cartesian position.
  - requestRender
```
@JsMethod
public void requestRender()
```
    Requests a new rendered frame when Scene#requestRenderMode is set to true. The render rate will not exceed the CesiumWidget.targetFrameRate.
    
    See Also:
    
    requestRenderMode
  - sampleHeight
```
@JsMethod
public double sampleHeight(Cartographic position)
```
    Returns the height of scene geometry at the given cartographic position or undefined if there was no scene geometry to sample height from. May be used to clamp objects to the globe, 3D Tiles, or primitives in the scene. This function only samples height from globe tiles and 3D Tiles that are rendered in the current view. Samples height from all other primitives regardless of their visibility.
    
    Parameters:
    
    position - The cartographic position to sample height from.
    
    Returns:
    
    The height. This may be undefined if there was no scene geometry to sample height from.
    
    See Also:
    
    clampToHeight(org.cesiumjs.cs.core.Cartesian3)
  - sampleHeight
```
@JsMethod
public double sampleHeight(Cartographic position,
                                     JsObject[] objectsToExclude)
```
    Returns the height of scene geometry at the given cartographic position or undefined if there was no scene geometry to sample height from. May be used to clamp objects to the globe, 3D Tiles, or primitives in the scene. This function only samples height from globe tiles and 3D Tiles that are rendered in the current view. Samples height from all other primitives regardless of their visibility.
    
    Parameters:
    
    position - The cartographic position to sample height from.
    
    objectsToExclude - A list of primitives, entities, or features to not sample height from.
    
    Returns:
    
    The height. This may be undefined if there was no scene geometry to sample height from.
    
    See Also:
    
    clampToHeight(org.cesiumjs.cs.core.Cartesian3)
  - sampleHeight
```
@JsMethod
public double sampleHeight(Cartographic position,
                                     JsObject[] objectsToExclude,
                                     double width)
```
    Returns the height of scene geometry at the given cartographic position or undefined if there was no scene geometry to sample height from. May be used to clamp objects to the globe, 3D Tiles, or primitives in the scene. This function only samples height from globe tiles and 3D Tiles that are rendered in the current view. Samples height from all other primitives regardless of their visibility.
    
    Parameters:
    
    position - The cartographic position to sample height from.
    
    objectsToExclude - A list of primitives, entities, or features to not sample height from.
    
    width - Width of the intersection volume in meters.
    
    Returns:
    
    The height. This may be undefined if there was no scene geometry to sample height from.
    
    See Also:
    
    clampToHeight(org.cesiumjs.cs.core.Cartesian3)
  - sampleHeightMostDetailed
```
@JsMethod
public Promise<double[],Void> sampleHeightMostDetailed(Cartographic[] positions)
```
    Initiates an asynchronous sampleHeight(org.cesiumjs.cs.core.Cartographic) query for an array of Cartographic positions using the maximum level of detail for 3D Tilesets in the scene. The height of the input positions is ignored. Returns a promise that is resolved when the query completes. Each point height is modified in place. If a height cannot be determined because no geometry can be sampled at that location, or another error occurs, the height is set to undefined.
    
    Parameters:
    
    positions - The cartographic positions to update with sampled heights.
    
    Returns:
    
    A promise that resolves to the provided list of positions when the query has completed.
    
    See Also:
    
    sampleHeight(org.cesiumjs.cs.core.Cartographic)
  - sampleHeightMostDetailed
```
@JsMethod
public Promise<double[],Void> sampleHeightMostDetailed(Cartographic[] positions,
                                                                 JsObject[] objectsToExclude)
```
    Initiates an asynchronous sampleHeight(org.cesiumjs.cs.core.Cartographic) query for an array of Cartographic positions using the maximum level of detail for 3D Tilesets in the scene. The height of the input positions is ignored. Returns a promise that is resolved when the query completes. Each point height is modified in place. If a height cannot be determined because no geometry can be sampled at that location, or another error occurs, the height is set to undefined.
    
    Parameters:
    
    positions - The cartographic positions to update with sampled heights.
    
    objectsToExclude - A list of primitives, entities, or 3D Tiles features to not sample height from.
    
    Returns:
    
    A promise that resolves to the provided list of positions when the query has completed.
    
    See Also:
    
    sampleHeight(org.cesiumjs.cs.core.Cartographic)
  - sampleHeightMostDetailed
```
@JsMethod
public Promise<double[],Void> sampleHeightMostDetailed(Cartographic[] positions,
                                                                 JsObject[] objectsToExclude,
                                                                 double width)
```
    Initiates an asynchronous sampleHeight(org.cesiumjs.cs.core.Cartographic) query for an array of Cartographic positions using the maximum level of detail for 3D Tilesets in the scene. The height of the input positions is ignored. Returns a promise that is resolved when the query completes. Each point height is modified in place. If a height cannot be determined because no geometry can be sampled at that location, or another error occurs, the height is set to undefined.
    
    Parameters:
    
    positions - The cartographic positions to update with sampled heights.
    
    objectsToExclude - A list of primitives, entities, or 3D Tiles features to not sample height from.
    
    width - Width of the intersection volume in meters.
    
    Returns:
    
    A promise that resolves to the provided list of positions when the query has completed.
    
    See Also:
    
    sampleHeight(org.cesiumjs.cs.core.Cartographic)

Class Scene

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

backgroundColor

completeMorphOnUserInput

debugCommandFilter

debugShowCommands

debugShowDepthFrustum

debugShowFramesPerSecond

debugShowFrustums

debugShowGlobeDepth

eyeSeparation

farToNearRatio

focalLength

fog

globe

imagerySplitPosition

invertClassification

invertClassificationColor

logarithmicDepthBuffer

logarithmicDepthFarToNearRatio

mapMode2D

maximumRenderTimeChange

mode

moon

morphComplete

morphStart

morphTime

nearToFarDistance2D

pickTranslucentDepth

postProcessStages

requestRenderMode

rethrowRenderErrors

shadowMap

skyAtmosphere

skyBox

specularEnvironmentMaps

sphericalHarmonicCoefficients

sun

sunBloom

terrainExaggeration

terrainProvider

useDepthPicking

useWebVR

Constructor Detail

Scene

Scene

Method Detail

camera

canvas

debugFrustumStatistics

drawingBufferHeight

drawingBufferWidth

groundPrimitives

highDynamicRangeSupported

id

imageryLayers

lastRenderTime

mapProjection

maximumAliasedLineWidth

maximumCubeMapSize

orderIndependentTranslucency

pickPositionSupported

postRender

postUpdate

preRender

preUpdate

primitives

renderError

sampleHeightSupported

clampToHeightSupported

invertClassificationSupported

scene3DOnly

screenSpaceCameraController

terrainProviderChanged

cartesianToCanvasCoordinates