com.luciad.view.lightspeed.measure

LuciadLightspeedClass TLspViewMeasureProvider

java.lang.Object

com.luciad.util.measure.ALcdMeasureProvider

com.luciad.view.lightspeed.measure.TLspViewMeasureProvider

public class TLspViewMeasureProvider
extends ALcdMeasureProvider

This class retrieves measures of the layers in a Lightspeed view. The default behavior retrieves the topmost measures for every type of measure.

It is possible to configure this measure provider with model measure provider factories or layer measure provider factories. Both are optional, so it is possible to create a view measure provider based on model measure provider factories only, layer measure provider factories only, or both. In the latter case, the model measure provider factories are used as a fallback for the layer measure provider factories.

Note that LuciadLightspeed uses a more specific API for height values: TLcdViewHeightProvider.

Since:

2013.0

See Also:

setRetrieveTopMostMeasures(boolean)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TLspViewMeasureProvider.DefaultSampleDensity Sets the sample density to use when no sample density is specified in the Parameters (Double.isNan(getSampleDensity) == true).

Nested classes/interfaces inherited from class com.luciad.util.measure.ALcdMeasureProvider

ALcdMeasureProvider.Parameters

Constructor Summary

Constructors

Constructor and Description
TLspViewMeasureProvider(ILspView aView, Iterable<? extends ILcdModelMeasureProviderFactory> aMeasureProviderFactories) Creates a new measure provider for the given view, using the given collection of model measure provider factories.
TLspViewMeasureProvider(ILspView aView, Iterable<? extends ILcdModelMeasureProviderFactory> aModelMeasureProviderFactories, Iterable<? extends ILcdLayerMeasureProviderFactory> aLayerMeasureProviderFactories) Creates a new measure provider for the given view, using the given collections of model and layer measure provider factories.

Method Summary

Modifier and Type	Method and Description
TLspViewMeasureProvider.DefaultSampleDensity	getDefaultSampleDensity() Returns the default sample density.
boolean	isRetrieveTopMostMeasures() Returns whether to retrieve only the topmost measures of every measure type.
TLcdISO19103Measure[]	retrieveMeasuresAt(ILcdPoint aPoint, ILcdModelReference aPointReference, ALcdMeasureProvider.Parameters aParameters) This method retrieves the measures at the given point.
void	setDefaultSampleDensity(TLspViewMeasureProvider.DefaultSampleDensity aDefaultSampleDensity) Sets the default sample density to use when no sample density is specified in the Parameters object passed to the retrieveMeasuresAt method (Double.isNan(getSampleDensity) == true).
void	setRetrieveTopMostMeasures(boolean aRetrieveTopMostMeasures) Sets whether to retrieve only the topmost measures of every measure type.

Methods inherited from class java.lang.Object

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

Constructor Detail

TLspViewMeasureProvider

public TLspViewMeasureProvider(ILspView aView,
                               Iterable<? extends ILcdModelMeasureProviderFactory> aMeasureProviderFactories)

Creates a new measure provider for the given view, using the given collection of model measure provider factories.

Parameters:

aView - the view.

aMeasureProviderFactories - a collection of model measure provider factories. Can be null.

TLspViewMeasureProvider

public TLspViewMeasureProvider(ILspView aView,
                               Iterable<? extends ILcdModelMeasureProviderFactory> aModelMeasureProviderFactories,
                               Iterable<? extends ILcdLayerMeasureProviderFactory> aLayerMeasureProviderFactories)

Creates a new measure provider for the given view, using the given collections of model and layer measure provider factories. Both are optional, and can be null. See class doc for more information.

Parameters:

aView - the view.

aModelMeasureProviderFactories - a collection of model measure provider factories. Can be null.

aLayerMeasureProviderFactories - a collection of layer measure provider factories. Can be null.

Method Detail

isRetrieveTopMostMeasures

public boolean isRetrieveTopMostMeasures()

Returns whether to retrieve only the topmost measures of every measure type.

Returns:

true if, for every measure type, only the topmost measure is returned. false if all measures of all layers are returned.

See Also:

setRetrieveTopMostMeasures(boolean)

setRetrieveTopMostMeasures

public void setRetrieveTopMostMeasures(boolean aRetrieveTopMostMeasures)

Sets whether to retrieve only the topmost measures of every measure type.

Parameters:

aRetrieveTopMostMeasures - if true, for every measure type, only the topmost measure is returned. If false, all measures of all layers are returned.

See Also:

TLcdISO19103MeasureTypeCode, isRetrieveTopMostMeasures()

getDefaultSampleDensity

public TLspViewMeasureProvider.DefaultSampleDensity getDefaultSampleDensity()

Returns the default sample density.

Returns:

the default sample density.

See Also:

setDefaultSampleDensity(com.luciad.view.lightspeed.measure.TLspViewMeasureProvider.DefaultSampleDensity)

setDefaultSampleDensity

public void setDefaultSampleDensity(TLspViewMeasureProvider.DefaultSampleDensity aDefaultSampleDensity)

Sets the default sample density to use when no sample density is specified in the Parameters object passed to the retrieveMeasuresAt method (Double.isNan(getSampleDensity) == true).

The default is VIEW_SAMPLE_DENSITY.

Parameters:

aDefaultSampleDensity - the default sample density.

retrieveMeasuresAt

public TLcdISO19103Measure[] retrieveMeasuresAt(ILcdPoint aPoint,
                                                ILcdModelReference aPointReference,
                                                ALcdMeasureProvider.Parameters aParameters)

This method retrieves the measures at the given point.

Specified by:

retrieveMeasuresAt in class ALcdMeasureProvider

Parameters:

aPoint - the point for which to retrieve measures.

aPointReference - the reference in which aPoint is defined.

aParameters - the parameters.

Returns:

an array with the found measurements, or an empty array if no measure was found