CesiumForUnity.CesiumPolygonRasterOverlay Class Reference

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

Inheritance diagram for CesiumForUnity.CesiumPolygonRasterOverlay:

Protected Member Functions
override partial void	AddToTileset (Cesium3DTileset tileset)
override partial void	RemoveFromTileset (Cesium3DTileset tileset)
Protected Member Functions inherited from CesiumForUnity.CesiumRasterOverlay
void	AddToTileset (Cesium3DTileset tileset)
	When implemented in a derived class, adds the raster overlay to the given tileset.
void	RemoveFromTileset (Cesium3DTileset tileset)
	When implemented in a derived class, removes the raster overlay from the given tileset.

Properties
List< CesiumCartographicPolygon >	polygons [get, set]
	The polygons to rasterize for this overlay.
bool	invertSelection [get, set]
	Whether to invert the selection specified by the polygons.
bool	excludeSelectedTiles [get, set]
	Whether tiles that fall entirely within the rasterized selection should be excluded from loading and rendering.
Properties inherited from CesiumForUnity.CesiumRasterOverlay
string	materialKey [get, set]
	The key to use to match this overlay to the corresponding parameters in the tileset's material.
bool	showCreditsOnScreen [get, set]
	Whether or not to force this raster overlay's credits to be shown on the main screen.
float	maximumScreenSpaceError [get, set]
	The maximum number of pixels of error when rendering this overlay.
int	maximumTextureSize [get, set]
	The maximum texel size of raster overlay textures, in either direction.
int	maximumSimultaneousTileLoads [get, set]
	The maximum number of overlay tiles that may simultaneously be in the process of loading.
long	subTileCacheBytes [get, set]
	The maximum number of bytes to use to cache sub-tiles in memory.

Additional Inherited Members
Public Member Functions inherited from CesiumForUnity.CesiumRasterOverlay
delegate void	RasterOverlayLoadFailureDelegate (CesiumRasterOverlayLoadFailureDetails details)
	Encapsulates a method that receives details of a raster overlay load failure.
void	AddToTileset ()
	Adds this raster overlay to the Cesium3DTileset on the same game object.
void	RemoveFromTileset ()
	Removes this raster overlay from the Cesium3DTileset on the same game object.
void	Refresh ()
	Refreshes this overlay by calling RemoveFromTileset followed by AddToTileset.
Static Package Functions inherited from CesiumForUnity.CesiumRasterOverlay
Events inherited from CesiumForUnity.CesiumRasterOverlay
static RasterOverlayLoadFailureDelegate	OnCesiumRasterOverlayLoadFailure
	An event that is raised when the raster overlay encounters an error that prevents it from loading.

Detailed Description

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

This is useful for clipping out parts of a tileset or applying specific material effects in an area.

Polygon raster overlays will only work in Unity 2022.2 or later.

Definition at line 23 of file CesiumPolygonRasterOverlay.cs.

Member Function Documentation

AddToTileset()

override partial void CesiumForUnity.CesiumPolygonRasterOverlay.AddToTileset ( Cesium3DTileset tileset )

protected

RemoveFromTileset()

override partial void CesiumForUnity.CesiumPolygonRasterOverlay.RemoveFromTileset ( Cesium3DTileset tileset )

protected

Property Documentation

excludeSelectedTiles

bool CesiumForUnity.CesiumPolygonRasterOverlay.excludeSelectedTiles

getset

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 87 of file CesiumPolygonRasterOverlay.cs.

invertSelection

bool CesiumForUnity.CesiumPolygonRasterOverlay.invertSelection

getset

Whether to invert the selection specified by the polygons.

When this setting is false, the areas inside the polygons are rasterized and therefore hidden from the rest of the tileset. In other words, they appear to cut holes in the tileset.

When this setting is true, the areas outside of all the polygons will be rasterized instead. This will hide everything except for the areas inside the polygons.

Definition at line 58 of file CesiumPolygonRasterOverlay.cs.

polygons

List<CesiumCartographicPolygon> CesiumForUnity.CesiumPolygonRasterOverlay.polygons

getset

The polygons to rasterize for this overlay.

Definition at line 31 of file CesiumPolygonRasterOverlay.cs.

---

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

• Runtime/CesiumPolygonRasterOverlay.cs