root
/
cesium-native
mirror of https://github.com/CesiumGS/cesium-native.git
1
0
Fork 0
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Doc tweaks

This commit is contained in:
Janine Liu 2024-09-25 18:24:52 -04:00
parent 7645a91455
commit 23308ba502
3 changed files with 28 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Cesium3DTilesSelection/include/Cesium3DTilesSelection/Tile.h
View File

@ -507,11 +507,11 @@ private:
* by the {@link TilesetContentLoader}.
*
* When true, this tile might have children that can be created by the
* TilesetContentLoader but that aren't reflected in the `_children` property
* yet. For example, in implicit tiling, we save memory by only creating
* explicit Tile instances from implicit availability as those instances are
* needed. When this flag is true, that creation of explicit instances hasn't
* been done yet for this tile.
* TilesetContentLoader but aren't yet reflected in the `_children` property.
* For example, in implicit tiling, we save memory by only creating explicit
* Tile instances from implicit availability as those instances are needed.
* When this flag is true, the creation of those explicit instances hasn't
* happened yet for this tile.
*
* If this flag is false, the children have already been created, if they
* exist. The tile may still have no children because it is a leaf node.

2
Cesium3DTilesSelection/include/Cesium3DTilesSelection/Tileset.h
View File

@ -276,7 +276,7 @@ public:
/**
* @brief Initiates an asynchronous query for the height of this tileset at a
* list of positions, expressed as longitude and latitude. The most detailed
* list of positions, expressed in longitude and latitude. The most detailed
* available tiles are used to determine each height.
*
* The height of the input positions is ignored. On output, the height is

44
Cesium3DTilesSelection/src/TilesetHeightQuery.h
View File

@ -50,19 +50,19 @@ public:
std::optional<CesiumGltfContent::GltfUtilities::RayGltfHit> intersection;
/**
* @brief The query ray intersect the bounding volume of these non-leaf tiles
* that are still relevant because of additive refinement.
* @brief Non-leaf tiles with additive refinement whose bounding volumes are
* intersected by the query ray.
*/
std::vector<Tile*> additiveCandidateTiles;
/**
* @brief The current set of leaf tiles whose bounding volume the query ray
* passes through.
* @brief The current set of leaf tiles whose bounding volumes are intersected
* by the query ray.
*/
std::vector<Tile*> candidateTiles;
/**
* @brief The previous set of leaf files. Swapping `candidateTiles` and
* @brief The previous set of leaf tiles. Swapping `candidateTiles` and
* `previousCandidateTiles` each frame allows us to avoid a heap allocation
* for a new vector each frame.
*/
@ -70,19 +70,19 @@ public:
/**
* @brief Find the intersection of the ray with the given tile. If there is
* one, and it is closer to the origin of the ray than the previous
* best-known intersection, then {@link TilesetHeightQuery::intersection}
* will be updated.
* one, and if it's closer to the ray's origin than the previous best-known
* intersection, then {@link TilesetHeightQuery::intersection} will be
* updated.
*
* @param pTile The tile to test for intersection with the ray.
* @param outWarnings On return, any warnings that occurred while attempting
* to intersect the ray with the given tile.
* @param outWarnings On return, reports any warnings that occurred while
* attempting to intersect the ray with the tile.
*/
void intersectVisibleTile(Tile* pTile, std::vector<std::string>& outWarnings);
/**
* @brief Find the candidate tiles for query by traversing the tile tree
* starting with a given tile.
* @brief Find candidate tiles for the height query by traversing the tile
* tree, starting with the given tile.
*
* Any tile whose bounding volume intersects the ray will be added to the
* {@link TilesetHeightQuery::candidateTiles} vector. Non-leaf tiles that are
@ -91,10 +91,10 @@ public:
*
* @param pTile The tile at which to start traversal.
* @param loadedTiles The linked list of loaded tiles, used to ensure that
* tiles loaded for height queries stay loaded long enough to complete the
* query and no longer.
* @param outWarnings On return, any warnings that occurred during candidate
* search.
* tiles loaded for height queries stay loaded just long enough to complete
* the query, and no longer.
* @param outWarnings On return, reports any warnings that occurred during
* candidate search.
*/
void findCandidateTiles(
Tile* pTile,
@ -119,13 +119,13 @@ struct TilesetHeightRequest {
/**
* @brief Process a given list of height requests. This is called by the {@link Tileset}
* every call to {@link Tileset::updateView}.
* in every call to {@link Tileset::updateView}.
*
* @param contentManager The content manager.
* @param options Options associated with the tileset.
* @param loadedTiles The linked list of loaded tiles, used to ensure that
* tiles loaded for height queries stay loaded long enough to complete the
* query and no longer.
* tiles loaded for height queries stay loaded just long enough to complete
* the query, and no longer.
* @param heightRequests The list of all height requests. Completed requests
* will be removed from this list.
* @param heightQueryLoadQueue Tiles that still need to be loaded before all
@ -152,13 +152,13 @@ struct TilesetHeightRequest {
/**
* @brief Tries to complete this height request. Returns false if further data
* still needs to be loaded and so the request cannot be completed yet.
* still needs to be loaded and thus the request cannot yet complete.
*
* @param contentManager The content manager.
* @param options Options associated with the tileset.
* @param loadedTiles The linked list of loaded tiles, used to ensure that
* tiles loaded for height queries stay loaded long enough to complete the
* query and no longer.
* tiles loaded for height queries stay loaded just long enough to complete
* the query, and no longer.
* @param tilesNeedingLoading Tiles that needs to be loaded before this height
* request can complete.
*/