Procedure Query

Parent Previous Next

Description: Retrieves selected attributes of some entities currently loaded in TerrainView™. The result of the procedure is an array of structs. For each entity matching the Type and Filter parameters, a struct of all requested attributes is added to the result array.

Struct:

Field Name

O

Type

Description

Type


int (i4)

0 = POI / 1 = 3D object

Filter


int (i4)

0 = All

Fields


string[ ]

An array of strings. Each string denotes an attribute to be retrieved. The VTID is always returned as "VTID" and must not be requested.

For example, if Fields is ["Name", "Visible"] then the result will be an array of struct{string, string, boolean}. Each struct contains the VTID, the name and the visible flag ({VTID = "VT:0ab05324", Name = "POI(1)", Visible = true}).

The order of the struct members as well as the order of the structs inside the array is undefined.


Supported attribute names:


Attribute Name

O

Return Type

Description

CustomID

X

string

The identifier (CustomID) assigned to the entity by the EntityCreate or ShapeFrustum procedure.

SymbolID

X

string

The filename alias (SymbolID) in the [model-map] section of the "VTNetCom.conf" file.

Name

X

string

The name of the entity.

Description

X

string

The description of the entity.

Group

X

string

The name of the group the entity belongs to.

VisibleDistance

X

double

The distance the entity is still visible.

Visible

X

boolean

Whether or not the entity is generally visible.

Position

X

double[3]

The position of the entity.

SnapToTerrain

X

boolean

Whether or not the altitude of the entity is interpreted as "above terrain" or as absolute altitude.

3D object type specific

Orientation

X

double[3]

Heading, pitch and roll angles.

Scale

X

double[3]

Scale in x, y and z direction of the 3D object coordinate system.

Collidable

X

boolean

Whether or not the 3D object is collidable.

DoubleSided

X

boolean

Whether or not the 3D object is double-sided.

POI type specific

Hyperlink

X

string

The Hyperlink associated with the POI.

POIType

X

int (i4)

The POI type. (0 = Text / 1 = Billboard vertical / 2 = Billboard camera faced)

UseInfoBoard

X

boolean

Whether or not the hyperlink is opened in an Infoboard  instead of an external application.

BillboardScale

X

double

The scale of the billboard image.

ShowName

X

boolean

Whether or not the POI name is shown.

NameOffset

X

double

The vertical distance from the POI center to the name text.

Opacity

X

double

The opacity of the POI.

FontName

X

string

The name of the font used to draw the POI name.

FontStyle

X

int (i4)

The font style used to draw the POI name. (0 = normal / 1 = bold / 2 = italic / 3 = bold+italic)

FontColor

X

double[3]

The color used to draw the POI name.

FontSize

X

double

The size of the name text in selected distance units.

DecorationLineEnabed

X

boolean

Whether or not the vertical line beneath the POI is enabled.

DecorationLineColor

X

double[4]

The color of the vertical line.

POICameraPosition

X

double[3]

The position of the camera for this POI.

POICameraHPR

X

double[3]

The heading, pitch and roll of the camera for this POI.