UCesiumPolygonRasterOverlay Class Reference

A raster overlay that rasterizes polygons and drapes them over the tileset. More...

#include <CesiumPolygonRasterOverlay.h>

Inheritance diagram for UCesiumPolygonRasterOverlay:

Public Member Functions
	UCesiumPolygonRasterOverlay ()
Public Member Functions inherited from UCesiumRasterOverlay
	UCesiumRasterOverlay ()
void	AddToTileset ()
	Displays this raster overlay on its owning Cesium 3D Tileset Actor, without changing its activation state.
void	RemoveFromTileset ()
	Stops displaying this raster overlay on its owning Cesium 3D Tileset Actor.
void	Refresh ()
	Refreshes this overlay by removing from its owning Cesium 3D Tileset Actor and re-adding it.
double	GetMaximumScreenSpaceError () const
void	SetMaximumScreenSpaceError (double Value)
int32	GetMaximumTextureSize () const
void	SetMaximumTextureSize (int32 Value)
int32	GetMaximumSimultaneousTileLoads () const
void	SetMaximumSimultaneousTileLoads (int32 Value)
int64	GetSubTileCacheBytes () const
void	SetSubTileCacheBytes (int64 Value)
virtual void	Activate (bool bReset) override
	Activates this raster overlay, which will display it on the Cesium3DTileset to which the component is attached, if it isn't already displayed.
virtual void	Deactivate () override
	Deactivates this raster overlay.
virtual void	OnComponentDestroyed (bool bDestroyingHierarchy) override
virtual bool	IsReadyForFinishDestroy () override

Public Attributes
TArray< TSoftObjectPtr< ACesiumCartographicPolygon > >	Polygons
	The polygons to rasterize for this overlay.
bool	InvertSelection = false
	Whether to invert the selection specified by the polygons.
bool	ExcludeSelectedTiles = true
	Whether tiles that fall entirely within the rasterized selection should be excluded from loading and rendering.
Public Attributes inherited from UCesiumRasterOverlay
FString	MaterialLayerKey = "Overlay0"
	The key to use to match this overlay to a material layer.
FRasterOverlayRendererOptions	rendererOptions
	Sets the texture filter and texture group of raster tile images.

Protected Member Functions
virtual std::unique_ptr< CesiumRasterOverlays::RasterOverlay >	CreateOverlay (const CesiumRasterOverlays::RasterOverlayOptions &options={}) override
virtual void	OnAdd (Cesium3DTilesSelection::Tileset *pTileset, CesiumRasterOverlays::RasterOverlay *pOverlay) override
virtual void	OnRemove (Cesium3DTilesSelection::Tileset *pTileset, CesiumRasterOverlays::RasterOverlay *pOverlay) override
Protected Member Functions inherited from UCesiumRasterOverlay
Cesium3DTilesSelection::Tileset *	FindTileset () const

Additional Inherited Members
Protected Attributes inherited from UCesiumRasterOverlay
double	MaximumScreenSpaceError = 2.0
	The maximum number of pixels of error when rendering this overlay.
int32	MaximumTextureSize = 2048
	The maximum texel size of raster overlay textures, in either direction.
int32	MaximumSimultaneousTileLoads = 20
	The maximum number of overlay tiles that may simultaneously be in the process of loading.
int64	SubTileCacheBytes = 16 * 1024 * 1024
	The maximum number of bytes to use to cache sub-tiles in memory.
bool	ShowCreditsOnScreen
	Whether or not to show credits of this raster overlay on screen.

Detailed Description

A raster overlay that rasterizes polygons and drapes them over the tileset.

This is useful for clipping out parts of a tileset, for adding a water effect in an area, and for many other purposes.

Definition at line 21 of file CesiumPolygonRasterOverlay.h.

Constructor & Destructor Documentation

UCesiumPolygonRasterOverlay()

UCesiumPolygonRasterOverlay::UCesiumPolygonRasterOverlay

(

)

Member Function Documentation

CreateOverlay()

virtual std::unique_ptr< CesiumRasterOverlays::RasterOverlay > UCesiumPolygonRasterOverlay::CreateOverlay ( const CesiumRasterOverlays::RasterOverlayOptions & options = {} )

overrideprotectedvirtual

Reimplemented from UCesiumRasterOverlay.

OnAdd()

virtual void UCesiumPolygonRasterOverlay::OnAdd ( Cesium3DTilesSelection::Tileset * pTileset, CesiumRasterOverlays::RasterOverlay * pOverlay )

overrideprotectedvirtual

Reimplemented from UCesiumRasterOverlay.

OnRemove()

virtual void UCesiumPolygonRasterOverlay::OnRemove ( Cesium3DTilesSelection::Tileset * pTileset, CesiumRasterOverlays::RasterOverlay * pOverlay )

overrideprotectedvirtual

Reimplemented from UCesiumRasterOverlay.

Member Data Documentation

ExcludeSelectedTiles

bool UCesiumPolygonRasterOverlay::ExcludeSelectedTiles = true

Whether tiles that fall entirely within the rasterized selection should be excluded from loading and rendering.

For better performance, this should be enabled when this overlay will be used for clipping. But when this overlay is used for other effects, this option should be disabled to avoid missing tiles.

Note that if InvertSelection is true, this will cull tiles that are outside of all the polygons. If it is false, this will cull tiles that are completely inside at least one polygon.

Definition at line 55 of file CesiumPolygonRasterOverlay.h.

InvertSelection

bool UCesiumPolygonRasterOverlay::InvertSelection = false

Whether to invert the selection specified by the polygons.

If this is true, only the areas outside of all the polygons will be rasterized.

Definition at line 41 of file CesiumPolygonRasterOverlay.h.

Polygons

TArray<TSoftObjectPtr<ACesiumCartographicPolygon> > UCesiumPolygonRasterOverlay::Polygons

The polygons to rasterize for this overlay.

Definition at line 32 of file CesiumPolygonRasterOverlay.h.

---

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

• Source/CesiumRuntime/Public/CesiumPolygonRasterOverlay.h