org.apache.commons.geometry.euclidean.twod

Class EmbeddedTreeLineSubset

java.lang.Object

org.apache.commons.geometry.euclidean.twod.LineSubset

org.apache.commons.geometry.euclidean.twod.EmbeddedTreeLineSubset

All Implemented Interfaces:

Embedding<Vector2D,Vector1D>, HyperplaneSubset<Vector2D>, Splittable<Vector2D,HyperplaneSubset<Vector2D>>, RegionEmbedding<Vector2D,Vector1D>, Sized

public final class EmbeddedTreeLineSubset
extends LineSubset

Class representing an arbitrary subset of a line using a RegionBSPTree1D. This class can represent convex, non-convex, finite, infinite, and empty regions.

This class is mutable and not thread safe.

Constructor Summary

Constructors

Constructor and Description
EmbeddedTreeLineSubset(Line line) Construct a new, empty subset for the given line.
EmbeddedTreeLineSubset(Line line, boolean full) Construct a new subset for the given line.
EmbeddedTreeLineSubset(Line line, RegionBSPTree1D region) Construct a new instance from its defining line and subspace region.

Method Summary

Modifier and Type	Method and Description
void	add(EmbeddedTreeLineSubset subset) Add the region represented by the given line subset to this instance.
void	add(LineConvexSubset subset) Add a line subset to this instance.
Vector2D	closest(Vector2D pt)
Bounds2D	getBounds() Get a Bounds2D object defining an axis-aligned bounding box containing all vertices for this subset.
Vector2D	getCentroid()
double	getSize()
RegionBSPTree1D	getSubspaceRegion()
boolean	isEmpty()
boolean	isFull()
Split<EmbeddedTreeLineSubset>	split(Hyperplane<Vector2D> splitter)
List<LineConvexSubset>	toConvex()
String	toString()
EmbeddedTreeLineSubset	transform(Transform<Vector2D> transform)

Methods inherited from class org.apache.commons.geometry.euclidean.twod.LineSubset

classify, getHyperplane, getLine, getPrecision, intersection, intersection, toSpace, toSubspace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

contains

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

isFinite, isInfinite

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

toSpace, toSubspace

Constructor Detail

EmbeddedTreeLineSubset

public EmbeddedTreeLineSubset(Line line)

Construct a new, empty subset for the given line.

Parameters:

line - line defining the subset

EmbeddedTreeLineSubset

public EmbeddedTreeLineSubset(Line line,
                              boolean full)

Construct a new subset for the given line. If full is true, then the subset will cover the entire line; otherwise, it will be empty.

Parameters:

line - line defining the subset

full - if true, the subset will cover the entire space; otherwise it will be empty

EmbeddedTreeLineSubset

public EmbeddedTreeLineSubset(Line line,
                              RegionBSPTree1D region)

Construct a new instance from its defining line and subspace region. The give BSP tree is used directly by this instance; it is not copied.

Parameters:

line - line defining the subset

region - subspace region for the instance

Method Detail

isFull

public boolean isFull()

isEmpty

public boolean isEmpty()

getSize

public double getSize()

getCentroid

public Vector2D getCentroid()

getBounds

public Bounds2D getBounds()

Get a Bounds2D object defining an axis-aligned bounding box containing all vertices for this subset. Null is returned if the subset is infinite or does not contain any vertices.

Specified by:

getBounds in class LineSubset

Returns:

the bounding box for this instance or null if no valid bounds could be determined

closest

public Vector2D closest(Vector2D pt)

transform

public EmbeddedTreeLineSubset transform(Transform<Vector2D> transform)

toConvex

public List<LineConvexSubset> toConvex()

Specified by:

toConvex in interface HyperplaneSubset<Vector2D>

Specified by:

toConvex in class LineSubset

getSubspaceRegion

public RegionBSPTree1D getSubspaceRegion()

Specified by:

getSubspaceRegion in interface RegionEmbedding<Vector2D,Vector1D>

Specified by:

getSubspaceRegion in class LineSubset

split

public Split<EmbeddedTreeLineSubset> split(Hyperplane<Vector2D> splitter)

In all cases, the current instance is not modified. However, In order to avoid unnecessary copying, this method will use the current instance as the split value when the instance lies entirely on the plus or minus side of the splitter. For example, if this instance lies entirely on the minus side of the splitter, the subplane returned by Split.getMinus() will be this instance. Similarly, Split.getPlus() will return the current instance if it lies entirely on the plus side. Callers need to make special note of this, since this class is mutable.

add

public void add(LineConvexSubset subset)

Add a line subset to this instance.

Parameters:

subset - the line subset to add

Throws:

IllegalArgumentException - if the given line subset is not from a line equivalent to this instance

add

public void add(EmbeddedTreeLineSubset subset)

Add the region represented by the given line subset to this instance. The argument is not modified.

Parameters:

subset - line subset to add

Throws:

IllegalArgumentException - if the given line subset is not from a line equivalent to this instance

toString

public String toString()

Overrides:

toString in class Object