Cesium3DTilesetOptions (CesiumJS GWT Wrapper 1.59.4 API)

java.lang.Object
- org.cesiumjs.cs.scene.options.Cesium3DTilesetOptions

@JsType(isNative=true,
        namespace="<global>",
        name="Object")
public class Cesium3DTilesetOptions
extends Object

Author:: Serge Silaev aka iSergio

Field Summary

Fields
Modifier and Type	Field and Description
`double`	`baseScreenSpaceError` When skipLevelOfDetail is true, the screen space error that must be reached before skipping levels of detail.
`ClassificationType`	`classificationType` Determines whether terrain, 3D Tiles or both will be classified by this tileset.
`ClippingPlaneCollection`	`clippingPlanes` The `ClippingPlaneCollection` used to selectively disable rendering the tileset.
`boolean`	`cullRequestsWhileMoving` Don't request tiles that will likely be unused when they come back because of the camera's movement.
`double`	`cullRequestsWhileMovingMultiplier` Multiplier used in culling requests while moving.
`boolean`	`cullWithChildrenBounds` Optimization option.
`boolean`	`debugColorizeTiles` For debugging only.
`boolean`	`debugFreezeFrame` For debugging only.
`boolean`	`debugShowBoundingVolume` For debugging only.
`boolean`	`debugShowContentBoundingVolume` For debugging only.
`boolean`	`debugShowGeometricError` For debugging only.
`boolean`	`debugShowMemoryUsage` For debugging only.
`boolean`	`debugShowRenderingStatistics` For debugging only.
`boolean`	`debugShowViewerRequestVolume` For debugging only.
`boolean`	`debugWireframe` For debugging only.
`boolean`	`dynamicScreenSpaceError` Optimization option.
`double`	`dynamicScreenSpaceErrorDensity` Density used to adjust the dynamic screen space error, similar to fog density.
`double`	`dynamicScreenSpaceErrorFactor` A factor used to increase the computed dynamic screen space error.
`double`	`dynamicScreenSpaceErrorHeightFalloff` A ratio of the tileset's height at which the density starts to falloff.
`Ellipsoid`	`ellipsoid` The ellipsoid determining the size and shape of the globe.
`double`	`foveatedConeSize` Optimization option.
`Cesium3DTileset.FoveatedInterpolationCallback`	`foveatedInterpolationCallback` Optimization option.
`double`	`foveatedMinimumScreenSpaceErrorRelaxation` Optimization option.
`boolean`	`foveatedScreenSpaceError` Optimization option.
`double`	`foveatedTimeDelay` Optimization option.
`Cartesian2`	`imageBasedLightingFactor` Scales the diffuse and specular image-based lighting from the earth, sky, atmosphere and star skybox.
`boolean`	`immediatelyLoadDesiredLevelOfDetail` When skipLevelOfDetail is true, only tiles that meet the maximum screen space error will ever be downloaded.
`Cartesian3`	`lightColor` The color and intensity of the sunlight used to shade models.
`boolean`	`loadSiblings` When skipLevelOfDetail is true, determines whether siblings of visible tiles are always downloaded during traversal.
`double`	`luminanceAtZenith` The sun's luminance at the zenith in kilo candela per meter squared to use for this model's procedural environment map.
`double`	`maximumMemoryUsage` The maximum amount of memory in MB that can be used by the tileset.
`double`	`maximumScreenSpaceError` The maximum screen space error used to drive level of detail refinement.
`Matrix4`	`modelMatrix` A 4x4 transformation matrix that transforms the tileset's root tile.
`PointCloudShading`	`pointCloudShading` Options for constructing a PointCloudShading object to control point attenuation based on geometric error and lighting.
`boolean`	`preferLeaves` Optimization option.
`boolean`	`preloadFlightDestinations` Preload tiles at the camera's flight destination while the camera is in flight.
`boolean`	`preloadWhenHidden` Preload tiles when tileset.show is false.
`double`	`progressiveResolutionHeightFraction` Optimization option.
`Promise<?,?>`	`promise`
`Resource`	`resource`
`Number`	`shadows` Determines whether the tileset casts or receives shadows from each light source.
`boolean`	`show` Determines if the tileset will be shown.
`boolean`	`skipLevelOfDetail` Optimization option.
`double`	`skipLevels` When skipLevelOfDetail is true, a constant defining the minimum number of levels to skip when loading tiles.
`double`	`skipScreenSpaceErrorFactor` When skipLevelOfDetail is true, a multiplier defining the minimum screen space error to skip.
`String`	`specularEnvironmentMaps` A URL to a KTX file that contains a cube map of the specular lighting and the convoluted specular mipmaps.
`Cartesian3[]`	`sphericalHarmonicCoefficients` The third order spherical harmonic coefficients used for the diffuse color of image-based lighting.
`String`	`url` The url to a tileset.json file or to a directory containing a tileset.json file.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Cesium3DTilesetOptions`	`create(Promise<?,?> url)`
`static Cesium3DTilesetOptions`	`create(Resource url)`
`static Cesium3DTilesetOptions`	`create(String url)`

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

- Field Detail
  - url
```
@JsProperty
public String url
```
    The url to a tileset.json file or to a directory containing a tileset.json file.
  - resource
```
@JsProperty(name="url")
public Resource resource
```
  - promise
```
@JsProperty(name="url")
public Promise<?,?> promise
```
  - show
```
@JsProperty
public boolean show
```
    Determines if the tileset will be shown. Default: true
  - modelMatrix
```
@JsProperty
public Matrix4 modelMatrix
```
    A 4x4 transformation matrix that transforms the tileset's root tile. Default: Matrix4.IDENTITY()
  - shadows
```
@JsProperty
public Number shadows
```
    Determines whether the tileset casts or receives shadows from each light source. Default: ShadowMode.ENABLED()
  - maximumScreenSpaceError
```
@JsProperty
public double maximumScreenSpaceError
```
    The maximum screen space error used to drive level of detail refinement. Default: 16
  - maximumMemoryUsage
```
@JsProperty
public double maximumMemoryUsage
```
    The maximum amount of memory in MB that can be used by the tileset. Default: 512
  - cullWithChildrenBounds
```
@JsProperty
public boolean cullWithChildrenBounds
```
    Optimization option. Whether to cull tiles using the union of their children bounding volumes. Default: true
  - cullRequestsWhileMoving
```
@JsProperty
public boolean cullRequestsWhileMoving
```
    Don't request tiles that will likely be unused when they come back because of the camera's movement. Default: true
  - cullRequestsWhileMovingMultiplier
```
@JsProperty
public double cullRequestsWhileMovingMultiplier
```
    Multiplier used in culling requests while moving. Larger is more aggressive culling, smaller less aggressive culling. Defaule: 60.0
  - preloadWhenHidden
```
@JsProperty
public boolean preloadWhenHidden
```
    Preload tiles when tileset.show is false. Loads tiles as if the tileset is visible but does not render them. Default: false
  - preloadFlightDestinations
```
@JsProperty
public boolean preloadFlightDestinations
```
    Preload tiles at the camera's flight destination while the camera is in flight. Default: true
  - preferLeaves
```
@JsProperty
public boolean preferLeaves
```
    Optimization option. Prefer loading of leaves first. Default: false
  - dynamicScreenSpaceError
```
@JsProperty
public boolean dynamicScreenSpaceError
```
    Optimization option. Reduce the screen space error for tiles that are further away from the camera. Defaule: false
  - dynamicScreenSpaceErrorDensity
```
@JsProperty
public double dynamicScreenSpaceErrorDensity
```
    Density used to adjust the dynamic screen space error, similar to fog density. Default: 0.00278
  - dynamicScreenSpaceErrorFactor
```
@JsProperty
public double dynamicScreenSpaceErrorFactor
```
    A factor used to increase the computed dynamic screen space error. Default: 4.0
  - dynamicScreenSpaceErrorHeightFalloff
```
@JsProperty
public double dynamicScreenSpaceErrorHeightFalloff
```
    A ratio of the tileset's height at which the density starts to falloff. Default: 0.25
  - progressiveResolutionHeightFraction
```
@JsProperty
public double progressiveResolutionHeightFraction
```
    Optimization option. If between (0.0, 0.5], tiles at or above the screen space error for the reduced screen resolution of progressiveResolutionHeightFraction*screenHeight will be prioritized first. This can help get a quick layer of tiles down while full resolution tiles continue to load. Default: 0.3
  - foveatedScreenSpaceError
```
@JsProperty
public boolean foveatedScreenSpaceError
```
    Optimization option. Prioritize loading tiles in the center of the screen by temporarily raising the screen space error for tiles around the edge of the screen. Screen space error returns to normal once all the tiles in the center of the screen as determined by the Cesium3DTileset.foveatedConeSize are loaded. Default: true
  - foveatedConeSize
```
@JsProperty
public double foveatedConeSize
```
    Optimization option. Used when Cesium3DTileset.foveatedScreenSpaceError is true to control the cone size that determines which tiles are deferred. Tiles that are inside this cone are loaded immediately. Tiles outside the cone are potentially deferred based on how far outside the cone they are and their screen space error. This is controlled by Cesium3DTileset.foveatedInterpolationCallback and Cesium3DTileset.foveatedMinimumScreenSpaceErrorRelaxation. Setting this to 0.0 means the cone will be the line formed by the camera position and its view direction. Setting this to 1.0 means the cone encompasses the entire field of view of the camera, disabling the effect. Default: 0.1
  - foveatedMinimumScreenSpaceErrorRelaxation
```
@JsProperty
public double foveatedMinimumScreenSpaceErrorRelaxation
```
    Optimization option. Used when Cesium3DTileset.foveatedScreenSpaceError is true to control the starting screen space error relaxation for tiles outside the foveated cone. The screen space error will be raised starting with tileset value up to Cesium3DTileset.maximumScreenSpaceError based on the provided Cesium3DTileset.foveatedInterpolationCallback. Default: 0.0
  - foveatedInterpolationCallback
```
@JsProperty
public Cesium3DTileset.FoveatedInterpolationCallback foveatedInterpolationCallback
```
    Optimization option. Used when Cesium3DTileset.foveatedScreenSpaceError is true to control how much to raise the screen space error for tiles outside the foveated cone, interpolating between Cesium3DTileset.foveatedMinimumScreenSpaceErrorRelaxation and Cesium3DTileset.maximumScreenSpaceError
  - foveatedTimeDelay
```
@JsProperty
public double foveatedTimeDelay
```
    Optimization option. Used when Cesium3DTileset.foveatedScreenSpaceError is true to control how long in seconds to wait after the camera stops moving before deferred tiles start loading in. This time delay prevents requesting tiles around the edges of the screen when the camera is moving. Setting this to 0.0 will immediately request all tiles in any given view. Default: 0.2
  - skipLevelOfDetail
```
@JsProperty
public boolean skipLevelOfDetail
```
    Optimization option. Determines if level of detail skipping should be applied during the traversal. Defaule: true
  - baseScreenSpaceError
```
@JsProperty
public double baseScreenSpaceError
```
    When skipLevelOfDetail is true, the screen space error that must be reached before skipping levels of detail. Default: 1024
  - skipScreenSpaceErrorFactor
```
@JsProperty
public double skipScreenSpaceErrorFactor
```
    When skipLevelOfDetail is true, a multiplier defining the minimum screen space error to skip. Used in conjunction with skipLevels to determine which tiles to load. Default: 16
  - skipLevels
```
@JsProperty
public double skipLevels
```
    When skipLevelOfDetail is true, a constant defining the minimum number of levels to skip when loading tiles. When it is 0, no levels are skipped. Used in conjunction with skipScreenSpaceErrorFactor to determine which tiles to load. Default: 1
  - immediatelyLoadDesiredLevelOfDetail
```
@JsProperty
public boolean immediatelyLoadDesiredLevelOfDetail
```
    When skipLevelOfDetail is true, only tiles that meet the maximum screen space error will ever be downloaded. Skipping factors are ignored and just the desired tiles are loaded. Defaule: false;
  - loadSiblings
```
@JsProperty
public boolean loadSiblings
```
    When skipLevelOfDetail is true, determines whether siblings of visible tiles are always downloaded during traversal. Defaule: false;
  - clippingPlanes
```
@JsProperty
public ClippingPlaneCollection clippingPlanes
```
    The ClippingPlaneCollection used to selectively disable rendering the tileset. Clipping planes are not currently supported in Internet Explorer.
  - classificationType
```
@JsProperty
public ClassificationType classificationType
```
    Determines whether terrain, 3D Tiles or both will be classified by this tileset. See Cesium3DTileset.classificationType() for details about restrictions and limitations.
  - ellipsoid
```
@JsProperty
public Ellipsoid ellipsoid
```
    The ellipsoid determining the size and shape of the globe. Default: Ellipsoid.WGS84()
  - pointCloudShading
```
@JsProperty
public PointCloudShading pointCloudShading
```
    Options for constructing a PointCloudShading object to control point attenuation based on geometric error and lighting.
  - imageBasedLightingFactor
```
@JsProperty
public Cartesian2 imageBasedLightingFactor
```
    Scales the diffuse and specular image-based lighting from the earth, sky, atmosphere and star skybox. Default: new Cartesian2(1.0, 1.0)
  - lightColor
```
@JsProperty
public Cartesian3 lightColor
```
    The color and intensity of the sunlight used to shade models.
  - luminanceAtZenith
```
@JsProperty
public double luminanceAtZenith
```
    The sun's luminance at the zenith in kilo candela per meter squared to use for this model's procedural environment map. Default: 0.5
  - sphericalHarmonicCoefficients
```
@JsProperty
public Cartesian3[] sphericalHarmonicCoefficients
```
    The third order spherical harmonic coefficients used for the diffuse color of image-based lighting.
  - specularEnvironmentMaps
```
@JsProperty
public String specularEnvironmentMaps
```
    A URL to a KTX file that contains a cube map of the specular lighting and the convoluted specular mipmaps.
  - debugFreezeFrame
```
@JsProperty
public boolean debugFreezeFrame
```
    For debugging only. Determines if only the tiles from last frame should be used for rendering. Defaule: false;
  - debugColorizeTiles
```
@JsProperty
public boolean debugColorizeTiles
```
    For debugging only. When true, assigns a random color to each tile. Defaule: false;
  - debugWireframe
```
@JsProperty
public boolean debugWireframe
```
    For debugging only. When true, render's each tile's content as a wireframe. Defaule: false;
  - debugShowBoundingVolume
```
@JsProperty
public boolean debugShowBoundingVolume
```
    For debugging only. When true, renders the bounding volume for each tile. Defaule: false;
  - debugShowContentBoundingVolume
```
@JsProperty
public boolean debugShowContentBoundingVolume
```
    For debugging only. When true, renders the bounding volume for each tile's content. Defaule: false;
  - debugShowViewerRequestVolume
```
@JsProperty
public boolean debugShowViewerRequestVolume
```
    For debugging only. When true, renders the viewer request volume for each tile. Defaule: false;
  - debugShowGeometricError
```
@JsProperty
public boolean debugShowGeometricError
```
    For debugging only. When true, draws labels to indicate the geometric error of each tile. Defaule: false;
  - debugShowRenderingStatistics
```
@JsProperty
public boolean debugShowRenderingStatistics
```
    For debugging only. When true, draws labels to indicate the number of commands, points, triangles and features for each tile. Defaule: false;
  - debugShowMemoryUsage
```
@JsProperty
public boolean debugShowMemoryUsage
```
    For debugging only. When true, draws labels to indicate the texture and geometry memory in megabytes used by each tile. Defaule: false;
- Method Detail
  - create
```
@JsOverlay
public static Cesium3DTilesetOptions create(String url)
```
  - create
```
@JsOverlay
public static Cesium3DTilesetOptions create(Resource url)
```
  - create
```
@JsOverlay
public static Cesium3DTilesetOptions create(Promise<?,?> url)
```

Class Cesium3DTilesetOptions

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

url

resource

promise

show

modelMatrix

shadows

maximumScreenSpaceError

maximumMemoryUsage

cullWithChildrenBounds

cullRequestsWhileMoving

cullRequestsWhileMovingMultiplier

preloadWhenHidden

preloadFlightDestinations

preferLeaves

dynamicScreenSpaceError

dynamicScreenSpaceErrorDensity

dynamicScreenSpaceErrorFactor

dynamicScreenSpaceErrorHeightFalloff

progressiveResolutionHeightFraction

foveatedScreenSpaceError

foveatedConeSize

foveatedMinimumScreenSpaceErrorRelaxation

foveatedInterpolationCallback

foveatedTimeDelay

skipLevelOfDetail

baseScreenSpaceError

skipScreenSpaceErrorFactor

skipLevels

immediatelyLoadDesiredLevelOfDetail

loadSiblings

clippingPlanes

classificationType

ellipsoid

pointCloudShading

imageBasedLightingFactor

lightColor

luminanceAtZenith

sphericalHarmonicCoefficients

specularEnvironmentMaps

debugFreezeFrame

debugColorizeTiles

debugWireframe

debugShowBoundingVolume

debugShowContentBoundingVolume

debugShowViewerRequestVolume

debugShowGeometricError

debugShowRenderingStatistics

debugShowMemoryUsage

Method Detail

create

create

create