- Type Parameters:
S
- Type of the space.T
- Type of the sub-space.
- All Implemented Interfaces:
Region<S>
- Direct Known Subclasses:
ArcsSet
,IntervalsSet
,PolygonsSet
,PolyhedronsSet
,SphericalPolygonsSet
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.hipparchus.geometry.partitioning.Region
Region.Location
-
Constructor Summary
ModifierConstructorDescriptionprotected
AbstractRegion
(double tolerance) Build a region representing the whole space.protected
AbstractRegion
(Collection<SubHyperplane<S>> boundary, double tolerance) Build a Region from a Boundary REPresentation (B-rep).protected
AbstractRegion
(BSPTree<S> tree, double tolerance) Build a region from an inside/outside BSP tree.AbstractRegion
(Hyperplane<S>[] hyperplanes, double tolerance) Build a convex region from an array of bounding hyperplanes. -
Method Summary
Modifier and TypeMethodDescriptionapplyTransform
(Transform<S, T> transform) Transform a region.abstract AbstractRegion<S,
T> Build a region using the instance as a prototype.protected Region.Location
checkPoint
(BSPTree<S> node, Point<S> point) Check a point with respect to the region starting at a given node.protected <V extends Vector<S,
V>>
Region.LocationcheckPoint
(BSPTree<S> node, Vector<S, V> point) Check a point with respect to the region starting at a given node.checkPoint
(Point<S> point) Check a point with respect to the region.<V extends Vector<S,
V>>
Region.LocationcheckPoint
(Vector<S, V> point) Check a point with respect to the region.protected abstract void
Compute some geometrical properties.boolean
Check if the instance entirely contains another region.copySelf()
Copy the instance.Get the barycenter of the instance.double
Get the size of the boundary.double
getSize()
Get the size of the instance.double
Get the tolerance below which points are considered to belong to hyperplanes.getTree
(boolean includeBoundaryAttributes) Get the underlying BSP tree.intersection
(SubHyperplane<S> sub) Get the parts of a sub-hyperplane that are contained in the region.boolean
isEmpty()
Check if the instance is empty.boolean
Check if the sub-tree starting at a given node is empty.boolean
isFull()
Check if the instance covers the full space.boolean
Check if the sub-tree starting at a given node covers the full space.projectToBoundary
(Point<S> point) Project a point on the boundary of the region.protected void
setBarycenter
(Point<S> barycenter) Set the barycenter of the instance.setBarycenter
(Vector<S, V> barycenter) Set the barycenter of the instance.protected void
setSize
(double size) Set the size of the instance.
-
Constructor Details
-
AbstractRegion
protected AbstractRegion(double tolerance) Build a region representing the whole space.- Parameters:
tolerance
- tolerance below which points are considered identical.
-
AbstractRegion
Build a region from an inside/outside BSP tree.The leaf nodes of the BSP tree must have a
Boolean
attribute representing the inside status of the corresponding cell (true for inside cells, false for outside cells). In order to avoid building too many small objects, it is recommended to use the predefined constantsBoolean.TRUE
andBoolean.FALSE
. The tree also must have either null internal nodes or internal nodes representing the boundary as specified in thegetTree
method).- Parameters:
tree
- inside/outside BSP tree representing the regiontolerance
- tolerance below which points are considered identical.
-
AbstractRegion
Build a Region from a Boundary REPresentation (B-rep).The boundary is provided as a collection of
sub-hyperplanes
. Each sub-hyperplane has the interior part of the region on its minus side and the exterior on its plus side.The boundary elements can be in any order, and can form several non-connected sets (like for example polygons with holes or a set of disjoints polyhedrons considered as a whole). In fact, the elements do not even need to be connected together (their topological connections are not used here). However, if the boundary does not really separate an inside open from an outside open (open having here its topological meaning), then subsequent calls to the
checkPoint
method will not be meaningful anymore.If the boundary is empty, the region will represent the whole space.
- Parameters:
boundary
- collection of boundary elements, as a collection ofSubHyperplane
objectstolerance
- tolerance below which points are considered identical.
-
AbstractRegion
Build a convex region from an array of bounding hyperplanes.- Parameters:
hyperplanes
- array of bounding hyperplanes (if null, an empty region will be built)tolerance
- tolerance below which points are considered identical.
-
-
Method Details
-
buildNew
Build a region using the instance as a prototype.This method allow to create new instances without knowing exactly the type of the region. It is an application of the prototype design pattern.
The leaf nodes of the BSP tree must have a
Boolean
attribute representing the inside status of the corresponding cell (true for inside cells, false for outside cells). In order to avoid building too many small objects, it is recommended to use the predefined constantsBoolean.TRUE
andBoolean.FALSE
. The tree also must have either null internal nodes or internal nodes representing the boundary as specified in thegetTree
method). -
getTolerance
public double getTolerance()Get the tolerance below which points are considered to belong to hyperplanes.- Returns:
- tolerance below which points are considered to belong to hyperplanes
-
copySelf
Copy the instance.The instance created is completely independant of the original one. A deep copy is used, none of the underlying objects are shared (except for the underlying tree
Boolean
attributes and immutable objects). -
isEmpty
public boolean isEmpty()Check if the instance is empty. -
isEmpty
Check if the sub-tree starting at a given node is empty. -
isFull
public boolean isFull()Check if the instance covers the full space. -
isFull
Check if the sub-tree starting at a given node covers the full space.- Specified by:
isFull
in interfaceRegion<S extends Space>
- Parameters:
node
- root node of the sub-tree (must haveRegion
tree semantics, i.e. the leaf nodes must haveBoolean
attributes representing an inside/outside property)- Returns:
- true if the sub-tree starting at the given node covers the full space
-
contains
Check if the instance entirely contains another region. -
projectToBoundary
Project a point on the boundary of the region.- Specified by:
projectToBoundary
in interfaceRegion<S extends Space>
- Parameters:
point
- point to check- Returns:
- projection of the point on the boundary
-
checkPoint
Check a point with respect to the region.- Type Parameters:
V
- type of vector implementing Vector interface- Parameters:
point
- point to check- Returns:
- a code representing the point status: either
Region.Location.INSIDE
,Region.Location.OUTSIDE
orRegion.Location.BOUNDARY
-
checkPoint
Check a point with respect to the region.- Specified by:
checkPoint
in interfaceRegion<S extends Space>
- Parameters:
point
- point to check- Returns:
- a code representing the point status: either
Region.Location.INSIDE
,Region.Location.OUTSIDE
orRegion.Location.BOUNDARY
-
checkPoint
Check a point with respect to the region starting at a given node. -
checkPoint
Check a point with respect to the region starting at a given node. -
getTree
Get the underlying BSP tree.Regions are represented by an underlying inside/outside BSP tree whose leaf attributes are
Boolean
instances representing inside leaf cells if the attribute value istrue
and outside leaf cells if the attribute isfalse
. These leaf attributes are always present and guaranteed to be non null.In addition to the leaf attributes, the internal nodes which correspond to cells split by cut sub-hyperplanes may contain
BoundaryAttribute
objects representing the parts of the corresponding cut sub-hyperplane that belong to the boundary. When the boundary attributes have been computed, all internal nodes are guaranteed to have non-null attributes, however someBoundaryAttribute
instances may have theirgetPlusInside
andgetPlusOutside
methods both returning null if the corresponding cut sub-hyperplane does not have any parts belonging to the boundary.Since computing the boundary is not always required and can be time-consuming for large trees, these internal nodes attributes are computed using lazy evaluation only when required by setting the
includeBoundaryAttributes
argument totrue
. Once computed, these attributes remain in the tree, which implies that in this case, further calls to the method for the same region will always include these attributes regardless of the value of theincludeBoundaryAttributes
argument.- Specified by:
getTree
in interfaceRegion<S extends Space>
- Parameters:
includeBoundaryAttributes
- if true, the boundary attributes at internal nodes are guaranteed to be included (they may be included even if the argument is false, if they have already been computed due to a previous call)- Returns:
- underlying BSP tree
- See Also:
-
getBoundarySize
public double getBoundarySize()Get the size of the boundary.- Specified by:
getBoundarySize
in interfaceRegion<S extends Space>
- Returns:
- the size of the boundary (this is 0 in 1D, a length in 2D, an area in 3D ...)
-
getSize
public double getSize()Get the size of the instance. -
setSize
protected void setSize(double size) Set the size of the instance.- Parameters:
size
- size of the instance
-
getBarycenter
Get the barycenter of the instance.- Specified by:
getBarycenter
in interfaceRegion<S extends Space>
- Returns:
- an object representing the barycenter
-
setBarycenter
Set the barycenter of the instance.- Type Parameters:
V
- type of vector implementing Vector interface- Parameters:
barycenter
- barycenter of the instance
-
setBarycenter
Set the barycenter of the instance.- Parameters:
barycenter
- barycenter of the instance
-
computeGeometricalProperties
protected abstract void computeGeometricalProperties()Compute some geometrical properties.The properties to compute are the barycenter and the size.
-
intersection
Get the parts of a sub-hyperplane that are contained in the region.The parts of the sub-hyperplane that belong to the boundary are not included in the resulting parts.
- Specified by:
intersection
in interfaceRegion<S extends Space>
- Parameters:
sub
- sub-hyperplane traversing the region- Returns:
- filtered sub-hyperplane
-
applyTransform
Transform a region.Applying a transform to a region consist in applying the transform to all the hyperplanes of the underlying BSP tree and of the boundary (and also to the sub-hyperplanes embedded in these hyperplanes) and to the barycenter. The instance is not modified, a new instance is built.
- Parameters:
transform
- transform to apply- Returns:
- a new region, resulting from the application of the transform to the instance
-