com.luciad.view.lightspeed.layer

LuciadLightspeedClass ALspLayerBuilder

java.lang.Object

com.luciad.view.lightspeed.layer.ALspLayerBuilder

Direct Known Subclasses:

TLsp3DTileLayerBuilder, TLspAIXMLayerBuilder, TLspAPP6ALayerBuilder, TLspARINCLayerBuilder, TLspBUFRLayerBuilder, TLspCGRSGridLayerBuilder, TLspDAFIFLayerBuilder, TLspDensityLayerBuilder , TLspFusionVectorLayerBuilder , TLspGARSGridLayerBuilder, TLspGeorefGridLayerBuilder, TLspGRIBLayerBuilder , TLspHypsometricShadingLayerBuilder, TLspImageProjectionLayerBuilder, TLspKML22LayerBuilder, TLspLIDARLayerBuilder, TLspLonLatGridLayerBuilder, TLspMGRSGridLayerBuilder, TLspMilitarySymbologyLayerBuilder, TLspMS2525bLayerBuilder, TLspNetCDFLayerBuilder, TLspNVGLayerBuilder, TLspPlotLayerBuilder, TLspRadarVideoLayerBuilder, TLspRasterLayerBuilder, TLspS52LayerBuilder, TLspShapeLayerBuilder, TLspVPFLayerBuilder, TLspWMSLayerBuilder, TLspXYGridLayerBuilder

public abstract class ALspLayerBuilder
extends Object

Base class for various layer builders. Layer builders are provided in LuciadLightspeed as the recommended mechanism for instantiating various ILspLayer implementations.

Since:

2012.0

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ALspLayerBuilder() Creates a layer builder, with the layer type set to ILspLayer.LayerType.EDITABLE.

Method Summary

Modifier and Type	Method and Description
abstract ILspLayer	build() Creates a new layer instance.
protected ILcdIcon	getIcon() Returns the icon that is currently set.
protected String	getLabel() Returns the label that is currently set.
protected TLspLayerStyle	getLayerStyle() Returns the layer style that is currently set.
protected ILspLayer.LayerType	getLayerType() Returns the layer type that is currently set.
protected ILcdModel	getModel() Returns the model that is currently set.
ALspLayerBuilder	icon(ILcdIcon aIcon) Sets the icon of the layer.
ALspLayerBuilder	label(String aLabel) Sets the label of the layer.
ALspLayerBuilder	layerStyle(TLspLayerStyle aLayerStyle) Set a layer style to be used during the rendering of the layer.
ALspLayerBuilder	layerType(ILspLayer.LayerType aLayerType) Sets the layer type of the layer.
ALspLayerBuilder	model(ILcdModel aModel) Sets the model of the layer.

Methods inherited from class java.lang.Object

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

Constructor Detail

ALspLayerBuilder

protected ALspLayerBuilder()

Creates a layer builder, with the layer type set to ILspLayer.LayerType.EDITABLE.

Method Detail

build

public abstract ILspLayer build()

Creates a new layer instance.

Returns:

the new layer instance

model

public ALspLayerBuilder model(ILcdModel aModel)

Sets the model of the layer.

The default value is null.

Parameters:

aModel - a model

Returns:

this builder

See Also:

ILcdLayer.getModel()

label

public ALspLayerBuilder label(String aLabel)

Sets the label of the layer. This is a short textual representation for it, often used to represent the layer to end-users.

The default value is null.

Parameters:

aLabel - the label

Returns:

this builder

See Also:

ILcdLayer.getLabel()

icon

public ALspLayerBuilder icon(ILcdIcon aIcon)

Sets the icon of the layer.

The default value is null.

Parameters:

aIcon - the icon

Returns:

this builder

See Also:

ILcdLayer.getIcon()

layerType

public ALspLayerBuilder layerType(ILspLayer.LayerType aLayerType)

Sets the layer type of the layer.

The default value is ILspLayer.LayerType.EDITABLE.

Parameters:

aLayerType - the layer type

Returns:

this builder

See Also:

ILspLayer.getLayerType()

layerStyle

public ALspLayerBuilder layerStyle(TLspLayerStyle aLayerStyle)

Set a layer style to be used during the rendering of the layer. TLspLayerStyle is used to style the layer as a whole. Layer style can for example modify the transparency of a layer. Also, layer style can be modified after building the layer by calling ILspLayer.setLayerStyle(TLspLayerStyle).

Parameters:

aLayerStyle - the layer style. Must not be null. If you want to set the default layer style, set TLspLayerStyle.newBuilder().build()

Returns:

this

Since:

2017.0

See Also:

ILspLayer.getLayerStyle(), ILspLayer.setLayerStyle(TLspLayerStyle)

getModel

protected final ILcdModel getModel()

Returns the model that is currently set.

Returns:

the model that is currently set

getLabel

protected final String getLabel()

Returns the label that is currently set.

Returns:

the label that is currently set

getIcon

protected final ILcdIcon getIcon()

Returns the icon that is currently set.

Returns:

the icon that is currently set

getLayerType

protected final ILspLayer.LayerType getLayerType()

Returns the layer type that is currently set.

Returns:

the layer type that is currently set

getLayerStyle

protected final TLspLayerStyle getLayerStyle()

Returns the layer style that is currently set.

Returns:

the layer style that is currently set or null if there is no layer style set.

Since:

2017.0