Top Description Constructors Methods
org.apache.commons.math3.geometry.euclidean.threed

public Class SubPlane

extends AbstractSubHyperplane<Euclidean3D, Euclidean2D>
Class Inheritance
Imports
org.apache.commons.math3.geometry.Point, org.apache.commons.math3.geometry.euclidean.oned.Euclidean1D, .Vector1D, org.apache.commons.math3.geometry.euclidean.twod.Euclidean2D, .PolygonsSet, .Vector2D, org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane, .BSPTree, .Hyperplane, .Region, .SubHyperplane
This class represents a sub-hyperplane for Plane.
Since
3.0

Constructor Summary

AccessConstructor and Description
public
SubPlane(final Hyperplane<Euclidean3D>
underlying hyperplane
hyperplane, final Region<Euclidean2D>
remaining region of the hyperplane
remainingRegion)

Simple constructor.

Method Summary

Modifier and TypeMethod and Description
protected AbstractSubHyperplane<Euclidean3D, Euclidean2D>
buildNew(final Hyperplane<Euclidean3D>
underlying hyperplane
hyperplane, final Region<Euclidean2D>
remaining region of the hyperplane
remainingRegion)

Implements abstract org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane.buildNew.

Build a sub-hyperplane from an hyperplane and a region.

public SubHyperplane.SplitSubHyperplane<Euclidean3D>

Returns:

an object containing both the part of the instance on the plus side of the instance and the part of the instance on the minus side of the instance
split(Hyperplane<Euclidean3D>
splitting hyperplane
hyperplane)

Implements abstract org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane.split.

Implements org.apache.commons.math3.geometry.partitioning.SubHyperplane.split.

Split the instance in two parts by an hyperplane.

Inherited from org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane:
applyTransformcopySelfgetHyperplanegetRemainingRegiongetSizeisEmptyreuniteside

Constructor Detail

SubPlaneback to summary
public SubPlane(final Hyperplane<Euclidean3D> hyperplane, final Region<Euclidean2D> remainingRegion)

Simple constructor.

Parameters
hyperplane:Hyperplane<Euclidean3D>

underlying hyperplane

remainingRegion:Region<Euclidean2D>

remaining region of the hyperplane

Method Detail

buildNewback to summary
protected AbstractSubHyperplane<Euclidean3D, Euclidean2D> buildNew(final Hyperplane<Euclidean3D> hyperplane, final Region<Euclidean2D> remainingRegion)

Implements abstract org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane.buildNew.

Doc from org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane.buildNew.

Build a sub-hyperplane from an hyperplane and a region.

Parameters
hyperplane:Hyperplane<Euclidean3D>

underlying hyperplane

remainingRegion:Region<Euclidean2D>

remaining region of the hyperplane

Returns:AbstractSubHyperplane<Euclidean3D, Euclidean2D>

a new sub-hyperplane

Annotations
@Override
splitback to summary
public SubHyperplane.SplitSubHyperplane<Euclidean3D> split(Hyperplane<Euclidean3D> hyperplane)

Implements abstract org.apache.commons.math3.geometry.partitioning.AbstractSubHyperplane.split.

Implements org.apache.commons.math3.geometry.partitioning.SubHyperplane.split.

Split the instance in two parts by an hyperplane.

Parameters
hyperplane:Hyperplane<Euclidean3D>

splitting hyperplane

Returns:SubHyperplane.SplitSubHyperplane<Euclidean3D>

an object containing both the part of the instance on the plus side of the instance and the part of the instance on the minus side of the instance

Annotations
@Override