Class LineOfSightFeature
A line-of-sight feature defines an observer location along with some additional properties like radius. All properties together define a line-of-sight coverage. This is the visualization of the visibility of the surrounding environment when observed by the observer.
Use LineOfSightFeature#newBuilder
to create a line-of-sight feature.
- Since:
- 2025.0
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
Allows the incremental creation of a line-of-sightFeature
object. -
Method Summary
Modifier and TypeMethodDescriptionstatic ArcBand
Converts a line-of-sight feature to an arc band.static Bounds
computeBounds
(Feature lineOfSightFeature) Computes the bounds of a line-of-sight feature.static Bounds
computeBounds
(IFeatureModel model) Computes the bounds of a line-of-sight feature model, if available.static DataPropertyPath
Returns the data property path for the line-of-sight center height property.static DataPropertyPath
Returns the data property path for the line-of-sight center property.static DataPropertyPath
Returns the data property path for the line-of-sight end angle property.static DataType
Returns the data type describing the line-of-sight feature properties.static DataPropertyPath
Returns the data property path for the line-of-sight maximum vertical angle property.static DataPropertyPath
Returns the data property path for the line-of-sight minimum vertical angle property.static DataPropertyPath
Returns the data property path for the line-of-sight radius property.static DataPropertyPath
Returns the data property path for the line-of-sight start angle property.static LineOfSightFeature.Builder
Returns a new builder for creating a line-of-sight feature.
-
Method Details
-
getLineOfSightPropertiesDataType
Returns the data type describing the line-of-sight feature properties.- Returns:
- the data type describing the line-of-sight feature properties.
-
getCenterPropertyPath
Returns the data property path for the line-of-sight center property.- Returns:
- the data property path for the line-of-sight center property.
-
getCenterHeightPropertyPath
Returns the data property path for the line-of-sight center height property.- Returns:
- the data property path for the line-of-sight center height property.
-
getRadiusPropertyPath
Returns the data property path for the line-of-sight radius property.- Returns:
- the data property path for the line-of-sight radius property.
-
getStartAnglePropertyPath
Returns the data property path for the line-of-sight start angle property.Values referred to by this
DataPropertyPath
are in degrees.- Returns:
- the data property path for the line-of-sight start angle property.
-
getEndAnglePropertyPath
Returns the data property path for the line-of-sight end angle property.Values referred to by this
DataPropertyPath
are in degrees.- Returns:
- the data property path for the line-of-sight end angle property.
-
getMinimumVerticalAnglePropertyPath
Returns the data property path for the line-of-sight minimum vertical angle property.Values referred to by this
DataPropertyPath
are in degrees.- Returns:
- the data property path for the line-of-sight minimum vertical angle property.
-
getMaximumVerticalAnglePropertyPath
Returns the data property path for the line-of-sight maximum vertical angle property.Values referred to by this
DataPropertyPath
are in degrees.- Returns:
- the data property path for the line-of-sight maximum vertical angle property.
-
asArcBand
Converts a line-of-sight feature to an arc band.- Parameters:
lineOfSightFeature
- the feature that should be converted.- Returns:
- the arc band corresponding to the feature or
null
if the feature is missing some properties.
-
computeBounds
@NotNull public static Bounds computeBounds(@NotNull Feature lineOfSightFeature) throws IllegalArgumentException Computes the bounds of a line-of-sight feature.Not that all the line-of-sight properties are required for this computation.
- Parameters:
lineOfSightFeature
- the feature for which the bounds should be computed.- Returns:
- the bounds of this feature
- Throws:
IllegalArgumentException
- if the feature is missing some line-of-sight property.
-
computeBounds
@Nullable public static Bounds computeBounds(@NotNull IFeatureModel model) throws NullPointerException Computes the bounds of a line-of-sight feature model, if available.When the model contains no features, this method will return no bounds. Features missing lime-of-sight properties are ignored.
- Parameters:
model
- the model for which the bounds should be computed.- Returns:
- the bounds of this model, if available.
- Throws:
NullPointerException
- when passingnull
for the model
-
newBuilder
Returns a new builder for creating a line-of-sight feature.- Returns:
- a new builder for creating a line-of-sight feature.
-