Luciad.Maps.Map.Builder Class Reference

Builder to create a Map. More...

Inheritance diagram for Luciad.Maps.Map.Builder:

Public Member Functions
Luciad.Maps.Map.Builder	BackgroundColor (System.Drawing.Color color)
	Configures the background color of the map. More...
Luciad.Maps.Map	Build ()
	Builds the Map for the configured settings. More...
Luciad.Maps.Map.Builder	DisplayScale (double displayScale)
	Specifies the display scale to allow the renderer to scale the graphics on high DPI displays. More...
void	Dispose ()
Luciad.Maps.Map.Builder	Dpi (double dpi)
	Sets the DPI value that will be used to interpret map scales. More...
Luciad.Maps.Map.Builder	LayerList (Luciad.Layers.LayerList layerList)
	Sets an initial layer list to use. More...
Luciad.Maps.Map.Builder	Reference (Luciad.Geodesy.CoordinateReference reference)
	Sets the reference for this Map. More...

Detailed Description

Builder to create a Map.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::Map::Builder.

Member Function Documentation

BackgroundColor()

Luciad.Maps.Map.Builder Luciad.Maps.Map.Builder.BackgroundColor ( System.Drawing.Color  color )

inline

Configures the background color of the map.

This parameter is optional. Not specifying one will pick a default color. In 3D, the atmospheric effect has priority over the background color.

color

the color that is used to render the map background.

this

2020.1

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::Map::Builder::backgroundColor.

Build()

Luciad.Maps.Map Luciad.Maps.Map.Builder.Build ( )

inline

Builds the Map for the configured settings.

the built Map.

luciad::LogicException

when the map reference is not an allowed reference.

reference

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::Map::Builder::build.

DisplayScale()

Luciad.Maps.Map.Builder Luciad.Maps.Map.Builder.DisplayScale ( double  displayScale )

inline

Specifies the display scale to allow the renderer to scale the graphics on high DPI displays.

See Map::setDisplayScale for more information.

displayScale

the display scale. A value of 1.0 corresponds with a display scale of 100%.

this

2022.0

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::Map::Builder::displayScale.

Dispose()

void Luciad.Maps.Map.Builder.Dispose ( )

inline

Dpi()

Luciad.Maps.Map.Builder Luciad.Maps.Map.Builder.Dpi ( double  dpi )

inline

Sets the DPI value that will be used to interpret map scales.

See Map::setDpi for more information.

dpi

the dpi

this

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::Map::Builder::dpi.

LayerList()

Luciad.Maps.Map.Builder Luciad.Maps.Map.Builder.LayerList ( Luciad.Layers.LayerList  layerList )

inline

Sets an initial layer list to use.

Note: LayerList instances can be shared with an other Map, provided that both Map instances use the same paint thread. This parameter is optional. Not specifying one will create a new, empty, instance.

layerList

the initial layer list to use. Cannot be nullptr.

NullArgumentException

when the layer list is nullptr.

this

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::Map::Builder::layerList.

Reference()

Luciad.Maps.Map.Builder Luciad.Maps.Map.Builder.Reference ( Luciad.Geodesy.CoordinateReference  reference )

inline

Sets the reference for this Map.

This parameter is optional. The default is the reference with id EPSG:4978. Only projected and geocentric references are allowed.

reference

the reference of this Map, cannot be nullptr.

NullArgumentException

when the reference is nullptr.

this

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::Map::Builder::reference.