GeoElementViewshed Class

Member Function Documentation

GeoElementViewshed::GeoElementViewshed(Esri::ArcGISRuntime::GeoElement *geoElement, double horizontalAngle, double verticalAngle, double minDistance, double maxDistance, double headingOffset, double pitchOffset, QObject *parent = nullptr)

Creates a viewshed analysis object whose observer is defined using a GeoElement.

• geoElement - A GeoElement from which the position and orientation of the observer will be determined.
• horizontalAngle - The horizontal angle of the observer's view. The value must be greater than 0 and less than or equal to 120.
• verticalAngle - The vertical angle of the observer's view. The value must be greater than 0 and less than or equal to 120.
• minDistance - The minimum distance in meters from the observer at which visibility will be evaluated.
• maxDistance - The maximum distance in meters from the observer at which visibility will be evaluated.
• headingOffset - An angle offset relative to the heading of the GeoElement to determine the direction of the observer's view.
• pitchOffset - An angle added to (or removed from) the pitch of the GeoElement. The combined values define the angle of the frustum (relative to the surface) used in the analysis. The valid range of values for the frustum pitch is from 0 to 180 degrees.
• parent - An optional parent.

Visible and obstructed areas are determined for an area defined by the location and orientation of a GeoElement, field of view angles, and the min/max distance range. These parameters define the frustum over which visibility is calculated from the observer element. The horizontal and vertical angles must be greater than zero and less than or equal to 120 degrees. Terrain and other obstacles between the observer and the minimum distance are excluded from the analysis, as are areas beyond the maximum distance. Supported GeoElement types are Graphic, Feature, DynamicEntity, and DynamicEntityObservation.

[override virtual] GeoElementViewshed::~GeoElementViewshed()

Destructor.

Esri::ArcGISRuntime::GeoElement *GeoElementViewshed::geoElement() const

Returns the GeoElement that represents the observer for the viewshed analysis.

The observer's location, heading, and pitch are determined by the location and orientation of this GeoElement. Supported GeoElement types are Graphic, Feature, DynamicEntity, and DynamicEntityObservation.

double GeoElementViewshed::headingOffset() const

Returns the offset angle applied to the heading of the GeoElement.

The observer's heading is determined by the GeoElement heading plus the heading offset.

See also setHeadingOffset().

double GeoElementViewshed::offsetX() const

Returns the location offset in the X direction that defines the observer relative to the GeoElement.

The observer location is determined by the GeoElement location plus the offset X,Y,Z values. Any rotations applied to the GeoElement will also be applied to the X,Y,Z offsets. This allows the observer to be positioned relative to the GeoElement and maintain the relative position even when the GeoElement moves and rotates.

See also setOffsetX().

double GeoElementViewshed::offsetY() const

Returns the location offset in the Y direction that defines the observer relative to the GeoElement.

The observer location is determined by the GeoElement location plus the offset X,Y,Z values. Any rotations applied to the GeoElement will also be applied to the X,Y,Z offsets. This allows the observer to be positioned relative to the GeoElement and maintain the relative position even when the GeoElement moves and rotates.

See also setOffsetY().

double GeoElementViewshed::offsetZ() const

Returns the location offset in the Z direction that defines the observer relative to the GeoElement.

The observer location is determined by the GeoElement location plus the offset X,Y,Z values. Any rotations applied to the GeoElement will also be applied to the X,Y,Z offsets. This allows the observer to be positioned relative to the GeoElement and maintain the relative position even when the GeoElement moves and rotates.

See also setOffsetZ().

double GeoElementViewshed::pitchOffset() const

Returns the offset angle applied to the pitch of the GeoElement.

The observer pitch is determined by the GeoElement pitch plus the pitch offset. The valid range of values for the observer pitch is from 0 to 180 degrees.

See also setPitchOffset().

void GeoElementViewshed::setHeadingOffset(double headingOffset)

Sets the headingOffset to headingOffset.

The observer's heading is determined by the GeoElement heading plus the heading offset.

See also headingOffset().

void GeoElementViewshed::setOffsetX(double offsetX)

Sets the offsetX to offsetX.

See also offsetX().

void GeoElementViewshed::setOffsetY(double offsetY)

Sets the offsetY to offsetY.

See also offsetY().

void GeoElementViewshed::setOffsetZ(double offsetZ)

Sets the offsetZ to offsetZ.

See also offsetZ().

void GeoElementViewshed::setPitchOffset(double pitchOffset)

Sets the pitchOffset to pitchOffset.

See also pitchOffset.