I3DViewshed80

This interface provides properties and methods for calculating and creating a graphical representation of the area on the terrain and on 3D models and objects that is visible from a specified position.

 

 

Properties

 

Action

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

Attachment

An IAttachment80 representing the attachment behavior of the 3D viewshed.

Distance

Gets and sets the distance, in meters, between the viewshed analysis and the viewer.

FieldOfViewX

Gets and sets the horizontal angle limits, in degrees, of the viewshed.

FieldOfViewY

Gets and sets the vertical angle limits, in degrees, of the viewshed.

HiddenAreaColor

An IColor80 representing the fill color of the areas that are not visible from the viewpoint.

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 representing the viewshed on the terrain. (Inherited from ITerraExplorerObject80)

Position

An IPosition80 that defines the position and orientation of the viewshed on the terrain, as well as the distance from which it is viewed when flying to it (or circling it, for example).

Quality

Gets and sets an enum that determines the accuracy level of the viewshed.

RayColor

An IColor80 representing the color of the rays (lines of sight) in the viewshed area sector.

RefreshRate

Gets and sets an enum that determines the refresh rate of the viewshed.

SaveInFlyFile

Gets and sets a Boolean that determines whether the viewshed is saved in the Fly file. (Inherited from ITerraExplorerObject80)

Terrain

An ITerrainObject80 representing terrain properties including draw order and ground object status.

Note:    The Terrain.Tint property does not apply to 3D viewsheds.

TimeSpan

An ITimeSpan80 representing the timespan in which the viewshed is visible on the terrain.

Tooltip

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

TreeItem

An ITreeItem80 representing details about the representation of the viewshed in the Project Tree.

Visibility

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

VisibleAreaColor

An IColor80 representing the fill color of the areas that are visible from the viewpoint.

 

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)

SetClientData

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

SetParam

Reserved. Currently not used. (Inherited from ITerraExplorerObject80)

 

Distance

Gets and sets the distance of the viewshed analysis from the viewer in meters.

JavaScript

 

Distance

 

C#

 

double Distance { get; set; }

 

C++

 

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

HRESULT Distance([in] double pVal)

FieldOfViewX

Gets and sets the horizontal angle limits of the viewshed. Values are in degrees from 0 to 120. For a spherical 3D viewshed, FieldOfViewX should be set to 360.

 

JavaScript

 

FieldOfViewX

 

C#

 

double FieldOfViewX { get; set; }

 

C++

 

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

HRESULT FieldOfViewX([in] double pVal)

 

FieldOfViewY

Gets and sets the vertical angle limits of the viewshed. Values are in degrees from 0 to 120. For a spherical 3D viewshed, FieldOfViewY should be set to 360.

 

JavaScript

 

FieldOfViewY

 

C#

 

double FieldOfViewY { get; set; }

 

C++

 

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

HRESULT FieldOfViewY([in] double pVal)

 

Quality

Gets and sets an enum that determines the accuracy level of the viewshed. The following are the possible values:

§   VSQ_QUALITY_LOW = 0

§   VSQ_QUALITY_MEDIUM = 1

§   VSQ_QUALITY_HIGH = 2

 

JavaScript

 

Quality

 

C#

 

ViewshedQuality Quality { get; set; }

 

C++

 

HRESULT Quality([out, retval] ViewshedQuality* pVal)

HRESULT Quality([in] ViewshedQuality pVal)

 

RefreshRate

Gets and sets an enum that determines the refresh rate of the viewshed. The following are the possible values:

§   VSRR_REFRESH_RATE_SLOW = 0

§   VSRR_REFRESH_RATE_HEIGH = 1

 

JavaScript

 

RefreshRate

 

C#

 

ViewshedRefreshRate RefreshRate { get; set; }

 

C++

 

HRESULT RefreshRate([out, retval] ViewshedRefreshRate* pVal)

HRESULT RefreshRate([in] ViewshedRefreshRate pVal)