Package com.luciad.util.height

package com.luciad.util.height

General interfaces and implementations to retrieve heights from data, for instance, elevation rasters.

ILcdHeightProvider

This package defines ILcdHeightProvider, an interface used to retrieve height from data, and its main implementations :

• TLcdRasterHeightProvider, a height provider retrieving its height from a raster.
• TLcdTransformedHeightProvider, a height provider that retrieves its heights from another height provider with a different reference.
• TLcdCompositeHeightProvider, a height provider that combines multiple height providers.
• TLcdFixedHeightProvider, a height provider that returns a fixed height for each point.

ILcdModelHeightProviderFactory

This package also defines ILcdModelHeightProviderFactory, an interface used to create an ILcdHeightProvider from an ILcdModel. This interface has 2 standard implementations :

• ALcdModelHeightProviderFactory, a height provider factory that returns an ILcdHeightProvider from a model, using an abstract method that returns an ILcdHeightProvider from a model element.
• TLcdRasterModelHeightProviderFactory, an ALcdModelHeightProviderFactory that implements the abstract method for raster model elements.

ILcdLayerHeightProviderFactory

This package also defines ILcdLayerHeightProviderFactory, an interface used to create an ILcdHeightProvider from an ILdLayer.

Properties

When using an ILcdModelHeightProviderFactory or ILcdLayerHeightProviderFactory to create an ILcdHeightProvider, a set of properties is used.

When using these properties to create an ILcdHeightProvider using an ILcdModelHeightProviderFactory or ILcdLayerHeightProviderFactory, properties can be classified as required or optional.

• Required : A property should be required when the user wants to make sure that this property is actually used. When this property is not used during the creation of an ILcdHeightProvider, a TLcdUnsupportedPropertyException must be thrown. When implementing an ILcdModelHeightProviderFactory or ILcdLayerHeightProviderFactory, one should always make sure that required properties are removed when they are used, and that the list of required properties is verified when a height provider gets created.
• Optional : A property should be optional when the user doesn't need this property to be used.

When implementing an ILcdModelHeightProviderFactory or ILcdLayerHeightProviderFactory, properties can also be classified as follows :

• Necessary : This means that the implementation needs this property to work correctly. When the user fails to provide a necessary property, a TLcdMissingPropertyException must be thrown.
• Not necessary : This means that the implementation does not need this property to work correctly.

Since:

9.1

Related Packages

Package	Description
com.luciad.util	Basic utilities.

Class	Description
ALcdModelHeightProviderFactory	This abstract class provides a method to create an ILcdHeightProvider when an ILcdModel is given.
ALcdRasterModelHeightProviderFactory	This class provides the common interface and methods of both the legacy TLcdRasterModelHeightProviderFactory and the new TLcdImageModelHeightProviderFactory
ILcdHeightProvider	This interface provides height values for 2D points inside known bounds.
ILcdLayerHeightProviderFactory	This interface provides a method to create a height provider from a layer and a view.
ILcdModelHeightProviderFactory	This interface provides a method to create a height provider from a model.
TLcdCompositeHeightProvider	This height provider combines a list of height providers.
TLcdCompositeModelHeightProviderFactory	This ILcdModelHeightProviderFactory tries to create an ILcdHeightProvider using a given list of other ILcdModelHeightProviderFactory instances.
TLcdFixedHeightProvider	Default implementation of the ILcdHeightProvider interface that returns a constant given height for any given point.
TLcdImageHeightProvider	A height provider which can read values out of an ALcdBasicImage.
TLcdImageModelHeightProviderFactory	This class provides a method to create an ILcdHeightProvider when an ILcdModel is given that contains elements of the type ALcdBasicImage, ALcdImageMosaic or ALcdMultilevelImageMosaic.
TLcdInterpolatingRasterHeightProvider	This height provider retrieves its heights from a given raster using interpolation between height values to gain a smoother result.
TLcdMissingPropertyException	Thrown to indicate that a property is missing.
TLcdModelHeightProviderFactoryUtil	Utility class containing convenience methods for implementing ILcdModelHeightProviderFactory.
TLcdRasterHeightProvider	This height provider retrieves its heights from a given raster.
TLcdRasterModelHeightProviderFactory	Important notice: the package com.luciad.imaging presents a new API for the modeling of raster data.
TLcdTransformedHeightProvider	This height provider retrieves its heights from another height provider with a different reference.
TLcdUnsupportedPropertyException	Thrown to indicate that a required property is not supported.
TLcdViewHeightProvider<S extends ILcdView & ILcdLayered>	This ILcdHeightProvider retrieves height based on a view.