Package org.apache.commons.geometry.core.partitioning

Interface HyperplaneConvexSubset<P extends Point<P>>

Type Parameters:

P - Point implementation type

All Superinterfaces:

HyperplaneSubset<P>, Sized, Splittable<P,HyperplaneSubset<P>>

All Known Subinterfaces:

ConvexPolygon3D, PlaneConvexSubset, Triangle3D

All Known Implementing Classes:

AbstractConvexPolygon3D, CutAngle.CutAngleConvexSubset, EmbeddedAreaPlaneConvexSubset, GreatArc, LineConvexSubset, LineSpanningSubset, OrientedPoint.OrientedPointConvexSubset, Ray, ReverseRay, Segment, SimpleTriangle3D, VertexListConvexPolygon3D

public interface HyperplaneConvexSubset<P extends Point<P>>
extends HyperplaneSubset<P>

Extension of the HyperplaneSubset interface with the additional restriction that instances represent convex regions of space.

Method Summary

Modifier and Type	Method	Description
HyperplaneConvexSubset<P>	reverse()	Reverse the orientation of the hyperplane for this instance, returning the result as a new instance.
Split<? extends HyperplaneConvexSubset<P>>	split(Hyperplane<P> splitter)	Split this instance with the given hyperplane.
HyperplaneConvexSubset<P>	transform(Transform<P> transform)	Return a new hyperplane subset resulting from the application of the given transform.

Methods inherited from interface org.apache.commons.geometry.core.partitioning.HyperplaneSubset

classify, closest, contains, getCentroid, getHyperplane, isEmpty, isFull, toConvex

Methods inherited from interface org.apache.commons.geometry.core.Sized

getSize, isFinite, isInfinite

Method Details

reverse

HyperplaneConvexSubset<P> reverse()

Reverse the orientation of the hyperplane for this instance, returning the result as a new instance. The returned subset contains the same points but has a reversed orientation.

Returns:

a hyperplane convex subset representing the same region but with the opposite orientation.

split

Split<? extends HyperplaneConvexSubset<P>> split(Hyperplane<P> splitter)

Split this instance with the given hyperplane.

The parts resulting from a split operation with a convex subset are guaranteed to also be convex.

Specified by:

split in interface Splittable<P extends Point<P>,HyperplaneSubset<P extends Point<P>>>

Parameters:

splitter - the hyperplane to split this object with.

Returns:

result of the split operation

transform

HyperplaneConvexSubset<P> transform(Transform<P> transform)

Return a new hyperplane subset resulting from the application of the given transform. The current instance is not modified.

Hyperplane convex subsets subjected to affine transformations remain convex.

Specified by:

transform in interface HyperplaneSubset<P extends Point<P>>

Parameters:

transform - the transform instance to apply

Returns:

new transformed hyperplane subset