xgis-cesium三维开发文档

Appearance

xgis-cesium v0.1.7

xgis-cesium / GroundSkyBox

Class: GroundSkyBox ​

Defined in: src/exts/GroundSkyBox.js:49

Extends ​

  • SkyBox

Constructors ​

new GroundSkyBox() ​

new GroundSkyBox(options): GroundSkyBox

Defined in: src/exts/GroundSkyBox.js:50

Parameters ​

options ​

Returns ​

GroundSkyBox

Overrides ​

SkyBox.constructor

Properties ​

_attributeLocations ​

_attributeLocations: any

Defined in: src/exts/GroundSkyBox.js:151

_cubeMap ​

_cubeMap: any

Defined in: src/exts/GroundSkyBox.js:111

_sources ​

_sources: any

Defined in: src/exts/GroundSkyBox.js:76

_useHdr ​

_useHdr: any

Defined in: src/exts/GroundSkyBox.js:177

offsetAngle ​

offsetAngle: any

Defined in: src/exts/GroundSkyBox.js:52

show ​

show: boolean

Defined in: node_modules/@cesium/engine/index.d.ts:42314

Determines if the sky box will be shown.

Inherited from ​

SkyBox.show

sources ​

sources: any

Defined in: node_modules/@cesium/engine/index.d.ts:42310

The sources used to create the cube map faces: an object with positiveX, negativeX, positiveY, negativeY, positiveZ, and negativeZ properties. These can be either URLs or Image objects.

Inherited from ​

SkyBox.sources

Methods ​

destroy() ​

destroy(): void

Defined in: node_modules/@cesium/engine/index.d.ts:42342

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.

Returns ​

void

Example ​

ts
skyBox = skyBox && skyBox.destroy();

Inherited from ​

SkyBox.destroy

isDestroyed() ​

isDestroyed(): boolean

Defined in: node_modules/@cesium/engine/index.d.ts:42331

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 ​

boolean

true if this object was destroyed; otherwise, false.

Inherited from ​

SkyBox.isDestroyed

update() ​

update(frameState, useHdr): any

Defined in: src/exts/GroundSkyBox.js:55

Called when Viewer or CesiumWidget render the scene to get the draw commands needed to render this primitive.

Do not call this function directly. This is documented just to list the exceptions that may be propagated when the scene is rendered:

Parameters ​

frameState ​

any

useHdr ​

any

Returns ​

any

Overrides ​

SkyBox.update

createEarthSkyBox() ​

static createEarthSkyBox(): SkyBox

Defined in: node_modules/@cesium/engine/index.d.ts:42349

Creates a skybox instance with the default starmap for the Earth.

Returns ​

SkyBox

The default skybox for the Earth

Example ​

ts
viewer.scene.skyBox = Cesium.SkyBox.createEarthSkyBox();

Inherited from ​

SkyBox.createEarthSkyBox