TLspLIDARLayerBuilder (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.view.lightspeed.layer.ALspLayerBuilder
- - com.luciad.lidar.lightspeed.TLspLIDARLayerBuilder

```
public class TLspLIDARLayerBuilder
extends ALspLayerBuilder
```
This builder is used to create a layer optimized for displaying large point clouds. Typically these point clouds are generated by LIDAR systems.
You can configure the following aspects using this builder:
- model: mandatory
- plot styles
- scale range
- mandatory attributes
This builder is similar to TLspPlotLayerBuilder, but with some other defaults:
- Default styling:
  - Color: if the data type associated with the model has a property of type Color.
  - Height: otherwise, a color gradient is applied over the height range of the whole model.
- Optimized painting performance: point size and visibility is automatically adapted based on the camera settings.
However, you can completely customize the styling and filtering by creating the default style and adapting it. See example below.

See newBuilder() for more default values.

Example with default styling:
```
   ILspLayer layer = TLspLIDARLayerBuilder.newBuilder()
                                          .model(myModel)
                                          .build()
 
```
Example with custom styling:
```
   TLspPlotStyle defaultStyle = getDefaultStyle(myModel);
   ILcdExpression<Color> myColorExpression = ...
   TLspPlotStyle myStyle = defaultStyle.asBuilder()
                                       .color(ifThenElse(myColorAvailable, myColorExpression, defaultStyle.getColor()));
                                       .build();
   ILspLayer layer = TLspLIDARLayerBuilder.newBuilder()
                                          .model(myModel)
                                          .bodyStyler(REGULAR, myStyle)
                                          .build()
 
```
Performance:
Since Lidar data typically consists of many millions of points, it can take up a large amount of video memory. LuciadLightspeed has a limit on the amount of data in its cache. If this limit is too low, it can have a severe impact on performance. To increase this cache, use the following system property, with values in megabytes:
```
     -Dcom.luciad.view.lightspeed.opengl.cacheSize=768
   
```
As an alternative, it is possible to limit the amount of points in the model. This can for example be done by using the TLcdLASModelDecoder#setMaxNumberOfPoints method.
Since:

2014.0

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TLspLIDARLayerBuilder`	`bodyScaleRange(ILcdInterval aScaleRange)` Sets a scale range within which the objects are displayed.
`TLspLIDARLayerBuilder`	`bodyStyler(TLspPaintState aPaintState, ILspStyler aStyler)` Sets the styler used for the points in the `BODY` paint representation.
`TLspLIDARLayerBuilder`	`bodyStyles(TLspPaintState aPaintState, TLspPlotStyle... aStyles)` Sets a (fixed) set of styles to use in this layer for the `BODY` paint representation.
`ILspLayer`	`build()` Creates a new layer instance.
`static TLspPlotStyle`	`getDefaultStyle(ILcdModel aModel)` Creates a `TLspPlotStyle` configured for the given model.
`TLspLIDARLayerBuilder`	`icon(ILcdIcon aIcon)` Sets the icon of the layer.
`TLspLIDARLayerBuilder`	`label(String aLabel)` Sets the label of the layer.
`TLspLIDARLayerBuilder`	`layerStyle(TLspLayerStyle aLayerStyle)` Set a layer style to be used during the rendering of the layer.
`TLspLIDARLayerBuilder`	`layerType(ILspLayer.LayerType aLayerType)` The layer type of lidar layers cannot be set.
`TLspLIDARLayerBuilder`	`mandatoryAttributes(ILcdExpression... aMandatoryAttributes)` Set a list of attributes that should always be loaded, regardless of what is necessary for styling and filtering.
`TLspLIDARLayerBuilder`	`model(ILcdModel aModel)` Sets the model of the layer.
`static TLspLIDARLayerBuilder`	`newBuilder()` Creates a new builder.

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
  - newBuilder
```
public static TLspLIDARLayerBuilder newBuilder()
```
    Creates a new builder.
    You must set a model on it using model(com.luciad.model.ILcdModel).
    
    Default values:
    - attributes: all data properties of the model are added as mandatory attributes
    - style(r): the default styling is explained in the class javadoc
    - scale range: not set (always visible)
    Returns:
    
    A builder
  - model
```
public TLspLIDARLayerBuilder 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 TLspLIDARLayerBuilder 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 TLspLIDARLayerBuilder 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 TLspLIDARLayerBuilder 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 TLspLIDARLayerBuilder layerType(ILspLayer.LayerType aLayerType)
```
    The layer type of lidar layers cannot be set. It is always ILspLayer.LayerType.INTERACTIVE.
    This method throws UnsupportedOperationException.
    
    Overrides:
    
    layerType in class ALspLayerBuilder
    
    Parameters:
    
    aLayerType - not used
    
    Returns:
    
    this builder
    
    See Also:
    
    ILspLayer.getLayerType()
  - mandatoryAttributes
```
public TLspLIDARLayerBuilder 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.
    
    For LAS layers, height, color, classification, intensity and infra-red are added by default for convenience.
    
    For E57 layers, height, color, and intensity are added by default for convenience when they are present in the data.
    
    Parameters:
    
    aMandatoryAttributes - The set of mandatory attributes
    
    Returns:
    
    this
  - bodyStyles
```
public TLspLIDARLayerBuilder 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, the default styling is used (see class javadoc for details).
    
    Parameters:
    
    aPaintState - Paint state for this styler
    
    aStyles - The styles to use
    
    Returns:
    
    this
    
    See Also:
    
    TLspPlotStyle
  - bodyStyler
```
public TLspLIDARLayerBuilder 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 style target provider to extract the actual point geometry out of the domain object. It must return ILcdPoint objects.
    For example:
```
   public void style(Collection aObjects, ALspStyleCollector aStyleCollector, TLspContext aContext) {
     aStyleCollector.objects(aObjects).geometry(fPointExtractor).style(fStyle).submit();
   }
 
```
    If not set, the default styling is used (see class javadoc for details).
    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 TLspLIDARLayerBuilder 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.
    
    Parameters:
    
    aScaleRange - The scale range
    
    Returns:
    
    this
  - build
```
public ILspLayer build()
```
    Description copied from class: ALspLayerBuilder
    
    Creates a new layer instance.
    
    Specified by:
    
    build in class ALspLayerBuilder
    
    Returns:
    
    the new layer instance
  - getDefaultStyle
```
public static TLspPlotStyle getDefaultStyle(ILcdModel aModel)
```
    Creates a TLspPlotStyle configured for the given model.
    - If a data property with type Color is available it uses that.
    - Otherwise, a color gradient over the height range in the model is used.
    - Optimized painting performance: point size and visibility is automatically adapted based on the model extent and camera settings.
    You can use this to customize styling while keeping as much defaults as possible.
    Example:
```
   TLspPlotStyle defaultStyle = getDefaultStyle(myModel);
   ILcdExpression<Color> myColorExpression = ...
   TLspPlotStyle myStyle = defaultStyle.asBuilder()
                                       .color(ifThenElse(myColorAvailable, myColorExpression, defaultStyle.getColor()));
                                       .build();
 
```
    Parameters:
    
    aModel - The model to create a style for.
    
    Returns:
    
    A plot style.

LuciadLightspeedClass TLspLIDARLayerBuilder

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

newBuilder

model

label

icon

layerStyle

layerType

mandatoryAttributes

bodyStyles

bodyStyler

bodyScaleRange

build

getDefaultStyle