ITerrainRasterLayer80

This interface gives the client access to imagery and elevation layers. The raster file name is defined by FillStyle.Texture.FileName.

	Properties
	Action	An IAction80 representing the operation that takes place when the layer is clicked in the Project Tree.
	Attachment	An IAttachment80 representing the attachment behavior of the layer.
	CoordinateSystem	An ICoordinateSystem80 representing the source’s coordinate system.
	DataSourceBBox	An IBBox2D80 representing the coordinates of the data source’s 2D bounding box (Read-only). If no geo-information exists in the data source, the coordinates returned will be 0,0,0,0.
	DataSourceWKT	Gets the unique string of the Well-Known Text of the raster layer.
	DisplayName	Gets the name of the raster layer as displayed in the Imagery/Elevation Layer property sheet.
	Elevation	Gets a Boolean that determines whether the layer is an elevation layer.
	ElevationOffset	Gets and sets the elevation offset.
	ElevationScale	Gets and sets the scale factor for the elevation value.
	FileName	Gets the full path or URL to the raster layer.
	FillColor	An IColor80 representing the fill color. This property provides control over the opacity of the raster layer using IColor80's SetAlpha and GetAlpha properties.
	Geometry	An IGeometry representing geometric properties and behavior of the layer.
	ID	Gets the ID of the layer. (Inherited from ITerraExplorerObject80)
	Imagery	Gets a Boolean that determines whether the layer is an imagery layer.
	InitParam	Gets the persistence strings used by some plugins, e.g., to describe layer information, for layers not stored on a local storage drive, such as WMS or SGS layers.
	LineStyle	An ILineStyle80 representing the style of the layer outline.
	Message	An IMessageObject80 representing the message object assigned to the layer.
	NullTolerance	Gets and sets the permissible deviation from the specified Null value.
	NullValue	Gets and sets the color or elevation value to be nullified.
	ObjectType	Gets an enum that identifies the type of the object. (Inherited from ITerraExplorerObject80)
	PlugName	Gets the name of the plugin used to read the file, e.g., “ gdlplg.rct“. The available plugins are files with RCT extension that exist in the “TBPlugs directory.
	Position	An IPosition80 representing the position and orientation of the layer on the terrain.
	Reproject	Gets and sets a Boolean that determines if the layer’s data is reprojected from the source coordinate system to the terrain’s coordinate system.
	ReprojectElevation	Gets and sets a Boolean that determines if the layer’s elevation coordinates are reprojected from the layer’s coordinate system to the terrain’s coordinate system.
	SaveInFlyFile	Gets and sets a Boolean that determines whether the layer is saved in the Fly file. (Inherited from ITerraExplorerObject80)
	Terrain	An ITerrainObject80 representing terrain properties including draw order and ground object status.
	Timespan	An ITimeSpan80 representing the timespan in which the layer is visible on the terrain.
	Tooltip	An ITooltip80 representing the tooltip that displays when a mouse cursor is placed over the layer in the 3D Window.
	TreeItem	An ITreeItem80 describing the representation of the layer in the Project Tree.
	UseNull	Gets and sets a Boolean that determines whether the color or elevation NullValue is nullified.
	Visibility	An IVisibility80 representing the visibility of the layer at different distances.
	Methods
	GetClientData	Gets an array of text strings assigned to each object global namespace. (Inherited from ITerraExplorerObject80)
	GetParam	Reserved. Currently not used. (Inherited from ITerraExplorerObject80)
	Refresh	Automatically refreshes the raster layer data.
	RefreshRect	Refreshes layer in the defined area.
	SetClientData	Sets an array of text strings assigned to each object global namespace. (Inherited from ITerraExplorerObject80)
	SetParam	Reserved. Currently not used. (Inherited from ITerraExplorerObject80)

DataSourceWKT

Gets the unique string of the Well-Known Text of the raster layer. If the raster layer has no geo-information, an empty string will be returned.

JavaScript
DataSourceWKT

C#
string DataSourceWKT { get; }

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

DisplayName

Gets the name of the raster layer as displayed in the Imagery/Elevation Layer property sheet.

JavaScript
DisplayName

C#
string DisplayName { get; }

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

Elevation

Gets a Boolean that determines whether the layer is an elevation layer.

JavaScript
Elevation

C#
bool Elevation { get; }

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

ElevationOffset

Gets and sets the elevation offset. This property enables you to adjust several elevation sources that are defined with reference to different baselines, such as different sea levels. The elevation data in the source file is changed to a new value where: New Value = Old Value * ElevationScale + ElevationOffset.

JavaScript
ElevationOffset

C#
double ElevationOffset { get; set; }

C++

HRESULT ElevationOffset([out, retval] double* pVal)

HRESULT ElevationOffset([in] double pVal)

ElevationScale

Gets and sets the scale factor for the elevation value. This property enables you to adjust several elevation sources that are defined with reference to different baselines, such as different sea levels. The elevation data in the source file is changed to a new value where: New Value = Old Value * ElevationScale + ElevationOffset.

JavaScript
ElevationScale

C#
double ElevationScale { get; set; }

C++

HRESULT ElevationScale([out, retval] double* pVal)

HRESULT ElevationScale([in] double pVal)

FileName

Gets the full path or URL to the raster layer.

Note: When the layer is not based on a file, other information may be included in the returned value.

JavaScript
FileName

C#
string FileName { get; }

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

Imagery

Gets a Boolean that determines whether the layer is an imagery layer.

JavaScript
Imagery

C#
bool Imagery { get; }

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

InitParam

Gets the persistence strings used by some plugins, e.g., to describe layer information, for layers not stored on a local storage drive, such as WMS or SGS layers.

JavaScript
InitParam

C#
string InitParam { get; }

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

NullTolerance

Gets and sets the permissible deviation from the specified NullValue when the color value is irregular.

JavaScript
NullTolerance

C#
double NullTolerance { get; set; }

C++

HRESULT NullTolerance ([out, retval] double* pVal)

HRESULT NullTolerance ([in] double pVal)

NullValue

In an imagery layer, this is the color value to be nullified making the underlying terrain visible. This value is expressed as an integer in ABGR color format (0xAABBGGRR).

In an elevation layer, this is the elevation value to be nullified, thereby cancelling the value's elevation effect. This value is expressed as a double.

JavaScript
NullValue

C#
dynamic NullValue { get; set; }

C++

HRESULT NullValue([out, retval] VARIANT* pVal)

HRESULT NullValue([in] VARIANT pVal)

PlugName

Gets the name of the plugin used to read the file, e.g., “gdlplg.rct“. The available plugins are files with RCT extension that exist in the TBPlugs directory.

JavaScript
PlugName

C#
string PlugName { get; }

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

Reproject

Gets and sets a Boolean that determines if the layer’s data is reprojected from the source coordinate system to the terrain’s coordinate system.

Note: Changes are applied only following a call to Refresh().

JavaScript
Reproject

C#
bool Reproject { get; set; }

C++

HRESULT Reproject([out, retval] VARIANT_BOOL* pVal)

HRESULT Reproject([in] VARIANT_BOOL pVal)

ReprojectElevation

Gets and sets a Boolean that determines if the layer’s elevation coordinates are reprojected from the layer’s coordinate system to the terrain’s coordinate system. This property applies only to feature layers whose Position.AltitudeType is set to ATC_Terrain_Absolute = 3. Geocentric layers are always reprojected even if this property is set to false.

Note: Changes are applied only following a call to Refresh().

JavaScript
ReprojectElevation

C#
bool ReprojectElevation { get; set; }

C++

HRESULT ReprojectElevation([out, retval] VARIANT_BOOL* pVal)

HRESULT ReprojectElevation ([in] VARIANT_BOOL pVal)

UseNull

Gets and sets a Boolean that determines whether the color or elevation NullValue is nullified, making the underlying terrain visible or cancelling the value's elevation effect. If set to TRUE, the NullValue is nullified; if set to FALSE, the values remain.

JavaScript
UseNull

C#
bool UseNull { get; set; }

C++

HRESULT UseNull([out, retval] VARIANT_BOOL* pVal)

HRESULT UseNull([in] VARIANT_BOOL pVal)

Refresh

Automatically refreshes the raster layer after a set interval of time. Set the AutoRefreshTimeInterval to 0 for a one time refresh operation.

JavaScript

Refresh(

AutoRefreshTimeInterval)

void Refresh(

int AutoRefreshTimeInterval)

C++

HRESULT Refresh(

int AutoRefreshTimeInterval)

Parameters

AutoRefreshTimeInterval

The frequency (in seconds) of the auto refresh. Valid values range from 10-36000. Set the AutoRefreshTimeInterval to 0 for a one time refresh operation.

Exceptions

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

RefreshRect

This method refreshes the layer in the defined area.

JavaScript

RefreshRect(

MinX,

MinY,

MaxX,

MaxY))

void RefreshRect(

double MinX,

double MinY,

double MaxX,

double MaxY)

C++

HRESULT RefreshRect (

double MinX,

double MinY,

double MaxX,

double MaxY))

Exceptions

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