public class TLcyVisibilityBackEnd extends ALcyTEABackEnd
TLcdVisibilityMatrixViewFactory
to calculate visibility values;
TLcdMatrixViewRasterFactory
to visualize visibility results as a raster.
ALcyTEABackEnd
Modifier and Type | Field and Description |
---|---|
static String |
DOMAIN_OBJECT_CONTEXT_KEY
Property name for the domain object context associated with a shape to calculate a visibility result for.
|
static String |
PROPAGATION_FUNCTION_KEY
The property name for the propagation function of the visibility computation.
|
static String |
PROPAGATION_FUNCTION_VALUE_NORMAL
Denotes a normal propagation function.
|
static String |
PROPAGATION_FUNCTION_VALUE_SKY_BACKGROUND
Denotes a propagation function with sky in background.
|
static String |
SKY_DISTANCE_KEY
The property name for the
PROPAGATION_FUNCTION_VALUE_SKY_BACKGROUND distance after the end point in
which the terrain is taken into account as possible background. |
ALTITUDE_PROVIDER_KEY, DISPLAY_NAME_KEY, MODEL_DISPLAY_NAME_KEY, MODEL_REFERENCE_KEY, QUALITY_KEY, SHAPE_KEY, SHAPE_REFERENCE_KEY, SOURCE_NAME_KEY, TARGET_REFERENCE_KEY, VIEW_KEY
Constructor and Description |
---|
TLcyVisibilityBackEnd(ILcyLucyEnv aLucyEnv)
Default constructor for the visibility back-end.
|
Modifier and Type | Method and Description |
---|---|
TLcdAltitudeDescriptor |
createAltitudeDescriptor(ALcyProperties aProperties)
Returns an altitude descriptor suitable for the add-on's purposes.
|
ILcdAltitudeProvider |
createAltitudeProvider(ALcyProperties aProperties)
Returns a view-based altitude provider.
|
TLcdContourFinder |
createContourFinder(ALcyProperties aProperties)
Returns a contour finder to visualize visibility results as contours.
|
TLcdMatrixViewRasterFactory |
createMatrixViewRasterFactory(ALcyProperties aProperties)
Returns a matrix view raster factory to visualize visibility as a raster.
|
ILcdModelDescriptor |
createModelDescriptor(ALcyProperties aProperties)
Returns a model descriptor suitable for the add-on's used models.
|
ILcdP2PPropagationFunction |
createPropagationFunction(ALcyProperties aProperties)
Creates a new visibility propagation function, based on the given properties.
|
ILcdMatrixRasterValueMapper |
createPropagationMatrixRasterValueMapper(String aPropagationFunctionKey)
Returns a
ILcdMatrixRasterValueMapper for the given propagation function ID. |
TLcdVisibilityDescriptor |
createVisibilityDescriptor(ALcyProperties aProperties)
Returns a visibility descriptor with visibility mappings suitable for this add-on.
|
TLcdVisibilityMatrixViewFactory |
createVisibilityMatrixViewFactory(ALcyProperties aProperties)
Returns a visibility matrix view factory with which to compute visibility matrix views.
|
String |
retrievePropagationFunctionLabel(String aPropagationFunctionKey)
Returns a displayable label for the given propagation function ID.
|
createAltitudeMatrixViewFactory, getLucyEnv
public static final String PROPAGATION_FUNCTION_KEY
PROPAGATION_FUNCTION_VALUE_NORMAL
and
PROPAGATION_FUNCTION_VALUE_SKY_BACKGROUND
.public static final String SKY_DISTANCE_KEY
PROPAGATION_FUNCTION_VALUE_SKY_BACKGROUND
distance after the end point in
which the terrain is taken into account as possible background.public static final String PROPAGATION_FUNCTION_VALUE_NORMAL
public static final String PROPAGATION_FUNCTION_VALUE_SKY_BACKGROUND
public static final String DOMAIN_OBJECT_CONTEXT_KEY
public TLcyVisibilityBackEnd(ILcyLucyEnv aLucyEnv)
aLucyEnv
- the Lucy environment for which the back-end will be usedpublic ILcdModelDescriptor createModelDescriptor(ALcyProperties aProperties)
createModelDescriptor
in class ALcyTEABackEnd
aProperties
- a properties object with the following parameters:
ALcyTEABackEnd.SOURCE_NAME_KEY
: The source name that was used to retrieve the data
from, use null
to indicate that it was
created from scratch.
ALcyTEABackEnd.DISPLAY_NAME_KEY
: the display name that the model descriptor should
use @return a suitable model descriptor
public ILcdAltitudeProvider createAltitudeProvider(ALcyProperties aProperties)
Note that an altitude provider using the altitude mode TLcdCoverageAltitudeMode.ABOVE_OBJECT
is not supported. If this method returns such an altitude provider, the visibility layer will not be
able to compute the visibility and will remain empty.
createAltitudeProvider
in class ALcyTEABackEnd
aProperties
- a properties object with the following parameters:
ALcyTEABackEnd.VIEW_KEY
the view for which to provide altitude values
ALcyTEABackEnd.QUALITY_KEY
the quality value to base the provider's pixel density on
public TLcdAltitudeDescriptor createAltitudeDescriptor(ALcyProperties aProperties)
Note that this descriptor can be used by the back-end's contour finder; it does not include Double.NaN values.
createAltitudeDescriptor
in class ALcyTEABackEnd
aProperties
- this implementation does not use any propertiespublic TLcdVisibilityDescriptor createVisibilityDescriptor(ALcyProperties aProperties)
aProperties
- this implementation does not use any propertiespublic ILcdP2PPropagationFunction createPropagationFunction(ALcyProperties aProperties)
PROPAGATION_FUNCTION_KEY
property.aProperties
- The arguments of this method. The following properties are needed:
PROPAGATION_FUNCTION_KEY
, one of PROPAGATION_FUNCTION_VALUE_NORMAL
or PROPAGATION_FUNCTION_VALUE_SKY_BACKGROUND
ALcyTEABackEnd.ALTITUDE_PROVIDER_KEY
, an altitude provider of type ALcdTerrainElevationProvider
public TLcdVisibilityMatrixViewFactory createVisibilityMatrixViewFactory(ALcyProperties aProperties)
aProperties
- This implementation does not require any arguments.public TLcdMatrixViewRasterFactory createMatrixViewRasterFactory(ALcyProperties aProperties)
aProperties
- This implementation does not require any arguments.public TLcdContourFinder createContourFinder(ALcyProperties aProperties)
aProperties
- This implementation does not require any arguments.public ILcdMatrixRasterValueMapper createPropagationMatrixRasterValueMapper(String aPropagationFunctionKey)
ILcdMatrixRasterValueMapper
for the given propagation function ID.aPropagationFunctionKey
- one of one of PROPAGATION_FUNCTION_VALUE_NORMAL
or
PROPAGATION_FUNCTION_VALUE_SKY_BACKGROUND
public String retrievePropagationFunctionLabel(String aPropagationFunctionKey)
aPropagationFunctionKey
- one of one of PROPAGATION_FUNCTION_VALUE_NORMAL
or
PROPAGATION_FUNCTION_VALUE_SKY_BACKGROUND