Class: Globe

Members

atmosphereBrightnessShiftNumber

The brightness shift to apply to the atmosphere. Defaults to 0.0 (no shift). A brightness shift of -1.0 is complete darkness, which will let space show through.

Default Value:

0.0

Methods

addExcavationRegion(){Boolean}

Adds a terrain excavation area.

Name	Type	Description
options.position	Array	Location information of the excavation area.
options.name	String	Name of the excavation area. (Unique)
options.height	String	Excavation depth underground.
options.transparent	Boolean	Whether the surface is transparent.
options.textureWrap	TextureWrap	Specifies the texture wrapping mode for excavation texture. Default value is SuperMap3D.TextureWrap.REPEAT.

Returns:

Type	Description
Boolean	Boolean, returns true for success, false for failure.

Example

var pts = [lon1,lat1,h1,lon2,lat2,h2,lon3,lat3,h3];
viewer.scene.globe.addExcavationRegion({
        name : 'test' ,
        position : pts,
        height : 100,
        transparent : false
        textureWrap :SuperMap3D.TextureWrap.REPEAT // Repeat texture
        textureWrap :SuperMap3D.TextureWrap.CLAMP_TO_EDGE // Do not repeat texture (stretch to edge)
    });

addExtractRegion()

Display effect of terrain excavation extraction.

Name	Type	Description
options.name	String	The name of the excavation area.
options.position	Array	Terrain excavation area.
options.height	Number	Terrain excavation depth.
options.transparent	Boolean	Whether the edge is transparent, default: false.
options.extractHeight	Number	Terrain excavation extraction height, default: 100.
options.granularity	Number	The precision of terrain excavation. Smaller values result in higher precision. Default: 1.

Example

viewer.scene.globe.addExtractRegion({
 name:'ggg',
 position:positions,
 height:50,
 transparent:transparent,
 extractHeight:200,
 granularity:100,
 });

addImageryClipRegions()

Imagery clipping.

Name	Type	Description
options.position	Array	Clipping region
options.layers	Array	Imagery layers involved in clipping
options.name	String	The name (key value) of the clipping region

addModifyRegion(){Boolean}

Adds a terrain modification area. (Input 3D vector polygon data to flatten undulating terrain to match the height of the 3D polygon).

Name	Type	Description
options.position	Array	Location information of the modification area.
options.name	String	Name of the modification area.
options.createSide	Boolean	Whether to create side faces (applicable for terrain cut). Default true.

Returns:

Type	Description
Boolean	Success returns true, failure returns false.

Example

var pts = [lon1,lat1,h1,lon2,lat2,h2,lon3,lat3,h3];
viewer.scene.globe.addModifyRegion({
        name : 'test',
        position : pts,
        createSide : true
    });

addSlopeRegion(options){Boolean}

Add slope direction analysis area

Name	Type	Description
options	Object	The modified region parameter object includes the following properties: Name Type Description name String Slope analysis area name slopeSetting SlopeSetting Modify regional location information analysisMode Number Analysis mode

Returns:

Type	Description
Boolean	Success returns true, failure returns false

clearClipGeometry()

Remove the terrain and excavate through the model.

clearCustomClipBox()

Clear custom clipping surface

computeSurfaceArea(polygonGeometry, ellipsoid, slice){number}

Calculates the ground area.

Name	Type	Description
polygonGeometry	Object	An object of the PolygonGeometry class used to determine the area measurement extent.
ellipsoid	Ellipsoid	Ellipsoid. The ellipsoid used for calculating the ground area, default is the WGS84 ellipsoid.
slice	Number	optional Split granularity. Supports user-defined granularity for polygon splitting. If not set, the granularity is determined based on the polygon's extent.

Returns:

Type	Description
number	Ground area within the extent of the PolygonGeometry object.

Example

var ellipsoid = SuperMap3D.Ellipsoid.WGS84;
var area = scene.globe.computeSurfaceArea(polygonGeometry, ellipsoid, 10)；

computeSurfaceDistance(polylineGeometry, ellipsoid){number}

Calculates the ground distance.

Name	Type	Description
polylineGeometry	Object	An object of the PolylineGeometry class used to determine the distance measurement extent.
ellipsoid	Ellipsoid	Ellipsoid. The ellipsoid used for calculating the ground distance, default is the WGS84 ellipsoid.

Returns:

Type	Description
number	Ground distance corresponding to the PolylineGeometry object.

Example

var ellipsoid = SuperMap3D.Ellipsoid.WGS84;
var distance = scene.globe.computeSurfaceDistance(polylineGeometry,ellipsoid);

destroy(){undefined}

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. 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 shown in the example.

See:

• Globe#isDestroyed

Throws:

The object has been destroyed, i.e. destroy() has been called.

Type

DeveloperError

Returns:

Type	Description
undefined

Example

globe = globe && globe.destroy();

getHeight(cartographic){Number|undefined}

Gets the height at the specified longitude and latitude.

Name	Type	Description
cartographic	Cartographic	Longitude and latitude values.

Returns:

Type	Description
Number | undefined	Height value.

getSlopeDirectionValue(cartographic){Number|undefined}

Gets the terrain slope direction. Input coordinates in radians, result is in degrees with 0 being north.

Name	Type	Description
cartographic	Cartographic	Longitude and latitude.

Returns:

Type	Description
Number | undefined	Slope direction.

getSlopeRegion(name){Object|undefined}

Retrieve the specified slope direction analysis area object based on its name

Name	Type	Description
name	String	Region Name

Returns:

Type	Description
Object | undefined	If it exists, return the specified area object; if it does not exist, return undefined;

getSlopeValue(cartographic){Number|undefined}

Gets the terrain slope value.

Name	Type	Description
cartographic	Cartographic	Longitude and latitude.

Returns:

Type	Description
Number | undefined	Slope value.

getVisibleTiles(){Array}

Gets visible tiles.

Returns:

Type	Description
Array	List of objects with properties x, y, level.

isDestroyed(){Boolean}

If the object has been destroyed, return true; Otherwise, return false. If the object has been destroyed, it should not be used; Calling any function other than isDestroyed will result in a Developer Error exception.

See:

• Globe#destroy

Returns:

Type	Description
Boolean	If the object has been destroyed, it is true; Otherwise, it is false.

pick(Ray, Scene, result){Cartesian3|undefined}

Gets the intersection point between a ray and the Earth (the ray must be in 3D world coordinates).

Name	Type	Description
Ray	Number	Ray, used for camera testing.
Scene	Object	Scene objects.
result	Cartesian3	optional 3D spatial coordinates, used to store the result.

Returns:

Type	Description
Cartesian3 | undefined	If they intersect, returns the 3D spatial coordinates of the intersection point.

Example

// Find the intersection with the Earth using a screen-space pixel and the camera's ray.
var ray = viewer.camera.getPickRay(windowCoordinates);
var intersection = globe.pick(ray, scene);

removeAllExcavationRegion()

Remove all excavation faces

Example

viewer.scene.globe.removeAllExcavationRegion();

removeAllExtractRegion()

Removes all excavation areas and extracted parts.

Example

viewer.scene.globe.removeAllExtractRegion();

removeAllModifyRegion()

Remove all terrain modified areas

Example

viewer.scene.globe.removeAllModifyRegion();

removeAllSlopeRegion(){Boolean}

Remove all slope orientation analysis area objects

Returns:

Type	Description
Boolean	Return true for successful removal and false for failed removal.

removeExcavationRegion(name)

Remove the terrain excavation area with the specified name

Name	Type	Description
name	String	Name of terrain excavation area

removeExtractRegion(name)

Removes the current terrain excavation area and extracted part.

Name	Type	Description
name	String	Names of terrain excavation and extraction areas

Example

viewer.scene.globe.removeExtractRegion();

removeImageryClipRegion(name, layers)

Removes clipping region

Name	Type	Description
name	String	The name (key value) of the clipping region.
layers	Array	Imagery layers involved in clipping.

removeModifyRegion(name)

Remove the terrain modification area with the specified name

Name	Type	Description
name	String	Name of terrain modification area

removePBRMaterial()

Remove PBR material.

removeSlopeRegion(name){Boolean}

Remove the specified slope analysis area object based on its name

Name	Type	Description
name	String	Region Name

Returns:

Type	Description
Boolean	Return true for successful removal and false for failed removal.

setClipGeometry(options){Boolean}

Add terrain through model excavation

Name	Type	Description
options	Object	The terrain model excavation parameter object includes the following attributes: Name Type Description geometry geometry model scene String scene

Returns:

Type	Description
Boolean	Success returns true, failure returns false

Example

var geoCylinder = new SuperMap3D.GeoBox(400.0, 400.0, 10000.0);
    geoCylinder.geoPosition = positon;
    viewer.scene.globe.setClipGeometry({
        geometry:geoCylinder,
        scene:scene
    });

setCustomClipBox(options){Boolean}

Add custom clipping surface

Name	Type	Description
options	Object	The cutting surface parameters include the following properties: Name Type Description dimensions Cartesian3 Crop the length, width, and height of the box position Cartesian3 Box cutting center position heading Number Crop the heading angle of the box pitch Number Crop the pitch angle of the box roll Number Crop the roll angle of the box clipLineColor Color Clipping line color. clipMode String Crop modes, including cropping within the plane, cropping outside the plane, and only retaining?

Throws:

options and options.dimensions and options.position are required.

Type

DeveloperError

Returns:

Type	Description
Boolean	Boolean returns true for success and false for failure

setPBRMaterialFromJSON(jsonPath)

Add terrain PBR material.

Name	Type	Description
jsonPath	String	File address for pbr material

setPolygonOffset(polyOffsetFactor, polyOffsetUnits)

Sets the terrain polygon offset factor and offset constant.

Name	Type	Description
polyOffsetFactor	Number	Offset factor, default is 0.
polyOffsetUnits	Number	Offset constant, default is 0.