Home > Working with SGWorld > ISGWorld > SetOptionParam

SetOptionParam

Allows defining the value of a specified parameter in the TerraExplorer options. Each parameter is accessed by a unique identification string.

The following table describes the supported parameter string values and the respective parameter value options:

paramName

[In/Out] Type

pVal

General

"UseTerrainFadeIfAvailable"

[in, out] bool

A Boolean that determines whether terrain fade is activated.

"TerrainModelQuality"

[in, out] BSTR

Select the resolution of the polygonal terrain model. Use any of the following values:

o    0 = "Normal"

o    1 = "High"

o    2 = "Best"

Navigation

"TiltAffectsAltitude"

[in, out] bool

A Boolean that determines whether  the plane tilt affects the altitude.

Units

"Speed"

[in, out] int

Select the speed display units. Use any of the following values:

o    0 = Km/h

o    1 = Mph

o    2 = Knots

"AltitudeAndDistance"

[in, out] int

Select the altitude and distance display units. Use any of the following values:

o    0 = Meters

o    1 = Feet

"AltitudeType"

[in, out] int

Select the Altitude Type display units. Use any of the following values:

o    0 = Above Ground Level (AGL)

o    1 = Absolute Values

"LatLongCoordinates"

[in, out] int

Select the Lat-Long Coordinates display units. Use any of the following values:

o   0 = Decimal Degrees

o   1 = Degrees, Minutes, Seconds

Head Up Display

"HeadUpDisplay"

[in, out] int

Determines the Head Up Display. Use any combination of the following flags:

o   HUD_LAYER_NONE = 0

o   HUD_LAYER_ACTIVE_ARROWS = 1

o   HUD_LAYER_CENTER_SIGN = 2

o   HUD_LAYER_TEXT_DATA = 4

o   HUD_LAYER_COMPASS = 8

o   HUD_LAYER_GRAPHIC_1 = 16

o   HUD_LAYER_PAN_BARS = 32

"HudColor"

[in, out] long

The color of the HUD in the hexadecimal form: 0x00bbggrr.

 

Note:    Only some of the TerraExplorer Options parameters are exposed through this property. For other options, use the Settings dialog box. See: “Using TerraExplorer Options” chapter in the User Manual for additional information.

 

JavaScript

 

SetOptionParam(

      paramName,

      paramVal)

 

C#

 

void SetOptionParam(

      string paramName,

      object paramVal)

 

C++

 

HRESULT SetOptionParam(

       BSTR paramName,

       VARIANT paramVal)

 

Parameters

paramName

The name of the parameter whose value is being set.

paramVal

The parameter value that should be set.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.