Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.layers

Class SceneLayerPolygonFilter

java.lang.Object

com.esri.arcgisruntime.layers.SceneLayerPolygonFilter

public final class SceneLayerPolygonFilter
extends Object

Filter features from an ArcGISSceneLayer using one or more polygons and a SceneLayerPolygonFilter.SpatialRelationship.

Since:

200.2.0

Property Summary

Properties

Type	Property	Description
ObjectProperty<SceneLayerPolygonFilter.SpatialRelationship>	spatialRelationship	The spatial relationship to be applied to the polygons for filtering features.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SceneLayerPolygonFilter.SpatialRelationship	The spatial relationships for filtering using polygon geometries.

Constructor Summary

Constructors

Constructor	Description
SceneLayerPolygonFilter(Iterable<Polygon> polygons, SceneLayerPolygonFilter.SpatialRelationship spatialRelationship)	Creates a new SceneLayerPolygonFilter using a collection of polygons and a spatial relationship to be applied to the ArcGISSceneLayer.

Method Summary

Modifier and Type	Method	Description
List<Polygon>	getPolygons()	Gets a list of polygon geometries to be applied for filtering features.
SceneLayerPolygonFilter.SpatialRelationship	getSpatialRelationship()	Gets the value of the spatialRelationship property.
void	setSpatialRelationship(SceneLayerPolygonFilter.SpatialRelationship spatialRelationship)	Sets the value of the spatialRelationship property.
ObjectProperty<SceneLayerPolygonFilter.SpatialRelationship>	spatialRelationshipProperty()	The spatial relationship to be applied to the polygons for filtering features.

Methods inherited from class java.lang.Object

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

Property Details

spatialRelationship

public ObjectProperty<SceneLayerPolygonFilter.SpatialRelationship> spatialRelationshipProperty

The spatial relationship to be applied to the polygons for filtering features.

The spatial relationship determines whether to include features within the polygons or exclude features from the polygons.

Attempting to set the value to null will throw a NullPointerException exception.

Since:

200.2.0

See Also:

• getSpatialRelationship()
• setSpatialRelationship(SceneLayerPolygonFilter.SpatialRelationship)
• spatialRelationshipProperty()

Constructor Details

SceneLayerPolygonFilter

public SceneLayerPolygonFilter(Iterable<Polygon> polygons,
 SceneLayerPolygonFilter.SpatialRelationship spatialRelationship)

Creates a new SceneLayerPolygonFilter using a collection of polygons and a spatial relationship to be applied to the ArcGISSceneLayer.

Parameters:

polygons - a collection of polygons to be used for filtering features

spatialRelationship - the spatial relationship to be applied to the polygons for filtering

Throws:

NullPointerException - if polygons is null

NullPointerException - if spatialRelationship is null

Since:

200.2.0

See Also:

• SceneLayerPolygonFilter.SpatialRelationship

Method Details

getPolygons

public List<Polygon> getPolygons()

Gets a list of polygon geometries to be applied for filtering features.

Returns:

a list of polygon geometries to be applied for filtering features

Since:

200.2.0

spatialRelationshipProperty

public ObjectProperty<SceneLayerPolygonFilter.SpatialRelationship> spatialRelationshipProperty()

The spatial relationship to be applied to the polygons for filtering features.

The spatial relationship determines whether to include features within the polygons or exclude features from the polygons.

Attempting to set the value to null will throw a NullPointerException exception.

Returns:

the spatialRelationship property

Since:

200.2.0

See Also:

• getSpatialRelationship()
• setSpatialRelationship(SceneLayerPolygonFilter.SpatialRelationship)

getSpatialRelationship

public SceneLayerPolygonFilter.SpatialRelationship getSpatialRelationship()

Gets the value of the spatialRelationship property.

Property description:

The spatial relationship to be applied to the polygons for filtering features.

The spatial relationship determines whether to include features within the polygons or exclude features from the polygons.

Attempting to set the value to null will throw a NullPointerException exception.

Returns:

the value of the spatialRelationship property

Since:

200.2.0

See Also:

• setSpatialRelationship(SceneLayerPolygonFilter.SpatialRelationship)
• spatialRelationshipProperty()

setSpatialRelationship

public void setSpatialRelationship(SceneLayerPolygonFilter.SpatialRelationship spatialRelationship)

Sets the value of the spatialRelationship property.

Property description:

The spatial relationship to be applied to the polygons for filtering features.

The spatial relationship determines whether to include features within the polygons or exclude features from the polygons.

Attempting to set the value to null will throw a NullPointerException exception.

Parameters:

spatialRelationship - the value for the spatialRelationship property

Since:

200.2.0

See Also:

• getSpatialRelationship()
• spatialRelationshipProperty()