CesiumForUnity.CesiumWebMapServiceRasterOverlay Class Reference

A raster overlay that directly accesses a Web Map Service (WMS) server. More...

Inheritance diagram for CesiumForUnity.CesiumWebMapServiceRasterOverlay:

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
string	baseUrl [get, set]
	The base URL of the Web Map Service (WMS).
string	layers [get, set]
	Comma-separated layer names to request from the server.
int	tileWidth [get, set]
	Image width.
int	tileHeight [get, set]
	Image height.
int	minimumLevel [get, set]
	The minimum zoom level.
int	maximumLevel [get, set]
	The maximum zoom level.
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 directly accesses a Web Map Service (WMS) server.

https://www.ogc.org/standards/wms

Definition at line 15 of file CesiumWebMapServiceRasterOverlay.cs.

Member Function Documentation

AddToTileset()

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

protected

RemoveFromTileset()

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

protected

Property Documentation

baseUrl

string CesiumForUnity.CesiumWebMapServiceRasterOverlay.baseUrl

getset

The base URL of the Web Map Service (WMS).

This URL should not include query parameters. For example: https://services.ga.gov.au/gis/services/NM_Culture_and_Infrastructure/MapServer/WMSServer

Definition at line 27 of file CesiumWebMapServiceRasterOverlay.cs.

layers

string CesiumForUnity.CesiumWebMapServiceRasterOverlay.layers

getset

Comma-separated layer names to request from the server.

Definition at line 43 of file CesiumWebMapServiceRasterOverlay.cs.

maximumLevel

int CesiumForUnity.CesiumWebMapServiceRasterOverlay.maximumLevel

getset

The maximum zoom level.

Definition at line 114 of file CesiumWebMapServiceRasterOverlay.cs.

minimumLevel

int CesiumForUnity.CesiumWebMapServiceRasterOverlay.minimumLevel

getset

The minimum zoom level.

Take care when specifying this that the number of tiles at the minimum level is small, such as four or less. A larger number is likely to result in rendering problems.

Definition at line 97 of file CesiumWebMapServiceRasterOverlay.cs.

tileHeight

int CesiumForUnity.CesiumWebMapServiceRasterOverlay.tileHeight

getset

Image height.

Definition at line 75 of file CesiumWebMapServiceRasterOverlay.cs.

tileWidth

int CesiumForUnity.CesiumWebMapServiceRasterOverlay.tileWidth

getset

Image width.

Definition at line 59 of file CesiumWebMapServiceRasterOverlay.cs.

---

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

• Runtime/CesiumWebMapServiceRasterOverlay.cs