IContourMap80
This interface gives the client access to the contour map object. A contour map is a topographic map that portrays differences in terrain elevation by connecting points of equal elevation with contour lines or by coloring terrain according to varying altitudes.
|
Properties |
|
|
An IAction80 representing the operation that takes place when the object is clicked in the Project Tree. |
|
|
An IAttachment80 representing the attachment behavior of the contour map. |
|
|
Gets and sets the y-coordinate of the bottom-right corner of the rectangle that defines the coverage area of the contour map. |
|
|
Gets and sets an enum that determines the color that should be applied to all the terrain whose altitude is not within the Min/Max range. |
|
|
An IColor80 representing the color of the contour lines. |
|
|
Gets and sets the elevation spacing between the contour lines. The base for the contour lines is at zero elevation above the terrain database vertical datum base ellipsoid. |
|
|
Gets and sets an enum that determines the coverage area of the contour map. |
|
|
Gets and sets the contour map depth (length), in the units set by ISGWorld.SetOptionParam. |
|
|
Gets and sets an enum that determines how the contour map is displayed. |
|
|
Gets and sets the ID of the contour map object. (Inherited from ITerraExplorerObject80) |
|
|
Gets and sets the x-coordinate of the top-left corner of the rectangle that defines the coverage area of the contour map. |
|
|
Gets and sets the maximum altitude value for which contour colors and lines should be displayed. |
|
|
An IMessageObject80 representing the message object assigned to the contour map. |
|
|
Gets and sets the minimum altitude value for which contour colors and lines should be displayed. |
|
|
Gets an enum that identifies the type of the object. (Inherited from ITerraExplorerObject80) |
|
|
Gets and sets the opacity value of the contour map. |
|
|
Gets and sets the GUID for the contour map’s custom palette. . |
|
|
An IPosition80 representing the position and orientation of the contour map on the terrain. |
|
|
Gets and sets the x-coordinate of the bottom-right corner of the rectangle that defines the coverage area of the contour map. |
|
|
Gets and sets a Boolean that determines whether the contour map is saved in the Fly file. (Inherited from ITerraExplorerObject80) |
|
|
An ITerrainObject80 representing terrain properties including draw order and ground object status. |
|
|
An ITimeSpan80 |
|
|
An ITooltip80 |
|
|
Gets and sets the y-coordinate of the top-left corner of the rectangle that defines the coverage area of the contour map. |
|
|
An ITreeItem80 representing details about the representation of the contour map in the Project Tree. |
|
|
Gets and sets a Boolean that determines whether contour colors and lines are displayed only for areas of the terrain whose altitude value is between the MinElevation and MaxElevation or for all altitude values. |
|
|
An IVisibility80 |
|
|
Gets and sets the width of the CoverageArea rectangle, in the units set by ISGWorld.SetOptionParam. |
|
|
Methods |
|
|
Gets an array of text strings assigned to each object global namespace. (Inherited from ITerraExplorerObject80) |
|
|
GetParam |
Reserved. Currently not used. (Inherited from ITerraExplorerObject80) |
|
Sets an array of text strings assigned to each object global namespace. (Inherited from ITerraExplorerObject80) |
|
|
SetParam |
Reserved. Currently not used. (Inherited from ITerraExplorerObject80) |
Bottom
Gets and sets the y-coordinate of the bottom-right corner of the rectangle that defines the coverage area of the contour map. This property only applies when CoverageArea is set to CA_RECTANGLE.
JavaScript |
|
|
|
Bottom |
C# |
|
|
|
double Bottom { get; set; } |
C++ |
|
|
|
HRESULT Bottom([out, retval] double* pVal) HRESULT Bottom([in] double pVal) |
ColorOutsideOfRange
Gets and sets an enum that determines the color that should be applied to all the terrain whose altitude is not within the Min/Max range. This property is applied only when the UseMinMaxValues is set to TRUE.
The following are the possible values:
§ CCOR_TRANSPARENT = 0
§ CCOR_RED_BLUE = 1
JavaScript |
|
|
|
ColorOutsideOfRange |
C# |
|
|
|
ContourColorOutsideOfRange ColorOutsideOfRange { get; set; } |
C++ |
|
|
|
HRESULT ColorOutsideOfRange([out, retval] ContourColorOutsideOfRange* pVal) HRESULT ColorOutsideOfRange([in] ContourColorOutsideOfRange pVal) |
ContourLinesInterval
Gets and sets the elevation spacing between the contour lines. The base for the contour lines is at zero elevation above the terrain database vertical datum base ellipsoid. This property is applied only when the DisplayStyle property is set to CDS_CONTOUR_STYLE_LINES or CDS_CONTOUR_STYLE_LINES_AND_COLORS.
JavaScript |
|
|
|
ContourLinesInterval |
C# |
|
|
|
double ContourLinesInterval { get; set; } |
C++ |
|
|
|
HRESULT ContourLinesInterval([out, retval] double* pVal) HRESULT ContourLinesInterval([in] double pVal) |
CoverageArea
Gets and sets an enum that determines the coverage area of the contour map. The following are the possible values:
§ CA_RECTANGLE = 0
Applies the contour map to a rectangular area.
§ CA_ENTIRE_TERRAIN = 1
Applies the contour map to the entire terrain.
JavaScript |
|
|
|
CoverageArea |
C# |
|
|
|
CoverageArea CoverageArea { get; set; } |
C++ |
|
|
|
HRESULT CoverageArea([out, retval] CoverageArea* pVal) HRESULT CoverageArea([in] CoverageArea pVal) |
Depth
Gets and sets the contour map depth (length), in the units set by ISGWorld.SetOptionParam. This property only applies when CoverageArea is set to CA_RECTANGLE.
JavaScript |
|
|
|
Depth |
C# |
|
|
|
double Depth { get; set; } |
C++ |
|
|
|
HRESULT Depth([out, retval] double* pVal) HRESULT Depth([in] double pVal) |
DisplayStyle
Gets and sets an enum that determines how the contour map is displayed. The following are the possible values:
§ CDS_CONTOUR_STYLE_DEFAULT = -1
Default
§ CDS_CONTOUR_STYLE_LINES = 0
Displays contour lines at set elevation values.
§ CDS_CONTOUR_STYLE_COLORS = 1
Represents varying altitudes in different colors according to the selected color scheme.
§ CDS_CONTOUR_STYLE_LINES_AND_COLORS = 2
Displays both contour lines and contour colors
JavaScript |
|
|
|
DisplayStyle |
C# |
|
|
|
ContourDisplayStyle DisplayStyle { get; set; } |
C++ |
|
|
|
HRESULT DisplayStyle([out, retval] ContourDisplayStyle* pVal); HRESULT DisplayStyle([in] ContourDisplayStyle pVal); |
Left
Gets and sets the x-coordinate of the top-left corner of the rectangle that defines the coverage area of the contour map. This property only applies when CoverageArea is set to CA_RECTANGLE.
JavaScript |
|
|
|
Left |
C# |
|
|
|
double Left { get; set; } |
C++ |
|
|
|
HRESULT Left([out, retval] double* pVal) HRESULT Left([in] double pVal) |
MaxElevation
Gets and sets the maximum altitude value for which contour colors and lines should be displayed. This property is applied only when the UseMinMaxValues is set to TRUE.
JavaScript |
|
|
|
MaxElevation |
C# |
|
|
|
double MaxElevation { get; set; } |
C++ |
|
|
|
HRESULT MaxElevation([out, retval] double* pVal) HRESULT MaxElevation([in] double pVal) |
MinElevation
Gets and sets the minimum altitude value for which contour colors and lines should be displayed. This property is applied only when the UseMinMaxValues is set to TRUE.
JavaScript |
|
|
|
MinElevation |
C# |
|
|
|
double MinElevation { get; set; } |
C++ |
|
|
|
HRESULT MinElevation([out, retval] double* pVal) HRESULT MinElevation([in] double pVal) |
Opacity
Gets and sets the opacity for the contour map. This value can be any value between 0, for transparent, and 1 for opaque.
This property is applied only when the DisplayStyle property is set to CDS_CONTOUR_STYLE_COLORS or CDS_CONTOUR_STYLE_LINES_AND_COLORS.
JavaScript |
|
|
|
Opacity |
C# |
|
|
|
double Opacity { get; set; } |
C++ |
|
|
|
HRESULT Opacity ([out, retval] double* Opacity) HRESULT Opacity ([in] double Opacity) |
PaletteID
Gets and sets the GUID for the palette. GUIDs are listed in the palette XMLs found in the Pseudo directory, which is located under the [TerraExplorer installation]\Lang\1033 folder and under %APPDATA%\Skyline\TerraExplorer.
Note: 1033 is the English language directory. If you are running TerraExplorer in a different language, the Pseudo folder will be located under your language directory.
This property is applied only when the DisplayStyle property is set to CDS_CONTOUR_STYLE_COLORS or CDS_CONTOUR_STYLE_LINES_AND_COLORS.
JavaScript |
|
|
|
PaletteID |
C# |
|
|
|
string PaletteID { get; set; } |
C++ |
|
|
|
HRESULT PaletteID([out, retval] BSTR* pVal) HRESULT PaletteID([in] BSTR pVal) |
Right
Gets and sets the x-coordinate of the bottom-right corner of the rectangle that defines the coverage area of the contour map. This property only applies when CoverageArea is set to CA_RECTANGLE.
JavaScript |
|
|
|
Right |
C# |
|
|
|
double Right { get; set; } |
C++ |
|
|
|
HRESULT Right([out, retval] double* pVal) HRESULT Right([in] double pVal) |
Top
Gets and sets the y-coordinate of the top-left corner of the rectangle that defines the coverage area of the contour map. This property only applies when CoverageArea is set to CA_RECTANGLE.
JavaScript |
|
|
|
Top |
C# |
|
|
|
double Top { get; set; } |
C++ |
|
|
|
HRESULT Top([out, retval] double* pVal) HRESULT Top([in] double pVal) |
UseMinMaxValues
Gets and sets a Boolean that determines whether contour colors and lines are displayed only for areas of the terrain whose altitude value is between the MinElevation and MaxElevation or for all altitude values.
JavaScript |
|
|
|
UseMinMaxValues |
C# |
|
|
|
bool UseMinMaxValues { get; set; } |
C++ |
|
|
|
HRESULT UseMinMaxValues([out, retval] VARIANT_BOOL* pVal) HRESULT UseMinMaxValues([in] VARIANT_BOOL pVal) |
Width
Gets and sets the rectangle width, in the units set by ISGWorld.SetOptionParam. This property only applies when CoverageArea is set to CA_RECTANGLE.
JavaScript |
|
|
|
Width |
C# |
|
|
|
double Width { get; set; } |
C++ |
|
|
|
|
HRESULT Width([out, retval] double* pVal) HRESULT Width([in] double pVal) |