Class BoundaryAttribute<S extends Space>
java.lang.Object
org.apache.commons.math3.geometry.partitioning.BoundaryAttribute<S>
- Type Parameters:
S
- Type of the space.
Class holding boundary attributes.
This class is used for the attributes associated with the
nodes of region boundary shell trees returned by the Region.getTree(includeBoundaryAttributes)
when the boolean includeBoundaryAttributes
parameter is
set to true
. It contains the parts of the node cut
sub-hyperplane that belong to the boundary.
This class is a simple placeholder, it does not provide any processing methods.
- Since:
- 3.0
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final SubHyperplane
<S> Part of the node cut sub-hyperplane that belongs to the boundary and has the inside of the region on the plus side of its underlying hyperplane (may be null).private final SubHyperplane
<S> Part of the node cut sub-hyperplane that belongs to the boundary and has the outside of the region on the plus side of its underlying hyperplane (may be null).Sub-hyperplanes that were used to split the boundary part. -
Constructor Summary
ConstructorsConstructorDescriptionBoundaryAttribute
(SubHyperplane<S> plusOutside, SubHyperplane<S> plusInside) Deprecated.BoundaryAttribute
(SubHyperplane<S> plusOutside, SubHyperplane<S> plusInside, NodesSet<S> splitters) Simple constructor. -
Method Summary
Modifier and TypeMethodDescriptionGet the part of the node cut sub-hyperplane that belongs to the boundary and has the inside of the region on the plus side of its underlying hyperplane.Get the part of the node cut sub-hyperplane that belongs to the boundary and has the outside of the region on the plus side of its underlying hyperplane.Get the sub-hyperplanes that were used to split the boundary part.
-
Field Details
-
plusOutside
Part of the node cut sub-hyperplane that belongs to the boundary and has the outside of the region on the plus side of its underlying hyperplane (may be null). -
plusInside
Part of the node cut sub-hyperplane that belongs to the boundary and has the inside of the region on the plus side of its underlying hyperplane (may be null). -
splitters
Sub-hyperplanes that were used to split the boundary part.
-
-
Constructor Details
-
BoundaryAttribute
Deprecated.as of 3.4, the constructor has been replaced by a new one which is not public anymore, as it is intended to be used only byBoundaryBuilder
Simple constructor.- Parameters:
plusOutside
- part of the node cut sub-hyperplane that belongs to the boundary and has the outside of the region on the plus side of its underlying hyperplane (may be null)plusInside
- part of the node cut sub-hyperplane that belongs to the boundary and has the inside of the region on the plus side of its underlying hyperplane (may be null)
-
BoundaryAttribute
BoundaryAttribute(SubHyperplane<S> plusOutside, SubHyperplane<S> plusInside, NodesSet<S> splitters) Simple constructor.- Parameters:
plusOutside
- part of the node cut sub-hyperplane that belongs to the boundary and has the outside of the region on the plus side of its underlying hyperplane (may be null)plusInside
- part of the node cut sub-hyperplane that belongs to the boundary and has the inside of the region on the plus side of its underlying hyperplane (may be null)splitters
- sub-hyperplanes that were used to split the boundary part (may be null)- Since:
- 3.4
-
-
Method Details
-
getPlusOutside
Get the part of the node cut sub-hyperplane that belongs to the boundary and has the outside of the region on the plus side of its underlying hyperplane.- Returns:
- part of the node cut sub-hyperplane that belongs to the boundary and has the outside of the region on the plus side of its underlying hyperplane
-
getPlusInside
Get the part of the node cut sub-hyperplane that belongs to the boundary and has the inside of the region on the plus side of its underlying hyperplane.- Returns:
- part of the node cut sub-hyperplane that belongs to the boundary and has the inside of the region on the plus side of its underlying hyperplane
-
getSplitters
Get the sub-hyperplanes that were used to split the boundary part.- Returns:
- sub-hyperplanes that were used to split the boundary part
-
BoundaryBuilder