org.apache.commons.geometry.euclidean.twod.path

Class AbstractLinePathConnector

java.lang.Object

org.apache.commons.geometry.euclidean.internal.AbstractPathConnector<AbstractLinePathConnector.ConnectableLineSubset>

org.apache.commons.geometry.euclidean.twod.path.AbstractLinePathConnector

Direct Known Subclasses:

InteriorAngleLinePathConnector

public abstract class AbstractLinePathConnector
extends AbstractPathConnector<AbstractLinePathConnector.ConnectableLineSubset>

Abstract class for joining collections of line subsets into connected paths. This class is not thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractLinePathConnector.ConnectableLineSubset Internal class used to connect line subsets together.

Nested classes/interfaces inherited from class org.apache.commons.geometry.euclidean.internal.AbstractPathConnector

AbstractPathConnector.ConnectableElement<E extends AbstractPathConnector.ConnectableElement<E>>

Constructor Summary

Constructors

Constructor and Description
AbstractLinePathConnector()

Method Summary

Modifier and Type	Method and Description
void	add(Iterable<? extends LineConvexSubset> subsets) Add a collection of line subsets to the connector, leaving them unconnected until a later call to connect(Iterable) or connectAll().
void	add(LineConvexSubset subset) Add a line subset to the connector, leaving it unconnected until a later call to to connect(Iterable) or connectAll().
void	connect(Iterable<? extends LineConvexSubset> subsets) Add a collection of line subsets to the connector and attempt to connect each new line subset with existing subsets.
List<LinePath>	connectAll() Connect all current line subsets into connected paths, returning the result as a list of line paths.
List<LinePath>	connectAll(Iterable<LineConvexSubset> subsets) Add the given line subsets to this instance and connect all current subsets into connected paths.

Methods inherited from class org.apache.commons.geometry.euclidean.internal.AbstractPathConnector

addPathElement, computePathRoots, connectPathElements, selectConnection, selectPointConnection

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractLinePathConnector

public AbstractLinePathConnector()

Method Detail

add

public void add(LineConvexSubset subset)

Add a line subset to the connector, leaving it unconnected until a later call to to connect(Iterable) or connectAll().

Parameters:

subset - line subset to add

See Also:

connect(Iterable), connectAll()

add

public void add(Iterable<? extends LineConvexSubset> subsets)

Add a collection of line subsets to the connector, leaving them unconnected until a later call to connect(Iterable) or connectAll().

Parameters:

subsets - line subsets to add

See Also:

connect(Iterable), connectAll(), add(LineConvexSubset)

connect

public void connect(Iterable<? extends LineConvexSubset> subsets)

Add a collection of line subsets to the connector and attempt to connect each new line subset with existing subsets. Connections made at this time will not be overwritten by subsequent calls to this or other connection methods. (eg, connectAll()).

The connector is not reset by this call. Additional line subsets can still be added to the current set of paths.

Parameters:

subsets - line subsets to connect

See Also:

connectAll()

connectAll

public List<LinePath> connectAll(Iterable<LineConvexSubset> subsets)

Add the given line subsets to this instance and connect all current subsets into connected paths. This call is equivalent to

      connector.add(subsets);
      List<LinePath> result = connector.connectAll();
 

The connector is reset after this call. Further calls to add or connect line subsets will result in new paths being generated.

Parameters:

subsets - line subsets to add

Returns:

the connected 2D paths

See Also:

add(Iterable), connectAll()

connectAll

public List<LinePath> connectAll()

Connect all current line subsets into connected paths, returning the result as a list of line paths.

The connector is reset after this call. Further calls to add or connect line subsets will result in new paths being generated.

Returns:

the connected 2D paths