TerrainAlongLineComputeElevationAngleAboveTerrain Method (Cartesian, Cartesian, TerrainProvider, Double, Double) |
Computes the angle from the line of sight between the target and observer positions
and the direction to the point on terrain with the highest elevation angle.
The angle is determined from the perspective of the position closest to the
Shape.
Namespace:
AGI.Foundation.Terrain
Assembly:
AGI.Foundation.TerrainAnalysis (in AGI.Foundation.TerrainAnalysis.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax public static double ComputeElevationAngleAboveTerrain(
Cartesian observerPositionFixed,
Cartesian targetPositionFixed,
TerrainProvider terrainProvider,
double minimumTerrainHeight,
double maximumTerrainHeight
)
Public Shared Function ComputeElevationAngleAboveTerrain (
observerPositionFixed As Cartesian,
targetPositionFixed As Cartesian,
terrainProvider As TerrainProvider,
minimumTerrainHeight As Double,
maximumTerrainHeight As Double
) As Double
public:
static double ComputeElevationAngleAboveTerrain(
Cartesian observerPositionFixed,
Cartesian targetPositionFixed,
TerrainProvider^ terrainProvider,
double minimumTerrainHeight,
double maximumTerrainHeight
)
static member ComputeElevationAngleAboveTerrain :
observerPositionFixed : Cartesian *
targetPositionFixed : Cartesian *
terrainProvider : TerrainProvider *
minimumTerrainHeight : float *
maximumTerrainHeight : float -> float
Parameters
- observerPositionFixed
- Type: AGI.Foundation.CoordinatesCartesian
The position of the observer object, expressed in the reference frame fixed to the
ellipsoid specified by the Shape property of the
terrainProvider.
- targetPositionFixed
- Type: AGI.Foundation.CoordinatesCartesian
The position of the target object, expressed in the reference frame fixed to the
ellipsoid specified by the Shape property of the
terrainProvider.
- terrainProvider
- Type: AGI.Foundation.TerrainTerrainProvider
The terrain provider describing the terrain that is potentially obscuring the path
between the two objects.
- minimumTerrainHeight
- Type: SystemDouble
The minimum height in meters that can be returned by the
TerrainProvider's GetHeightRelativeToShape(Double, Double) method.
Setting this value lower than necessary will not affect the results, but it will decrease
performance. Setting it too high can cause incorrect results. For realistic Earth-based terrain data,
DefaultMinimumTerrainHeight is a safe value to use for this parameter.
- maximumTerrainHeight
- Type: SystemDouble
The maximum height in meters that can be returned by the
TerrainProvider's GetHeightRelativeToShape(Double, Double) method.
Setting this value higher than necessary will not affect the results, but it will decrease
performance. Setting it too low can cause incorrect results. For realistic Earth-based terrain data,
DefaultMaximumTerrainHeight is a safe value to use for this parameter.
Return Value
Type:
Double
The angle from the line of sight between the target and observer positions
and the direction to the point on terrain with the highest elevation angle.
The angle is determined from the perspective of the position closest to the
Shape.
Positive numbers indicate that the line of sight between the objects is not obscured by terrain.
Negative numbers indicate that it is obscured.
Exceptions See Also