com.luciad.realtime.lightspeed.radarvideo

Real-time EngineClass TLspRadarVideoLayerBuilder

java.lang.Object

com.luciad.view.lightspeed.layer.ALspLayerBuilder

com.luciad.realtime.lightspeed.radarvideo.TLspRadarVideoLayerBuilder

public class TLspRadarVideoLayerBuilder
extends ALspLayerBuilder

Builds layers that visualize radar video feeds. Feeds are visualized in the typical fashion, using a rotating sweep line and afterglow effects on detected objects. The visualization can be customized using TLspRadarVideoStyle.

Additionally, the layers created by this builder support the same styling constructs as TLspShapeLayerBuilder. This allows the user to add decorations (e.g. grid lines) and labels to the radar feed.

The default styler shows the radar video data, a sweep line and a polar grid. This styler is a ILspCustomizableStyler, which means you can adjust the style of these elements after you have created this layer.

The identifiers of this ILspCustomizableStyler are:

• "radarVideo" for the TLspRadarVideoStyle for the radar content.
• "radarSweepLine" for the TLspLineStyle of the sweep line.
• "radarRangeRing" for the TLspLineStyle of the range rings.
• "radarGrid" for the TLspLineStyle of the polar grid lines.

You can use these identifiers if you want to change the style of one of these elements. For instance, changing the color of the sweep line:

 private ILspLayer createRadarLayer(ILcdModel aModel) {

   ILspEditableStyledLayer radarLayer = TLspRadarVideoLayerBuilder.newBuilder()
                                                                  .model(aRadarModel)
                                                                  .selectable(false)
                                                                  .label(aSimulatedRadarProperties.getName())
                                                                  .build();

   ILspCustomizableStyler styler = (ILspCustomizableStyler) radarLayer.getStyler(TLspPaintRepresentationState.REGULAR_BODY);

   for (TLspCustomizableStyle style : styler.getStyles()) {
     if (style.getIdentifier().equals(TLspRadarVideoLayerBuilder.SWEEP_LINE_STYLE_IDENTIFIER) {
       TLspLineStyle originalStyle = (TLspLineStyle) style.getStyle();
       style.setStyle(originalStyle.asBuilder().color(Color.BLUE).build());
     }
   }
 }
 

For deeper customization, you can replace the styler with your own implementation. For example if you want to change the number of range rings:

 public class RadarStyler extends ALspStyler {
   private static int RING_COUNT = 3;
   private static final ALspStyleTargetProvider sRangeRingStyleTargetProvider = new ALspStyleTargetProvider() {
     public void getStyleTargetsSFCT(Object aObject, TLspContext aContext, List<Object> aResultSFCT) {
       double range = (Double) ((ILcdDataObject) aObject).getValue(TLcdRadarVideoDataTypes.RADAR_RANGE_PROPERTY);

       //Range circles
       for (int i = 1; i <= RING_COUNT; i++) {
         TLcdXYCircle c = new TLcdXYCircle(0, 0, i * range / RING_COUNT);
         aResultSFCT.add(c);
       }
     }
   };

   private ALspStyle fRadarStyle = TLspRadarVideoStyle.newBuilder().build();
   private ALspStyle fRingStyle = TLspLineStyle.newBuilder().build();

   public void style(Collection<?> aObjects, ALspStyleCollector aStyleCollector, TLspContext aContext) {
     aStyleCollector
         .objects(aObjects)
          .styles(fRadarStyle)
          .submit();

     aStyleCollector
         .objects(aObjects)
         .geometry(sRangeRingStyleTargetProvider)
         .styles(fRingStyle)
         .submit();
   }
 }

 ILspLayer radarLayer = TLspRadarVideoLayerBuilder
     .newBuilder()
     .model(radarModel)
     .bodyStyler(TLspPaintState.REGULAR, new RadarStyler())
     .build();
 

Finally, this layer builder only accepts models whose modelDescriptor is an ILcdDataModelDescriptor whose element types contain a TLcdDataType that extends from TLcdRadarVideoDataTypes.RADAR_VIDEO_DATA_TYPE

Since:

2014.1

See Also:

TLcdRadar

Field Summary

Fields

Modifier and Type	Field and Description
static String	GRID_LINE_STYLE_IDENTIFIER Identifier for the TLspCustomizableStyle for the polar grid lines.
static String	RADAR_VIDEO_STYLE_IDENTIFIER Identifier for the TLspCustomizableStyle for the radar video.
static String	RANGE_RING_STYLE_IDENTIFIER Identifier for the TLspCustomizableStyle for the range rings.
static String	SWEEP_LINE_STYLE_IDENTIFIER Identifier for the TLspCustomizableStyle for the sweep line.

Method Summary

Modifier and Type	Method and Description
TLspRadarVideoLayerBuilder	bodyStyler(TLspPaintState aPaintState, ILspStyler aBodyStyler) Sets the body styler for the given paint state.
ILspEditableStyledLayer	build() Creates a new radar layer using the current settings of this builder.
TLspRadarVideoLayerBuilder	icon(ILcdIcon aIcon) Sets the icon of the layer.
TLspRadarVideoLayerBuilder	label(String aLabel) Sets the label of the layer.
TLspRadarVideoLayerBuilder	labelStyler(TLspPaintState aPaintState, ILspStyler aLabelStyler) Sets the label styler for the given paint state.
TLspRadarVideoLayerBuilder	layerStyle(TLspLayerStyle aLayerStyle) Set a layer style to be used during the rendering of the layer.
TLspRadarVideoLayerBuilder	layerType(ILspLayer.LayerType aLayerType) This method throws an UnsupportedOperationException.
TLspRadarVideoLayerBuilder	model(ILcdModel aModel) Sets the model of the layer.
static TLspRadarVideoLayerBuilder	newBuilder() Creates a new radar layer builder.
TLspRadarVideoLayerBuilder	selectable(boolean aSelectable) Specifies whether layers should be made selectable.
TLspRadarVideoLayerBuilder	selectableSupported(boolean aSelectableSupported) Sets whether the layer should support selection.
TLspRadarVideoLayerBuilder	synchronous(boolean aIsSynchronous) Specifies whether created layers should paint synchronously.

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

Field Detail

RADAR_VIDEO_STYLE_IDENTIFIER

public static final String RADAR_VIDEO_STYLE_IDENTIFIER

Identifier for the TLspCustomizableStyle for the radar video. The style contained in that TLspCustomizableStyle is a TLspRadarVideoStyle.

Since:

2018.0

See Also:

Constant Field Values

GRID_LINE_STYLE_IDENTIFIER

public static final String GRID_LINE_STYLE_IDENTIFIER

Identifier for the TLspCustomizableStyle for the polar grid lines. The style contained in that TLspCustomizableStyle is a TLspLineStyle.

Since:

2018.0

See Also:

Constant Field Values

RANGE_RING_STYLE_IDENTIFIER

public static final String RANGE_RING_STYLE_IDENTIFIER

Identifier for the TLspCustomizableStyle for the range rings. The style contained in that TLspCustomizableStyle is a TLspLineStyle.

Since:

2018.0

See Also:

Constant Field Values

SWEEP_LINE_STYLE_IDENTIFIER

public static final String SWEEP_LINE_STYLE_IDENTIFIER

Identifier for the TLspCustomizableStyle for the sweep line. The style contained in that TLspCustomizableStyle is a TLspLineStyle.

Since:

2018.0

See Also:

Constant Field Values

Method Detail

newBuilder

public static TLspRadarVideoLayerBuilder newBuilder()

Creates a new radar layer builder.

Returns:

a new radar layer builder

build

public ILspEditableStyledLayer build()

Creates a new radar layer using the current settings of this builder.

Specified by:

build in class ALspLayerBuilder

Returns:

a new radar layer

bodyStyler

public TLspRadarVideoLayerBuilder bodyStyler(TLspPaintState aPaintState,
                                             ILspStyler aBodyStyler)

Sets the body styler for the given paint state. The styler can produce TLspRadarVideoStyles to customize the appearance of the radar feed. Furthermore, the styler may output additional geometries (using a style target provider).e For these additional geometries, all styles supported by TLspShapeLayerBuilder are also supported. This allows the styler to add decorations such as grid lines on top of the radar feed.

Parameters:

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

aBodyStyler - the new body styler for the layer

Returns:

this

labelStyler

public TLspRadarVideoLayerBuilder labelStyler(TLspPaintState aPaintState,
                                              ILspStyler aLabelStyler)

Sets the label styler for the given paint state. See TLspShapeLayerBuilder for information on the supported styles.

Parameters:

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

aLabelStyler - the new label styler for the layer

Returns:

this

selectable

public TLspRadarVideoLayerBuilder selectable(boolean aSelectable)

Specifies whether layers should be made selectable. Set to true by default.

Parameters:

aSelectable - whether or not created layers should be selectable

Returns:

this

selectableSupported

public TLspRadarVideoLayerBuilder selectableSupported(boolean aSelectableSupported)

Sets whether the layer should support selection. By default, layers support selection.

Parameters:

aSelectableSupported - whether the layer should support selection

Returns:

this

synchronous

public TLspRadarVideoLayerBuilder synchronous(boolean aIsSynchronous)

Specifies whether created layers should paint synchronously. The default is false and allows layers to perform shape discretization and other expensive processing using the view's ILspTaskExecutor. When synchronous mode is on, all such tasks are performed on the EDT.

It is strongly recommended to leave this setting off, to ensure that the application remains responsive. Applications that need to change the view's world reference on a regular basis, however, may want to consider synchronous mode to avoid flickering.

Parameters:

aIsSynchronous - true if the layer should paint synchronously

Returns:

this

model

public TLspRadarVideoLayerBuilder model(ILcdModel aModel)

Description copied from class: ALspLayerBuilder

Sets the model of the layer.

The default value is null.

Overrides:

model in class ALspLayerBuilder

Parameters:

aModel - a model

Returns:

this builder

See Also:

ILcdLayer.getModel()

label

public TLspRadarVideoLayerBuilder label(String aLabel)

Description copied from class: ALspLayerBuilder

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 TLspRadarVideoLayerBuilder icon(ILcdIcon aIcon)

Description copied from class: ALspLayerBuilder

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

layerStyle

public TLspRadarVideoLayerBuilder 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)

layerType

public TLspRadarVideoLayerBuilder layerType(ILspLayer.LayerType aLayerType)

This method throws an UnsupportedOperationException. The layer type of radar layers is always ILspLayer.LayerType.REALTIME.

Overrides:

layerType in class ALspLayerBuilder

Parameters:

aLayerType - the layer type

Returns:

this

See Also:

ILspLayer.getLayerType()