com.luciad.view.lightspeed.layer.plots

LuciadLightspeedClass TLspPlotLayerBuilder

java.lang.Object

com.luciad.view.lightspeed.layer.ALspLayerBuilder

com.luciad.view.lightspeed.layer.plots.TLspPlotLayerBuilder

Direct Known Subclasses:

TLspPlotLayerBuilder

public class TLspPlotLayerBuilder
extends ALspLayerBuilder

This builder is used to create a layer optimized for displaying large static datasets with points.

You can configure the following aspects using this builder:

• model: see here for restrictions
• plot styles
• label styles
• mandatory attributes and orientation
• scale range

See newBuilder() for default values.

To customize the styling, you need to use a TLspPlotStyle, or a styler that submits TLspPlotStyles.

Example:

   ILspLayer layer = TLspPLotLayerBuilder.newBuilder()
                                         .model(myModel)
                                         .label("Plots")
                                         .bodyStyles(REGULAR,
                                                     TLspPlotStyle.newBuilder()....build()
                                         .build()
 

Since:

2014.0

See Also:

TLspPlotStyle, TLcdExpressionFactory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TLspPlotLayerBuilder() Do not subclass TLspPlotLayerBuilder.

Method Summary

Modifier and Type	Method and Description
TLspPlotLayerBuilder	bodyMapScaleRange(TLcdDimensionInterval<TLcdMapScale> aBodyScaleRange) Sets the scale range for the body of the layer in unitless map scale ratios.
TLspPlotLayerBuilder	bodyScaleRange(ILcdInterval aScaleRange) Sets a scale range within which the objects are displayed.
TLspPlotLayerBuilder	bodyStyler(TLspPaintState aPaintState, ILspStyler aStyler) Sets the styler used for the points in the BODY paint representation.
TLspPlotLayerBuilder	bodyStyles(TLspPaintState aPaintState, TLspPlotStyle... aStyles) Sets a (fixed) set of styles to use in this layer for the BODY paint representation.
ILspEditableStyledLayer	build() Creates a new plot layer using the settings specified on this builder.
TLspPlotLayerBuilder	icon(ILcdIcon aIcon) Sets the icon of the layer.
TLspPlotLayerBuilder	label(String aLabel) Sets the label of the layer.
TLspPlotLayerBuilder	labelEditable(boolean aEditable) Sets whether the labels of the layer should be editable.
TLspPlotLayerBuilder	labelEditor(ILspEditor aEditor) Sets a custom label editor for the layer, alternatively you can use labelEditable(boolean) to enable a default label editor.
TLspPlotLayerBuilder	labelMapScaleRange(TLcdDimensionInterval<TLcdMapScale> aLabelScaleRange) Sets the scale range for the labels of the layer in unitless map scale ratios.
TLspPlotLayerBuilder	labelScaleRange(ILcdInterval aScaleRange) Sets a scale range within which the objects' labels are displayed.
TLspPlotLayerBuilder	labelStyler(TLspPaintState aPaintState, ILspStyler aLabelStyler) Sets the given label styler for the given paint state.
TLspPlotLayerBuilder	labelStyles(TLspPaintState aPaintState, ALspStyle... aLabelStyles) Sets the given label styles for the given paint state.
TLspPlotLayerBuilder	layerStyle(TLspLayerStyle aLayerStyle) Set a layer style to be used during the rendering of the layer.
TLspPlotLayerBuilder	layerType(ILspLayer.LayerType aLayerType) The layer type of plot layers cannot be set. Sets the layer type of the layer.
TLspPlotLayerBuilder	mandatoryAttributes(ILcdExpression... aMandatoryAttributes) Set a list of attributes that should always be loaded, regardless of what is necessary for styling and filtering.
TLspPlotLayerBuilder	mandatoryOrientation(boolean aOrientationMandatory) Indicates that orientation information should always be loaded, regardless of styling and filtering.
TLspPlotLayerBuilder	model(ILcdModel aModel) Sets the model of the layer.
static TLspPlotLayerBuilder	newBuilder() Creates a new builder.
TLspPlotLayerBuilder	paintingHints(TLspPlotPaintingHints aPaintingHints) Sets the painting hints to be used by created layers.
TLspPlotLayerBuilder	selectable(boolean aSelectable) Specifies whether layers should be selectable.

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

getIcon, getLabel, getLayerStyle, getLayerType, getModel

Methods inherited from class java.lang.Object

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

Constructor Detail

TLspPlotLayerBuilder

protected TLspPlotLayerBuilder()

Do not subclass TLspPlotLayerBuilder. Attempting to do so will throw IllegalStateExceptions.

Since:

2014.0

Method Detail

newBuilder

public static TLspPlotLayerBuilder newBuilder()

Creates a new builder.

You must set a model on it using model(com.luciad.model.ILcdModel).

Default values:

• attributes: not set (no mandatory attributes)
• style(r): default TLspPlotStyle
• scale range: not set (always visible)

Returns:

A builder

layerType

public TLspPlotLayerBuilder layerType(ILspLayer.LayerType aLayerType)

The layer type of plot layers cannot be set. Sets the layer type of the layer.

The default value is ILspLayer.LayerType.EDITABLE.

Overrides:

layerType in class ALspLayerBuilder

Parameters:

aLayerType - the layer type

Returns:

this builder

See Also:

ILspLayer.getLayerType()

model

public TLspPlotLayerBuilder model(ILcdModel aModel)

Sets the model of the layer.

The default value is null.

• Models that are ILcd2DBoundsIndexedModel are dynamically/partially loaded and unloaded depending on cache size and visible area.
• Other models are processed entirely. The domain objects must be ILcdBounded.

Overrides:

model in class ALspLayerBuilder

Parameters:

aModel - a model

Returns:

this builder

See Also:

ILcdLayer.getModel()

label

public TLspPlotLayerBuilder 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.

Overrides:

label in class ALspLayerBuilder

Parameters:

aLabel - the label

Returns:

this builder

See Also:

ILcdLayer.getLabel()

icon

public TLspPlotLayerBuilder icon(ILcdIcon aIcon)

Sets the icon of the layer.

The default value is null.

Overrides:

icon in class ALspLayerBuilder

Parameters:

aIcon - the icon

Returns:

this builder

See Also:

ILcdLayer.getIcon()

mandatoryAttributes

public TLspPlotLayerBuilder mandatoryAttributes(ILcdExpression... aMandatoryAttributes)

Set a list of attributes that should always be loaded, regardless of what is necessary for styling and filtering.

This call is optional. The layer will automatically determine the necessary attributes based on the expressions inside TLspPlotStyle.

However, if at runtime a new style is set with other attributes, the layer will have to process the new attributes. To avoid this processing, you can set the super-set of all attributes you may need up front.

Parameters:

aMandatoryAttributes - The set of mandatory attributes

Returns:

this

See Also:

mandatoryOrientation(boolean)

mandatoryOrientation

public TLspPlotLayerBuilder mandatoryOrientation(boolean aOrientationMandatory)

Indicates that orientation information should always be loaded, regardless of styling and filtering.

This call is optional. The layer will automatically determine if orientation is necessary based on the TLspPlotStyle.

However, if at runtime a new style is set with different orientation settings, the layer will have to process the data again. To avoid this processing, you can set the super-set of all attributes you may need up front.

Parameters:

aOrientationMandatory - Whether the orientation should always be loaded or not

Returns:

this

See Also:

mandatoryAttributes(com.luciad.util.expression.ILcdExpression...)

bodyStyles

public TLspPlotLayerBuilder bodyStyles(TLspPaintState aPaintState,
                                       TLspPlotStyle... aStyles)

Sets a (fixed) set of styles to use in this layer for the BODY paint representation.

This method delegates to bodyStyler(com.luciad.view.lightspeed.layer.TLspPaintState, com.luciad.view.lightspeed.style.styler.ILspStyler). Call bodyStyler(com.luciad.view.lightspeed.layer.TLspPaintState, com.luciad.view.lightspeed.style.styler.ILspStyler) with a custom styler if you need to change styles at runtime after creation.

If not set, a default TLspPlotStyle is used.

Parameters:

aPaintState - Paint state for this styler

aStyles - The styles to use

Returns:

this

See Also:

TLspPlotStyle

bodyStyler

public TLspPlotLayerBuilder bodyStyler(TLspPaintState aPaintState,
                                       ILspStyler aStyler)

Sets the styler used for the points in the BODY paint representation.

Special considerations:

• It must submit TLspPlotStyle.
• It must submit the whole, original collection of domain objects. You cannot split styles per object. Instead, you can use expressions to style objects based on rules.
• It is strongly advised (although not mandatory) to re-use the same style instance if it is unchanged.
• You can use a ALspStyleTargetProvider to extract the actual point geometry out of the domain object. It must return ILcdPoint objects (that optionally also implement ILcdOriented).

For example:

 public void style(Collection<?> aObjects, ALspStyleCollector aStyleCollector, TLspContext aContext) {
   aStyleCollector.objects(aObjects).geometry(fPointExtractor).style(fStyle).submit();
 }
 

If not set, a default TLspPlotStyle is used.

Parameters:

aPaintState - Paint state for this styler

aStyler - The styler to use

Returns:

this

See Also:

bodyStyles(com.luciad.view.lightspeed.layer.TLspPaintState, com.luciad.view.lightspeed.style.TLspPlotStyle...)

bodyScaleRange

public TLspPlotLayerBuilder bodyScaleRange(ILcdInterval aScaleRange)

Sets a scale range within which the objects are displayed. The layer will not paint anything if the view's current scale is outside the given range.

If not set, no scale range is used and the layer will always paint itself.

Note that to improve performance you can additionally use TLspPlotStyle.Builder.automaticScaling(double).

Parameters:

aScaleRange - The scale range

Returns:

this

bodyMapScaleRange

public TLspPlotLayerBuilder bodyMapScaleRange(TLcdDimensionInterval<TLcdMapScale> aBodyScaleRange)

Sets the scale range for the body of the layer in unitless map scale ratios. This property defines a range of scales in which the bodies of the layer are visible. By default, no scale range is used, meaning that all bodies are visible.

Note that to improve performance you can additionally use TLspPlotStyle.Builder.automaticScaling(double).

Parameters:

aBodyScaleRange - the scale range for the body of the layer

Returns:

this

Since:

2021.0

labelStyler

public TLspPlotLayerBuilder labelStyler(TLspPaintState aPaintState,
                                        ILspStyler aLabelStyler)

Sets the given label styler for the given paint state.

If you need control over other labeling aspects such as positioning or priorities, use an ALspLabelStyler.

The following styles are supported:

• TLspTextStyle to get text with a specific font, font color, size, halo etc.
• TLspIconStyle to get custom images.

ALspLabelTextProviderStyle to specify which text to use (default is toString()). See also TLspDataObjectLabelTextProviderStyle. TLspLabelBoxStyle to specify fill color or frames TLspLabelOpacityStyle to specify the opacity and modulation color. TLspPinLineStyle to draw pins for the labels.

Use either labelStyler(com.luciad.view.lightspeed.layer.TLspPaintState, com.luciad.view.lightspeed.style.styler.ILspStyler) or labelStyles(com.luciad.view.lightspeed.layer.TLspPaintState, com.luciad.view.lightspeed.style.ALspStyle...), not both.

Parameters:

aPaintState - the paint state for which to set the label styler

aLabelStyler - the new label styler for the layer

Returns:

this

labelStyles

public TLspPlotLayerBuilder labelStyles(TLspPaintState aPaintState,
                                        ALspStyle... aLabelStyles)

Sets the given label styles for the given paint state.

The following styles are supported:

• TLspTextStyle to get text with a specific font, font color, size, halo etc.
• TLspIconStyle to get custom images.

ALspLabelTextProviderStyle to specify which text to use (default is toString()). See also TLspDataObjectLabelTextProviderStyle. TLspLabelBoxStyle to specify fill color or frames TLspLabelOpacityStyle to specify the opacity and modulation color. TLspPinLineStyle to draw pins for the labels.

Use either labelStyler(com.luciad.view.lightspeed.layer.TLspPaintState, com.luciad.view.lightspeed.style.styler.ILspStyler) or labelStyles(com.luciad.view.lightspeed.layer.TLspPaintState, com.luciad.view.lightspeed.style.ALspStyle...), not both.