com.luciad.format.kml22.view.lightspeed

LuciadFusionClass TLspKML22LayerBuilder

java.lang.Object

com.luciad.view.lightspeed.layer.ALspLayerBuilder

com.luciad.format.kml22.view.lightspeed.TLspKML22LayerBuilder

public class TLspKML22LayerBuilder
extends ALspLayerBuilder

A layer builder for KML models. This layer builder takes care of everything needed to create a layer capable of visualizing a decoded KML file.

More specifically, layers created by this layer builder will contain the following functionality built in:

• A body styler
• A label styler
• A region filter (for filtering features with a region element, based on the view-scale)
• A resource provider. (For retrieving resources in the KML file)
• Model parameters that are updated automatically. (Needed for some files that retrieve data based on region).

Also note that this layer builder behaves differently based on the type of model you supply it.

• TLcdKML22Kml: This is what you get from the model decoder. Supplying this layer builder with a TLcdKML22Kml will automatically wrap it into a TLcdKML22RenderableModel.
• TLcdKML22RenderableModel: This model will not be wrapped. It will be set on the created layer as-is.

This class supports KML data sets containing Collada data. Consult the com.luciad.format.object3d package documentation for more information on which Collada features are supported.

Since:

2013.0

Method Summary

Modifier and Type	Method and Description
ILspLayer	build() Creates a new layer, as specified in the class javadoc.
TLspKML22LayerBuilder	layerStyle(TLspLayerStyle aLayerStyle) Set a layer style to be used during the rendering of the layer.
TLspKML22LayerBuilder	model(ILcdModel aModel) Sets a model for the layer to be built.
static TLspKML22LayerBuilder	newBuilder() Creates a new KL22 layer builder.
TLspKML22LayerBuilder	resourceProvider(TLcdKML22ResourceProvider aResourceProvider) Sets explicit resource provider for decoded models.

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

getIcon, getLabel, getLayerStyle, getLayerType, getModel, icon, label, layerType

Methods inherited from class java.lang.Object

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

Method Detail

model

public TLspKML22LayerBuilder model(ILcdModel aModel)

Sets a model for the layer to be built. May only be an instance of TLcdKML22Kml (which is what you get from the model decoder) or TLcdKML22RenderableModel.

Note that a TLcdKML22Kml will get wrapped in a TLcdKML22RenderableModel before it is added to the created layer.

Overrides:

model in class ALspLayerBuilder

Parameters:

aModel - a KML model

Returns:

this layer builder

See Also:

ILcdLayer.getModel()

newBuilder

public static TLspKML22LayerBuilder newBuilder()

Creates a new KL22 layer builder.

Returns:

a new layer builder instance

resourceProvider

public TLspKML22LayerBuilder resourceProvider(TLcdKML22ResourceProvider aResourceProvider)

Sets explicit resource provider for decoded models. By default, resource providers are extracted from the model descriptor of the model.

Parameters:

aResourceProvider - a resource provider

Returns:

this layer builder

layerStyle

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

build

public ILspLayer build()

Creates a new layer, as specified in the class javadoc.

Specified by:

build in class ALspLayerBuilder

Returns:

a new KML layer.