ITerraExplorerObject80

This interface gives all of the objects that are derived from it a unique ID within TerraExplorer. The ID of the object is used, in many cases, as an argument to the methods of other interfaces, uniquely identifying the object on which a particular method should operate.

	Properties
	ID	Gets the ID of the object.
	ObjectType	Gets an enum that identifies the type of the object.
	SaveInFlyFile	Gets and sets a Boolean that determines whether the object is saved in the Fly file.
	Methods
	GetClientData	Gets an array of text strings assigned to each object global namespace.
	GetParam	Reserved. Currently not used.
	SetClientData	Sets an array of text strings assigned to each object global namespace.
	SetParam	Reserved. Currently not used.

ID

Gets the ID of the object.

 

JavaScript
ID

 

C#
string ID { get; }

 

C++
HRESULT ID([out, retval] BSTR* pVal)

ObjectType

Gets an enum that determines the object type. The following are the possible values:

§   OT_UNDEFINED = 0

§   OT_POLYLINE = 1

§   OT_POLYGON = 2

§   OT_RECTANGLE = 3

§   OT_REGULAR_POLYGON = 4

§   OT_CIRCLE = 5

§   OT_3D_POLYGON = 6

§   OT_BUILDING = 7

§   OT_BOX = 8

§   OT_PYRAMID = 9

§   OT_CYLINDER = 10

§   OT_CONE = 11

§   OT_ELLIPSE = 12

§   OT_ARC = 13

§   OT_ARROW = 14

§   OT_3D_ARROW = 15

§   OT_SPHERE = 16

§   OT_MODEL = 17

§   OT_LABEL = 18

§   OT_LOCATION = 19

§   OT_TREE_HOTLINK = 20

§   OT_ROUTE = 21

§   OT_MESSAGE = 22

§   OT_DYNAMIC = 23

§   OT_IMAGE_LABEL = 24

§   OT_THREAT_DOME = 25

§   OT_IMAGERY_LAYER = 26

§   OT_TERRAIN_VIDEO = 27

§   OT_POINT_CLOUD = 28

§   OT_ELEVATION_LAYER = 29

§   OT_TERRAIN_MODIFIER = 30

§   OT_TERRAIN_HOLE = 31

§   OT_POPUP_MESSAGE = 32

§   OT_FEATURE = 33

§   OT_PRESENTATION = 34

§   OT_ANALYSIS_LOS = 35

§   OT_FEATURE_LAYER = 36

§   OT_FEATURE_GROUP = 37

§   OT_3D_MESH_LAYER = 38

§   OT_3D_MESH_FEATURE_LAYER = 39

§   OT_KML_LAYER = 40

§   OT_3D_VIEWSHED = 41

§   OT_CONTOUR_MAP = 42

§   OT_SLOPE_MAP = 43

§   OT_EFFECT = 44

§   OT_NETWORK_LINK = 45

§   OT_SCREEN_OVERLAY = 46

For feature layers, the DisplayAs property and valid ObjectType values depend on the type of features that the layer contains:

§   Points:
OT_POLYGON = 2

OT_RECTANGLE = 3

OT_REGULAR_POLYGON = 4

OT_CIRCLE = 5

OT_3D_POLYGON = 6

OT_BUILDING = 7

OT_BOX = 8

OT_PYRAMID = 9

OT_CYLINDER = 10

OT_CONE = 11

OT_ELLIPSE = 12

OT_ARC = 13

OT_ARROW = 14

OT_3D_ARROW = 15

OT_SPHERE = 16

OT_MODEL = 17

OT_LABEL = 18

OT_IMAGE_LABEL = 24

§   Polylines
OT_POLYLINE = 1

§   Polygons:
OT_REGULAR_POLYGON = 4

OT_3D_POLYGON = 6

OT_BUILDING = 7

 

JavaScript
ObjectType

 

C#
ObjectTypeCode ObjectType { get; }

 

C++
HRESULT ObjectType([out, retval] ObjectTypeCode* pVal)

 

GetClientData

Gets an array of text strings assigned to each object. The array is indexed by a Namespace identifier.

 

JavaScript
GetClientData(Namespace)

 

C#
string GetClientData (string Namespace)

 

C++
HRESULT GetClientData(        [in] BSTR Namespace,        [out, retval] BSTR* ClientData)

 

Parameters

Namespace

The identifier of the text string.

Return Value

ClientData

A text string.

Exceptions

HRESULT can return any of the values listed in the HRESULT Return Values list, as well as the following values:

TE_E_INFOTREE_PARENTNOTGROUP	The group ID entered does not represent a valid group in the Project Tree.
TE_E_INFOTREE_ITEMNOTGROUP	The item entered is not a group and therefore cannot be used as a group.
TE_E_INFOTREE_CANTUSEROOT	Cannot use Tree root for this operation
TE_E_INFOTREE_ITEMISGROUP	Item ID is a group so an object cannot be retrieved.

 

SaveInFlyFile

Gets and sets a Boolean that determines whether the object is saved in the Fly file.

 

JavaScript
SaveInFlyFile

 

C#
bool SaveInFlyFile { get; set; }

 

C++
HRESULT SaveInFlyFile([out, retval] VARIANT_BOOL* pVal) HRESULT SaveInFlyFile([in] VARIANT_BOOL pVal)

SetClientData

Sets an array of text strings assigned to each object. The array is indexed by a Namespace identifier.

 

JavaScript
SetClientData(Namespace,               ClientData)

 

C#
void SetClientData (string Namespace,                      string ClientData)

 

C++
HRESULT  SetClientData (        [in] BSTR Namespace,        [in] BSTR ClientData)

 

Parameters

Namespace

The identifier of the text string.

ClientData

A text string.

Return Value

ClientData

A text string.

Exceptions

HRESULT can return any of the values listed in the HRESULT Return Values list, as well as the following values:

TE_E_INFOTREE_PARENTNOTGROUP	The group ID entered does not represent a valid group in the Project Tree.
TE_E_INFOTREE_ITEMNOTGROUP	The item entered is not a group and therefore cannot be used as a group.
TE_E_INFOTREE_CANTUSEROOT	Cannot use Tree root for this operation
TE_E_INFOTREE_ITEMISGROUP	Item ID is a group so an object cannot be retrieved.