TerraExplorerObject

The TerraExplorerObject object gives access to the objects returned when any layer or object is created or loaded into the project, so that you can set/modify certain properties or perform basic methods on the object, such as fly to or delete. Some of its members and methods are only available for specific object types. The following members and methods are available:

General (available to all objects):

§  description

§  parent

§  show

§  timestamp

§  type

§  delete()

§  flyTo()

§  refresh()

 

videoOnTerrain:

§  showProjector

§  volume

§  pause()

§  play()

 

pointCloud:

§  setDefaultPivot()

§  setPivot()

 

feature:

§  properties

 

Members

description

static description : String

Gets and sets the object's name in TE4W's sidebar.

parent

static parent : Array<TerraExplorerObject>

Returns an array of TerraExplorerObject containing all the objects in the parent object.
E.g., "TerraExplorer.analysis.distance.items[0].parent" will return a list of all the objects in the distance object's parent object, i.e., the analysis object.

properties

static properties : PropertiesObject

Gets and sets a PropertiesObject with properties and methods for a feature layers' features.

show

static show : Boolean

Gets and sets a Boolean that indicates whether the object is visible in the 3D Window.

showProjector

static showProjector : Boolean

Gets and sets a Boolean that indicates whether the projector pyramid object is displayed in the 3D Window. This property is only valid for the object returned by the videoOnTerrain.create method.

timestamp

static timestamp : Number

Gets the timestamp when the object or layer was created, in milliseconds elapsed since January 1, 1970 00:00:00 UTC. This property is only valid for objects and layers created in TerraExplorer for Web GUI. 

type

static type : String

Gets a string that determines the object type, e.g., “FeaturePoint”, “FeatureLine”, “FeaturePolygon”, “videoOnTerrain”, “holeOnTerrain”, “modifyTerrain”, “viewshed”, “distance”, “area”, “volume”, “mesh”, “pointCloud”.

volume

static volume : Number

Gets and sets a number that determines the decibel level of a videoOnTerrain object. This property is only valid for the object returned by the videoOnTerrain.create method.

Methods

delete

delete()      

Deletes the object.

flyTo

flyTo()

Flies to the object.

pause

pause() 

Pauses the videoOnTerrain object. This method is only valid for the object returned by the videoOnTerrain.create method.

play

play()

Plays the videoOnTerrain object. This property is only valid for the object returned by the videoOnTerrain.create method.

refresh

refresh()

Refreshes all loaded or created layers and objects.

setDefaultPivot

setDefaultPivot()

Sets the point cloud object's pivot point to the default pivot in the loaded point cloud layer. This property is only valid for the object returned by the pointCloud.create method.

setPivot

setPivot(point)

Sets the point cloud pivot. This property is only valid for the object returned by the pointCloud.create method.

 

Parameters

Name	Type	Description
point	Cesium.Cartesian3	Cartesian position. The altitude (z component) is absolute, i.e., the pivot point is placed at the specified altitude above the terrain database vertical datum base ellipsoid.