com.luciad.view.lightspeed.painter.grid.cgrs

Defense SymbologyClass TLspCGRSGridLayerBuilder

java.lang.Object

com.luciad.view.lightspeed.layer.ALspLayerBuilder

com.luciad.view.lightspeed.painter.grid.cgrs.TLspCGRSGridLayerBuilder

public class TLspCGRSGridLayerBuilder
extends ALspLayerBuilder

Builder for creating ILspLayer instances that visualize Common Grid Reference System (CGRS) grid data. The bounds used for the CGRS grid are defined by the model, which can be set by calling the model builder method. The styling of the CGRS grid and its labels can be done by creating a TLspCGRSGridStyle and passing it to the style builder method.

An example of how to use this builder:

    TLspCGRSGridStyle gridStyle = TLspCGRSGridStyle.newBuilder().defaultCGRSGridStyle().build();
    ILcdModel model = TLspCGRSGridLayerBuilder.createModel("CGRS Grid", TLcdEllipsoid.DEFAULT, new TLcdLonLatBounds(0, 40, 15, 15));
    ILspLayer layer = TLspCGRSGridLayerBuilder.newBuilder()
                                              .model(model)
                                              .label("CGRS Grid")
                                              .style(gridStyle)
                                              .build();

Since:

2021.1

Method Summary

Modifier and Type	Method and Description
ILspStyledLayer	build() Creates a new layer instance.
static ILcdModel	createModel(String aModelName, ILcdEllipsoid aEllipsoid, ILcdBounds aBounds) Creates a model that can be used by this builder.
TLspCGRSGridLayerBuilder	label(String aLabel) Sets the label of the layer.
TLspCGRSGridLayerBuilder	layerStyle(TLspLayerStyle aLayerStyle) Set a layer style to be used during the rendering of the layer.
TLspCGRSGridLayerBuilder	layerType(ILspLayer.LayerType aLayerType) This method is not supported for CGRS grid layers
TLspCGRSGridLayerBuilder	model(ILcdModel aModel) Sets the model of the layer.
static TLspCGRSGridLayerBuilder	newBuilder() Returns a new CGRS grid layer builder
TLspCGRSGridLayerBuilder	overlayLabel(TLspCGRSGridOverlayLabelBuilder aOverlayLabelBuilder, Object aConstraint) Adds an overlay label to be used.
TLspCGRSGridLayerBuilder	style(TLspCGRSGridStyle aCGRSGridStyle) Sets the style to be used by this layer.

Methods inherited from class com.luciad.view.lightspeed.layer.ALspLayerBuilder

getIcon, getLabel, getLayerStyle, getLayerType, getModel, icon

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static TLspCGRSGridLayerBuilder newBuilder()

Returns a new CGRS grid layer builder

Returns:

a new CGRS grid layer builder

createModel

public static ILcdModel createModel(String aModelName,
                                    ILcdEllipsoid aEllipsoid,
                                    ILcdBounds aBounds)

Creates a model that can be used by this builder. When no model is set on the builder, a default model is used instead. When using this method, it is possible to customize the used ellipsoid and the model name. The model name is used as a default display name for the layer created by this builder.

Parameters:

aModelName - The desired model name

aBounds - The bounds of the CGRS grid

aEllipsoid - The ellipsoid on which the CGRS grid is defined.

Returns:

A model that can be used in this builder.

model

public TLspCGRSGridLayerBuilder model(ILcdModel aModel)

Sets the model of the layer. This model should be created using the createModel method of this class. If not, an IllegalArgumentException is thrown.

Calling this method is optional. If not called, a default model is used.

Overrides:

model in class ALspLayerBuilder

Parameters:

aModel - a model

Returns:

this builder

Throws:

IllegalArgumentException - if the given model is not created using the createModel method.

See Also:

ILcdLayer.getModel()

label

public TLspCGRSGridLayerBuilder 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 ""CGRS Grid"".

Overrides:

label in class ALspLayerBuilder

Parameters:

aLabel - the label

Returns:

this builder

See Also:

ILcdLayer.getLabel()

layerType

public TLspCGRSGridLayerBuilder layerType(ILspLayer.LayerType aLayerType)

This method is not supported for CGRS grid layers

Overrides:

layerType in class ALspLayerBuilder

Parameters:

aLayerType - the layer type

Returns:

this builder

Throws:

UnsupportedOperationException - this method is not supported for CGRS grid layers

See Also:

ILspLayer.getLayerType()

layerStyle

public TLspCGRSGridLayerBuilder layerStyle(TLspLayerStyle aLayerStyle)

Description copied from class: ALspLayerBuilder

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).

Overrides:

layerStyle in class ALspLayerBuilder

Parameters:

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

Returns:

this

See Also:

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

style

public TLspCGRSGridLayerBuilder style(TLspCGRSGridStyle aCGRSGridStyle)

Sets the style to be used by this layer.

Parameters:

aCGRSGridStyle - the CGRS grid style to use.

Returns:

this builder.

overlayLabel

public TLspCGRSGridLayerBuilder overlayLabel(TLspCGRSGridOverlayLabelBuilder aOverlayLabelBuilder,
                                             Object aConstraint)

Adds an overlay label to be used. When the layer (built using this builder) is added to the view, this overlay label builder is used to add an overlay component to a view. The overlay component is also removed when the layer is removed from a view.

Parameters:

aOverlayLabelBuilder - the overlay label builder used to create an overlay component. It is not needed to call the TLspCGRSGridOverlayLabelBuilder.view() method before calling this method.

aConstraint - an object expressing layout constraints for this component, usually one of these location constants.

Returns:

this builder.

build

public ILspStyledLayer build()

Creates a new layer instance.

This builder returns an ILspStyledLayer that contains ILspCustomizableStyler instances.

Specified by:

build in class ALspLayerBuilder

Returns:

the new layer instance