Add doc and CHANGES.md update.

This commit is contained in:
Kevin Ring 2023-03-23 23:24:05 +11:00
parent 194d42d138
commit b6cf23118b
2 changed files with 14 additions and 0 deletions

View File

@ -15,6 +15,7 @@
- Changed how `TilesetOptions::forbidHoles` works so that it loads much more quickly, while still guaranteeing there are no holes in the tileset.
- Added `frameNumber` property to `ViewUpdateResult`.
- Added getters for the `stride` and `data` fields of `AccessorView`.
- Added `startNewFrame` method to `ITileExcluder`.
##### Fixes :wrench:

View File

@ -11,7 +11,20 @@ class Tile;
class ITileExcluder {
public:
virtual ~ITileExcluder() = default;
/**
* @brief Indicates the start of a new frame, initiated with a call to {@link Tileset::updateView}.
*/
virtual void startNewFrame() noexcept {}
/**
* @brief Determines whether a given tile should be excluded.
*
* @param tile The tile to test
* @return true if this tile and all of its descendants in the bounding volume
* hiearchy should be excluded from loading and rendering.
* @return false if this tile should be included.
*/
virtual bool shouldExclude(const Tile& tile) const noexcept = 0;
};