com.luciad.wms.client.model

LuciadLightspeedClass TLcdWMSGetMapContext

java.lang.Object

com.luciad.wms.client.model.TLcdWMSGetMapContext

public final class TLcdWMSGetMapContext
extends Object

A context object that is used to specify WMS GetMap settings. This object can be passed to the ALcdWMSProxy.createImageInputStream(TLcdWMSGetMapContext) method.

Lower level API is available as well, see TLcdWMSGetMapRequest. In most cases, this low level API should not be needed.

Since:

2016.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TLcdWMSGetMapContext.Builder Builder class for TLcdWMSGetMapContext objects.

Method Summary

Modifier and Type	Method and Description
TLcdWMSGetMapContext.Builder	asBuilder() Returns this object as a Builder.
Color	getBackgroundColor() Returns the background color to use for the map.
int	getImageHeight() Returns the height of the returned image by the GetMap request.
int	getImageWidth() Returns the width of the returned image by the GetMap request.
ILcdBounds	getMapBounds() Returns the area of interest, specified in the map reference.
ILcdXYWorldReference	getMapReference() Returns the reference in which the map content should be returned.
Double	getMapRotation() Returns the map rotation to be applied by the WMS server.
static TLcdWMSGetMapContext.Builder	newBuilder() Returns a new builder for a GetMap Context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getImageWidth

public int getImageWidth()

Returns the width of the returned image by the GetMap request.

Returns:

the width of the returned image by the GetMap request.

getImageHeight

public int getImageHeight()

Returns the height of the returned image by the GetMap request.

Returns:

the height of the returned image by the GetMap request.

getMapReference

public ILcdXYWorldReference getMapReference()

Returns the reference in which the map content should be returned.

Returns:

the reference in which the map content should be returned.

getMapBounds

public ILcdBounds getMapBounds()

Returns the area of interest, specified in the map reference.

Returns:

the area of interest, specified in the map reference.

getMapRotation

public Double getMapRotation()

Returns the map rotation to be applied by the WMS server. A null value indicates that the rotation is handled by the WMS client, after the map is retrieved from the WMS server.

Returns:

the rotation to be applied by the WMS server.

Since:

2022.0

getBackgroundColor

public Color getBackgroundColor()

Returns the background color to use for the map.

Returns:

the background color to use for the map.

newBuilder

public static TLcdWMSGetMapContext.Builder newBuilder()

Returns a new builder for a GetMap Context.

Returns:

a new builder

asBuilder

public TLcdWMSGetMapContext.Builder asBuilder()

Returns this object as a Builder.

Returns:

this object as a Builder.