Skip to content

Commit

Permalink
Doc adjustments
Browse files Browse the repository at this point in the history
  • Loading branch information
j9liu committed Sep 26, 2024
1 parent dc19682 commit d9b8693
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 23 deletions.
17 changes: 9 additions & 8 deletions Runtime/Cesium3DTileset.cs
Original file line number Diff line number Diff line change
Expand Up @@ -719,24 +719,25 @@ public bool createPhysicsMeshes
public partial void FocusTileset();

/// <summary>
/// Initiates an asynchronous query for the height of this tileset at a list of positions,
/// expressed as longitude and latitude. The most detailed available tiles are used to
/// determine each height.
/// Initiates an asynchronous query for the height of this tileset at a list of
/// cartographic positions, where the longitude (X) and latitude (Y) are given in degrees.
/// The most detailed available tiles are used to determine each height.
/// </summary>
/// <remarks>
/// <para>
/// The height of the input positions is ignored. On output, the height is
/// expressed in meters above the ellipsoid (usually WGS84), which should not
/// be confused with a height above mean sea level.
/// The height of the input positions is ignored, unless height sampling fails
/// at that location. The output height is expressed in meters above the ellipsoid
/// (usually WGS84), which should not be confused with a height above mean sea level.
/// </para>
/// <para>
/// Use <see cref="WaitForTask"/> inside a coroutine to wait for the asynchronous height
/// query to complete.
/// </para>
/// </remarks>
/// <param name="longitudeLatitudeHeightPositions">
/// The positions for which to sample heights. The X component is the Longitude (degrees),
/// the Y component is the Latitude (degrees), and the Z component is the Height (meters).
/// The cartographic positions for which to sample heights. The X component is the
/// Longitude (degrees), the Y component is the Latitude (degrees), and the Z component
/// is the Height (meters).
/// </param>
/// <returns>An asynchronous task that will provide the requested heights when complete.</returns>
public partial Task<CesiumSampleHeightResult> SampleHeightMostDetailed(params double3[] longitudeLatitudeHeightPositions);
Expand Down
30 changes: 15 additions & 15 deletions Runtime/CesiumSampleHeightResult.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,34 +8,34 @@ namespace CesiumForUnity
public class CesiumSampleHeightResult
{
/// <summary>
/// The positions and sampled heights. The X component is Longitude (degrees), the
/// Y component is Latitude (degrees), and the Z component is Height (meters) above
/// the ellipsoid (usually WGS84).
/// The positions and their sampled heights. The X component is Longitude (degrees),
/// the Y component is Latitude (degrees), and the Z component is Height (meters)
/// above the ellipsoid (usually WGS84).
/// </summary>
/// <remarks>
/// <para>
/// The longitudes and latitudes will match the values at the same index in the
/// original input positions. Each height will either be the height sampled
/// from the tileset at that position, or the original input height if the
/// height could not be sampled. To determine which, look at the value of
/// For each resulting position, its longitude and latitude values will match
/// values from its input. Its height will either be the height sampled from
/// the tileset at that position, or the original input height if the sample
/// was unsuccessful. To determine which, look at the value of
/// <see cref="CesiumSampleHeightResult.heightSampled"/> at the same index.
/// </para>
/// <para>
/// The returned height is is measured from the ellipsoid, which is usually WGS84.
/// It should not be confused with a height about Mean Sea Level.
/// The returned height is measured from the ellipsoid (usually WGS84) and
/// should not be confused with a height above Mean Sea Level.
/// </para>
/// </remarks>
public double3[] longitudeLatitudeHeightPositions { get; set; }

/// <summary>
/// Specifies whether the height for the position at this index was sampled successfully.
/// Indicates whether the height for the position at the corresponding index was sampled
/// successfully.
/// </summary>
/// <remarks>
/// If true, <see cref="CesiumSampleHeightResult.longitudeLatitudeHeightPositions"/> has
/// a valid height sampled from the tileset at this index. If false, the height
/// could not be sampled for the position at this index, and so the height in
/// <see cref="CesiumSampleHeightResult.longitudeLatitudeHeightPositions"/> is unchanged
/// from the original input height.
/// If true, then the corresponding position in
/// <see cref="CesiumSampleHeightResult.longitudeLatitudeHeightPositions"/> uses
/// the height sampled from the tileset. If false, the height could not be sampled for
/// the position, so its height is the same as the original input height.
/// </remarks>
public bool[] heightSampled { get; set; }

Expand Down

0 comments on commit d9b8693

Please sign in to comment.