Package org.cytoscape.view.model.spacial
Interface NetworkSpacialIndex2D
- All Superinterfaces:
SpacialIndex2D<Long>
Stores the location and rectangular boundary of nodes in a 2D representation of a network.
Also provides methods for querying edges that are adjacent to visible nodes.
All methods support cancellation.
- Since:
- 3.9
- See Also:
-
BasicVisualLexicon.NODE_Z_LOCATION
BasicVisualLexicon.EDGE_Z_ORDER
Cytoscape Backwards Compatibility (SPI Interface): We expect that this interface will be implemented. Therefore to maintain backwards compatibility this interface will only be modified for major version updates.
Module: viewmodel-api
To use this in your app, include the following dependency in your POM:
<dependency> <groupId>org.cytoscape</groupId> <artifactId>viewmodel-api</artifactId> </dependency>
-
Field Summary
Fields inherited from interface org.cytoscape.view.model.spacial.SpacialIndex2D
X_MAX, X_MIN, Y_MAX, Y_MIN
-
Method Summary
Modifier and TypeMethodDescriptionqueryAllEdges
(BooleanSupplier isCancelled) Returns an enumerator of all edges in the network.queryAllNodes
(BooleanSupplier isCancelled) Returns an enumerator of all the nodes in the network.queryOverlapEdges
(float xMin, float yMin, float xMax, float yMax, BooleanSupplier isCancelled) Returns an enumerator of all edges that are adjacent to nodes that are contained within or intersecting the given rectangle.queryOverlapNodes
(float xMin, float yMin, float xMax, float yMax, BooleanSupplier isCancelled) Returns an enumerator of all the nodes that are contained within or intersecting the given rectangle.Methods inherited from interface org.cytoscape.view.model.spacial.SpacialIndex2D
exists, get, get, getMBR, getMBR, queryAll, queryOverlap, size
-
Method Details
-
queryAllNodes
Returns an enumerator of all the nodes in the network. The enumerator will return nodes in the order given by theBasicVisualLexicon.NODE_Z_LOCATION
visual property.- Parameters:
isCancelled
- (May be null). An optional boolean returning function that will cancel a long running query if it returns true. The isCancelled function will typically be called several times depending on how many nodes are in the network. If isCancelled returns true then this method will return null.- Returns:
- null if isCancelled returns null during the query
- See Also:
-
BasicVisualLexicon.NODE_Z_LOCATION
-
queryOverlapNodes
NodeSpacialIndex2DEnumerator queryOverlapNodes(float xMin, float yMin, float xMax, float yMax, BooleanSupplier isCancelled) Returns an enumerator of all the nodes that are contained within or intersecting the given rectangle. The enumerator will return nodes in the order given by theBasicVisualLexicon.NODE_Z_LOCATION
visual property.- Parameters:
isCancelled
- (May be null). An optional boolean returning function that will cancel a long running query if it returns true. The isCancelled function will typically be called several times depending on how many nodes are in the network. If isCancelled returns true then this method will return null.- Returns:
- null if isCancelled returns null during the query
- See Also:
-
BasicVisualLexicon.NODE_Z_LOCATION
-
queryAllEdges
Returns an enumerator of all edges in the network. The enumerator will return edges in the order given by theBasicVisualLexicon.EDGE_Z_ORDER
visual property.- Parameters:
isCancelled
- (May be null). An optional boolean returning function that will cancel a long running query if it returns true. The isCancelled function will typically be called several times depending on how many edges are in the network. If isCancelled returns true then this method will return null.- Returns:
- null if isCancelled returns null during the query
- See Also:
-
BasicVisualLexicon.EDGE_Z_ORDER
-
queryOverlapEdges
EdgeSpacialIndex2DEnumerator queryOverlapEdges(float xMin, float yMin, float xMax, float yMax, BooleanSupplier isCancelled) Returns an enumerator of all edges that are adjacent to nodes that are contained within or intersecting the given rectangle. The enumerator will return edges in the order given by theBasicVisualLexicon.EDGE_Z_ORDER
visual property.- Parameters:
isCancelled
- (May be null). An optional boolean returning function that will cancel a long running query if it returns true. The isCancelled function will typically be called several times depending on how many edges are in the network. If isCancelled returns true then this method will return null.- Returns:
- null if isCancelled returns null during the query
- See Also:
-
BasicVisualLexicon.EDGE_Z_ORDER
-