com.luciad.realtime.lightspeed.plots

Real-time EngineClass TLspPlotLayerBuilder

java.lang.Object

com.luciad.view.lightspeed.layer.ALspLayerBuilder

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

com.luciad.realtime.lightspeed.plots.TLspPlotLayerBuilder

Deprecated.

The plot painting functionality has been move to Lightspeed, please use TLspPlotLayerBuilder instead.

public class TLspPlotLayerBuilder
extends TLspPlotLayerBuilder

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.

Example:

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

Since:

2012.1

See Also:

TLspPlotStyle, TLcdExpressionFactory

Method Summary

Modifier and Type	Method and Description
TLspPlotLayerBuilder	bodyScaleRange(ILcdInterval aScaleRange) Deprecated. Sets a scale range within which the objects are displayed.
TLspPlotLayerBuilder	bodyStyler(TLspPaintState aPaintState, ILspStyler aStyler) Deprecated. Sets the styler used for the points in the BODY paint representation.
TLspPlotLayerBuilder	bodyStyles(TLspPaintState aPaintState, TLspPlotStyle... aStyles) Deprecated. Sets a (fixed) set of styles to use in this layer for the BODY paint representation.
TLspPlotLayerBuilder	icon(ILcdIcon aIcon) Deprecated. Sets the icon of the layer.
TLspPlotLayerBuilder	label(java.lang.String aLabel) Deprecated. Sets the label of the layer.
TLspPlotLayerBuilder	labelEditable(boolean aEditable) Deprecated. Sets whether the labels of the layer should be editable.
TLspPlotLayerBuilder	labelEditor(ILspEditor aEditor) Deprecated. Sets a custom label editor for the layer, alternatively you can use TLspPlotLayerBuilder.labelEditable(boolean) to enable a default label editor.
TLspPlotLayerBuilder	labelScaleRange(ILcdInterval aScaleRange) Deprecated. Sets a scale range within which the objects' labels are displayed.
TLspPlotLayerBuilder	labelStyler(TLspPaintState aPaintState, ILspStyler aLabelStyler) Deprecated. Sets the given label styler for the given paint state.
TLspPlotLayerBuilder	labelStyles(TLspPaintState aPaintState, ALspStyle... aLabelStyles) Deprecated. Sets the given label styles for the given paint state.
TLspPlotLayerBuilder	layerType(ILspLayer.LayerType aLayerType) Deprecated. The layer type of plot layers cannot be set. Sets the layer type of the layer.
TLspPlotLayerBuilder	mandatoryAttributes(ILcdExpression... aMandatoryAttributes) Deprecated. Set a list of attributes that should always be loaded, regardless of what is necessary for styling and filtering.
TLspPlotLayerBuilder	mandatoryOrientation(boolean aOrientationMandatory) Deprecated. Indicates that orientation information should always be loaded, regardless of styling and filtering.
TLspPlotLayerBuilder	model(ILcdModel aModel) Deprecated. Sets the model of the layer.
static TLspPlotLayerBuilder	newBuilder() Deprecated. Creates a new builder.
TLspPlotLayerBuilder	paintingHints(TLspPlotPaintingHints aPaintingHints) Deprecated.
TLspPlotLayerBuilder	selectable(boolean aSelectable) Deprecated. Specifies whether layers should be selectable.

Methods inherited from class com.luciad.view.lightspeed.layer.plots.TLspPlotLayerBuilder

build, layerStyle, paintingHints

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

Method Detail

layerType

public TLspPlotLayerBuilder layerType(ILspLayer.LayerType aLayerType)

Deprecated.

Description copied from class: TLspPlotLayerBuilder

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 TLspPlotLayerBuilder

Parameters:

aLayerType - the layer type

Returns:

this builder

See Also:

ILspLayer.getLayerType()

model

public TLspPlotLayerBuilder model(ILcdModel aModel)

Deprecated.

Description copied from class: TLspPlotLayerBuilder

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 TLspPlotLayerBuilder

Parameters:

aModel - a model

Returns:

this builder

See Also:

ILcdLayer.getModel()

label

public TLspPlotLayerBuilder label(java.lang.String aLabel)

Deprecated.

Description copied from class: TLspPlotLayerBuilder

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 TLspPlotLayerBuilder

Parameters:

aLabel - the label

Returns:

this builder

See Also:

ILcdLayer.getLabel()

icon

public TLspPlotLayerBuilder icon(ILcdIcon aIcon)

Deprecated.

Description copied from class: TLspPlotLayerBuilder

Sets the icon of the layer.

The default value is null.

Overrides:

icon in class TLspPlotLayerBuilder

Parameters:

aIcon - the icon

Returns:

this builder

See Also:

ILcdLayer.getIcon()

mandatoryAttributes

public TLspPlotLayerBuilder mandatoryAttributes(ILcdExpression... aMandatoryAttributes)

Deprecated.

Description copied from class: TLspPlotLayerBuilder

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.

Overrides:

mandatoryAttributes in class TLspPlotLayerBuilder

Parameters:

aMandatoryAttributes - The set of mandatory attributes

Returns:

this

See Also:

TLspPlotLayerBuilder.mandatoryOrientation(boolean)

mandatoryOrientation

public TLspPlotLayerBuilder mandatoryOrientation(boolean aOrientationMandatory)

Deprecated.

Description copied from class: TLspPlotLayerBuilder

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.

Overrides:

mandatoryOrientation in class TLspPlotLayerBuilder

Parameters:

aOrientationMandatory - Whether the orientation should always be loaded or not

Returns:

this

See Also:

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

bodyStyles

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

Deprecated.

Description copied from class: TLspPlotLayerBuilder

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

This method delegates to TLspPlotLayerBuilder.bodyStyler(com.luciad.view.lightspeed.layer.TLspPaintState, com.luciad.view.lightspeed.style.styler.ILspStyler). Call TLspPlotLayerBuilder.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.

Overrides:

bodyStyles in class TLspPlotLayerBuilder

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)

Deprecated.

Description copied from class: TLspPlotLayerBuilder

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.

Overrides:

bodyStyler in class TLspPlotLayerBuilder

Parameters:

aPaintState - Paint state for this styler

aStyler - The styler to use

Returns:

this

See Also:

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

bodyScaleRange

public TLspPlotLayerBuilder bodyScaleRange(ILcdInterval aScaleRange)

Deprecated.

Description copied from class: TLspPlotLayerBuilder

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

Overrides:

bodyScaleRange in class TLspPlotLayerBuilder

Parameters:

aScaleRange - The scale range

Returns:

this

labelStyler

public TLspPlotLayerBuilder labelStyler(TLspPaintState aPaintState,
                                        ILspStyler aLabelStyler)

Deprecated.

Description copied from class: TLspPlotLayerBuilder

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 TLspPlotLayerBuilder.labelStyler(com.luciad.view.lightspeed.layer.TLspPaintState, com.luciad.view.lightspeed.style.styler.ILspStyler) or TLspPlotLayerBuilder.labelStyles(com.luciad.view.lightspeed.layer.TLspPaintState, com.luciad.view.lightspeed.style.ALspStyle...), not both.

Overrides:

labelStyler in class TLspPlotLayerBuilder

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)

Deprecated.

Description copied from class: TLspPlotLayerBuilder

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 TLspPlotLayerBuilder.labelStyler(com.luciad.view.lightspeed.layer.TLspPaintState, com.luciad.view.lightspeed.style.styler.ILspStyler) or TLspPlotLayerBuilder.labelStyles(com.luciad.view.lightspeed.layer.TLspPaintState, com.luciad.view.lightspeed.style.ALspStyle...), not both.