com.luciad.model

LuciadLightspeedInterface ILcd2DBoundsInteractable

All Known Subinterfaces:

ILcd2DBoundsIndexedModel, ILcdFeatureIndexedAnd2DBoundsIndexedModel

All Known Implementing Classes:

ALfnTileStoreModel, TLcd2DBoundsIndexedModel, TLcd2DBoundsIndexedModelList, TLcd2DBoundsIndexedModelTreeNode, TLcd2DRegularTiledBoundsIndexedModel , TLcdAIXM51AbstractAIXMMessage, TLcdASTERIXFilteredModel, TLcdDatabaseModel, TLcdDatabaseReadOnlyModel, TLcdDataObjectIndexedAnd2DBoundsIndexedModel, TLcdFeatureIndexedAnd2DBoundsIndexedModel , TLcdGML2AbstractFeatureCollection, TLcdGML31AbstractFeatureCollection, TLcdGML31DynamicFeatureCollection, TLcdGML31FeatureCollection, TLcdGML31Model, TLcdGML32AbstractFeatureCollection, TLcdGML32FeatureCollection, TLcdGML32Model, TLcdKML22AbstractContainer, TLcdKML22Document, TLcdKML22DynamicModel, TLcdKML22Folder, TLcdKML22Kml, TLcdKML22RenderableModel, TLcdMagneticNorthModel, TLcdMultilevel2DBoundsIndexedModel, TLcdMultilevelGridCoordinateModel, TLcdNetCDFFilteredModel, TLcdNVG15Model, TLcdNVG20FilteredModel, TLcdNVG20Model, TLcdRegularTiled2DBoundsIndexedModel , TLcdS57DepthAreaEdgeModel, TLcdSoft2DBoundsIndexedModel, TLcdTiled2DBoundsIndexedModel , TLcdTrackModel, TLcdWCSProxyModel, TLcdWFSProxyModel

public interface ILcd2DBoundsInteractable

An interface for objects whose contents can be spatially queried.

Since:

V2.0

See Also:

ILcdTileProvider, ILcdTileDecoder

Method Summary

Modifier and Type	Method and Description
int	applyOnInteract2DBounds(ILcdBounds aBounds, boolean aStrictInteract, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY, double aMinSizeX, double aMinSizeY, boolean aIncludePoints) Applies the specified function to all the elements of which the 2D bounds overlap with the specified bounds.

Method Detail

applyOnInteract2DBounds

int applyOnInteract2DBounds(ILcdBounds aBounds,
                            boolean aStrictInteract,
                            ILcdFunction aFunctionToApply,
                            double aPrecisionX,
                            double aPrecisionY,
                            double aMinSizeX,
                            double aMinSizeY,
                            boolean aIncludePoints)

Applies the specified function to all the elements of which the 2D bounds overlap with the specified bounds. The order in which the function is applied on the elements is unspecified and depends on the implementation.

Only elements that have at least the specified minimal size in the x dimension or in the y dimension are considered. This can be useful for quickly eliminating elements that are too small to be visible in a view, for instance. If required, an exception can be made for point elements, which have a size of 0 by 0. They can be forced to be considered, even though they would always be rejected as being too small for any sizes larger than 0.

The return value of the specified function is used as a stop criterion: the spatial query will be interrupted as soon as the function returns false for an element it was applied on.

Parameters:

aBounds - the rectangle to test overlap with.

aStrictInteract - if false, the spatial search may return more elements than the ones strictly overlapping; if true, the search only returns the elements that are overlapping. The latter mode is more precise, but it may be slower.

aFunctionToApply - the function to apply on each element that overlaps with the given bounds.

aPrecisionX - the precision required in the x dimension, expressed in model units. For example, for a cartesian grid system expressed in meters, the values should be expressed in meters as well, for a geodetic coordinate system the accuracy values should be expressed in degrees.

The precision is useful in combination with multi-leveled data (multiple representations of the same object, but with varying accuracy), so that the most appropriate accuracy level can be used. 0 means best possible accuracy, but it might trigger lazy-loaded implementations to load lots of data.

aPrecisionY - the precision required in the y dimension, expressed in model units.

aMinSizeX - the minimal element size in the x dimension (as in ILcdBounds.getWidth()), expressed in model units. Elements that are smaller than this size will be skipped. This may, for example, be useful when improving the efficiency of painting elements by skipping elements that are smaller than some threshold (e.g. one pixel, converted to model units).

aMinSizeY - the minimal element size in the y dimension (as in ILcdBounds.getHeight()), expressed in model units.

aIncludePoints - if true, zero-sized elements (points) are considered as well, even though they might be smaller than the minimum size.

Returns:

the number of elements to which the ILcdFunction has been applied.

Throws:

NullPointerException - if the specified bounds or the specified function are null.