cesium-native  0.41.0
Cesium3DTilesSelection::RasterizedPolygonsTileExcluder Class Reference

When provided to TilesetOptions::excluders, uses the polygons owned by a RasterizedPolygonsOverlay to exclude tiles that are entirely inside any of the polygon from loading. This is useful when the polygons will be used for clipping. More...

#include <Cesium3DTilesSelection/RasterizedPolygonsTileExcluder.h>

Inheritance diagram for Cesium3DTilesSelection::RasterizedPolygonsTileExcluder:
Cesium3DTilesSelection::ITileExcluder

Public Member Functions

 RasterizedPolygonsTileExcluder (const CesiumUtility::IntrusivePointer< const CesiumRasterOverlays::RasterizedPolygonsOverlay > &pOverlay) noexcept
 Constructs a new instance. More...
 
virtual bool shouldExclude (const Tile &tile) const noexcept override
 Determines whether a given tile is entirely inside a polygon and therefore should be excluded. More...
 
const CesiumRasterOverlays::RasterizedPolygonsOverlaygetOverlay () const
 Gets the overlay defining the polygons.
 
- Public Member Functions inherited from Cesium3DTilesSelection::ITileExcluder
virtual void startNewFrame () noexcept
 Indicates the start of a new frame, initiated with a call to Tileset::updateView.
 

Detailed Description

When provided to TilesetOptions::excluders, uses the polygons owned by a RasterizedPolygonsOverlay to exclude tiles that are entirely inside any of the polygon from loading. This is useful when the polygons will be used for clipping.

Definition at line 20 of file RasterizedPolygonsTileExcluder.h.

Constructor & Destructor Documentation

◆ RasterizedPolygonsTileExcluder()

Cesium3DTilesSelection::RasterizedPolygonsTileExcluder::RasterizedPolygonsTileExcluder ( const CesiumUtility::IntrusivePointer< const CesiumRasterOverlays::RasterizedPolygonsOverlay > &  pOverlay)
noexcept

Constructs a new instance.

Parameters
overlayThe overlay definining the polygons.

Member Function Documentation

◆ shouldExclude()

virtual bool Cesium3DTilesSelection::RasterizedPolygonsTileExcluder::shouldExclude ( const Tile tile) const
overridevirtualnoexcept

Determines whether a given tile is entirely inside a polygon and therefore should be excluded.

Parameters
tileThe tile to check.
Returns
true if the tile should be excluded because it is entirely inside a polygon.

Implements Cesium3DTilesSelection::ITileExcluder.


The documentation for this class was generated from the following file: