com.luciad.tea.lightspeed.hypsometry

Terrain Analysis EngineClass TLspHypsometricShadingLayerBuilder

java.lang.Object

com.luciad.view.lightspeed.layer.ALspLayerBuilder

com.luciad.tea.lightspeed.hypsometry.TLspHypsometricShadingLayerBuilder

public class TLspHypsometricShadingLayerBuilder
extends ALspLayerBuilder

Builder that creates ILspEditableStyledLayer instances that perform hypsometric shading.

To create a hypsometric shading layer you need to specify:

• the elevation data: this can either be the view's terrain or a specific elevation model
• the styler: this determines what type of hypsometric computation is performed, and how the hypsometric values are mapped to colors, the styler should provide TLspHypsometricShadingStyle instances

Since:

2012.0

Method Summary

Modifier and Type	Method and Description
ILspEditableStyledLayer	build() Creates and returns a new hypsometric shading layer based on the current parameters of this builder.
TLspHypsometricShadingLayerBuilder	elevationFromModel(ILcdModel aModel) Sets the model that is used as the elevation source for the hypsometric calculations.
TLspHypsometricShadingLayerBuilder	elevationFromView() Sets the view's terrain as the elevation source for the hypsometric calculations.
TLspHypsometricShadingLayerBuilder	filter(ILcdDynamicFilter aFilter) Sets a filter that will be used to filter objects to prevent them from being painted by the layer.
TLspHypsometricShadingLayerBuilder	label(String aLabel) Sets the label of the layer.
TLspHypsometricShadingLayerBuilder	layerStyle(TLspLayerStyle aLayerStyle) Set a layer style to be used during the rendering of the layer.
TLspHypsometricShadingLayerBuilder	layerType(ILspLayer.LayerType aLayerType) Setting the layer type is not supported.
TLspHypsometricShadingLayerBuilder	model(ILcdModel aModel) Sets the elevation model that will be used for the hypsometric computations.
static TLspHypsometricShadingLayerBuilder	newBuilder()
TLspHypsometricShadingLayerBuilder	styler(TLspPaintRepresentationState aPaintRepresentationState, ILspStyler aStyler) Sets the styler of the hypsometric shading 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

build

public ILspEditableStyledLayer build()

Creates and returns a new hypsometric shading layer based on the current parameters of this builder.

Specified by:

build in class ALspLayerBuilder

Returns:

a new hypsometric shading layer

styler

public TLspHypsometricShadingLayerBuilder styler(TLspPaintRepresentationState aPaintRepresentationState,
                                                 ILspStyler aStyler)

Sets the styler of the hypsometric shading layer.

The default styler drapes the raster data on top of the view's terrain.

Only the TLspPaintRepresentationState.REGULAR_BODY affects the style of the layer.

The styler should submit:

• a TLspHypsometricShadingStyle instance: mandatory, this controls the hypsometric shading of the elevation data
• a TLspRasterStyle instance: this controls some additional styling of the hypsometric shading
• a TLspLineStyle instance: this controls the style of the outline of the bounds of the data
• a TLspFillStyle instance: this controls the style of the fill of the bounds of the data

The hypsometric values are only painted if the pixel density of the data is not too high (depending on the TLspRasterStyle.getStartResolutionFactor()). Otherwise the bounds of the data are painted instead.

Parameters:

aPaintRepresentationState - the paint representation state

aStyler - the styler

Returns:

this builder

newBuilder

public static TLspHypsometricShadingLayerBuilder newBuilder()

Returns:

creates a new hypsometric shading layer builder

elevationFromModel

public TLspHypsometricShadingLayerBuilder elevationFromModel(ILcdModel aModel)

Sets the model that is used as the elevation source for the hypsometric calculations.

Parameters:

aModel - the model

Returns:

this builder

Throws:

IllegalArgumentException - if the specified model does not contain elevation data

elevationFromView

public TLspHypsometricShadingLayerBuilder elevationFromView()

Sets the view's terrain as the elevation source for the hypsometric calculations. The model is undefined in this case.

Returns:

this builder

model

public TLspHypsometricShadingLayerBuilder model(ILcdModel aModel)

Sets the elevation model that will be used for the hypsometric computations.

Overrides:

model in class ALspLayerBuilder

Parameters:

aModel - a model

Returns:

this builder

Throws:

IllegalArgumentException - if the specified model does not contain elevation data

See Also:

ILcdLayer.getModel()

label

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

filter

public TLspHypsometricShadingLayerBuilder filter(ILcdDynamicFilter aFilter)

Sets a filter that will be used to filter objects to prevent them from being painted by the layer. No filter is set by default.

Parameters:

aFilter - the filter

Returns:

this

layerType

public TLspHypsometricShadingLayerBuilder layerType(ILspLayer.LayerType aLayerType)

Setting the layer type is not supported.

Overrides:

layerType in class ALspLayerBuilder

Parameters:

aLayerType - the layer type

Returns:

this builder

See Also:

ILspLayer.getLayerType()

layerStyle

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