ITerrainModifier80

A terrain modifier object is a unique polygon in the TerraExplorer world that changes the elevation values of the terrain, raising or lowering the surface of the terrain according to the elevation values of the polygon's points. Different elevation behaviors allow replacing, cropping above or cropping below the original values of the terrain.

 

Properties

 

Action

An IAction80 representing the operation that takes place when the object is clicked in the Project Tree.

ApplyTo

Gets and sets which ID of the 3DML in the area of the terrain modifier object, the terrain modifier object is applied to.

Attachment

An IAttachment80 representing the attachment behavior of the object.

DrawOrder

Gets and sets the draw order between objects.

ElevationBehavior

Gets and sets how the terrain modifier acts upon the terrain (crop above, crop below, replace).

Flat

Gets and sets a Boolean that determines if all points of the modified terrain are set at the same altitude.

Geometry

An IGeometry representing geometric properties and behavior of the 3D polygon.

ID

Gets the ID of the object. (Inherited from ITerraExplorerObject80)

Message

An IMessageObject80 representing the message object assigned to the object.

ObjectType

Gets an enum that identifies  the type of the object. (Inherited from ITerraExplorerObject80)

Position

An IPosition80 representing the position and orientation of the object on the terrain.

SaveInFlyFile

Gets and sets a Boolean that determines whether the object 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 object is visible on the terrain.

Tooltip

An ITooltip80 representing the tooltip that displays when a mouse cursor is placed over the object in the 3D Window.

TreeItem

An ITreeItem80 describing the representation of the object in the Project Tree.

Visibility

An IVisibility80 representing the visibility of the object at different distances.

 

Methods

 

GetClientData

Gets an array of text strings assigned to each object global namespace. (Inherited from ITerraExplorerObject80)

GetFeather

Returns the distance along which the gradual fading of the edges of the modified terrain is applied.

GetParam

Reserved. Currently not used. (Inherited from ITerraExplorerObject80)

SetClientData

Sets an array of text strings assigned to each object global namespace. (Inherited from ITerraExplorerObject80)

SetFeather

Sets the distance along which the gradual fading of the edges of the modified terrain is applied.

SetParam

Reserved. Currently not used. (Inherited from ITerraExplorerObject80)

 

ApplyTo

Gets and sets which ID of the 3DML in the area of the terrain modifier object, the terrain modifier object is applied to.

 

JavaScript

 

 

 

ApplyTo

 

C#

 

 

 

string ApplyTo { get; set; }

 

C++

 

 

 

HRESULT ApplyTo([in] BSTR MeshObjectID)

HRESULT ApplyTo([out, retval] BSTR* MeshObjectID)

 

DrawOrder

Gets and sets the draw order between modify terrain objects.

 

JavaScript

 

 

 

DrawOrder

 

C#

 

 

 

double DrawOrder { get; set; }

 

C++

 

 

 

HRESULT DrawOrder ([in] double* pVal)

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

 

ElevationBehavior

Gets and sets an enum that determines the elevation behavior. The following are the possible values:

§   EB_REPLACE = 0
Replaces the area defined by the modified terrain with the selected elevation value.

§   EB_BELOW = 1
Replaces all elevation values that are lower than the selected elevation value with the selected elevation value.

§   EB_ABOVE = 2
Replaces all elevation values that are higher than the selected elevation value with the selected elevation value.

§   EB_OFFSET = 3
Offsets the area defined by the polygon with the selected elevation value.

 

JavaScript

 

 

 

ElevationBehavior

 

C#

 

 

 

ElevationBehaviorMode ElevationBehavior { get; set; }

 

C++

 

 

 

HRESULT ElevationBehavior([out, retval] ElevationBehaviorMode* pVal)

HRESULT ElevationBehavior([in] ElevationBehaviorMode pVal)

Flat

Gets and sets a Boolean that determines if all points of the modified terrain are set at the same altitude, creating a horizontal flat surface.

 

JavaScript

 

 

 

Flat

 

C#

 

 

 

bool Flat { get; set; }

 

C++

 

 

 

 

HRESULT Flat([in] VARIANT_BOOL newVal)

HRESULT Flat([out, retval] VARIANT_BOOL* newVal)

GetFeather

Returns the distance along which the gradual fading of the edges of the modified terrain is applied.

 

JavaScript

 

 

 

GetFeather()

 

C#

 

 

 

double GetFeather()

 

C++

 

 

 

HRESULT GetFeather(

       double dFeather)

Return Value

dFeather

The radius of the feather.

Exceptions

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

 

SetFeather

Determines the distance along which the gradual fading of the edges of the modified terrain is applied.

Applying a feather creates continuous diagonal surfaces. These surfaces start from the terrain database elevation value on the polygon to the modified terrain elevation value at its respective point on the feather polyline. Gradual fading of the edges is applied within the distance defined by the radius (dfeather) parameter.

 

JavaScript

 

 

 

SetFeather(

       dFeather)

 

C#

 

 

 

void SetFeather(

       double dFeather)

 

C++

 

 

 

HRESULT SetFeather(

       double dFeather)

Parameters

dFeather

The radius of the feather.

Exceptions

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