org.tinfour.common

Class PolyLineConstraintAdapter

java.lang.Object

org.tinfour.common.PolyLineConstraintAdapter

All Implemented Interfaces:

Iterable<Vertex>, IConstraint, IPolyline

Direct Known Subclasses:

LinearConstraint, PolygonConstraint

public abstract class PolyLineConstraintAdapter
extends Object
implements IConstraint, Iterable<Vertex>

An implementation of the IConstraint interface intended to store constraints comprised of a chain of connected line segments. Constraint chains must be non-self-intersecting (except at segment endpoints). The chain must never "fold back" on itself. All segments in the chain must be non-zero-length. Do not use this class for closed polygons.

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	applicationData
protected int	constraintIndex
protected IQuadEdge	constraintLinkingEdge
protected boolean	isComplete
protected double	length
protected List<Vertex>	list
protected IIncrementalTin	maintainingTin

Method Summary

Modifier and Type	Method and Description
void	add(Vertex v) Adds a vertex to the polyline feature.
Object	getApplicationData() Gets the application data (if any) stored in the constraint.
Rectangle2D	getBounds() Gets the bounds of the feature.
int	getConstraintIndex() Gets an index value used for internal bookkeeping by Tinfour code.
IQuadEdge	getConstraintLinkingEdge()
double	getLength() Gets the total length of the feature.
IIncrementalTin	getManagingTin() Gets the instance of the incremental TIN interface that is managing this constraint, if any.
List<Vertex>	getVertices() Gets the vertices for this feature.
boolean	isPointInsideConstraint(double x, double y) Indicates if a point at the specified coordinates is unambiguously inside the constraint.
Iterator<Vertex>	iterator()
void	setApplicationData(Object applicationData) Permits an application to add data elements to the constraint for its own uses.
void	setConstraintIndex(IIncrementalTin tin, int index) Sets an index value used for internal bookkeeping by Tinfour code; not intended for use by application code.
void	setConstraintLinkingEdge(IQuadEdge edge) Sets a reference to an arbitrarily selected edge that was produced when the constraint was added to a TIN.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tinfour.common.IConstraint

definesConstrainedRegion, getConstraintWithNewGeometry, getPath2D

Methods inherited from interface org.tinfour.common.IPolyline

complete, getNominalPointSpacing, isPolygon, isValid, refactor

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

list

protected final List<Vertex> list

applicationData

protected Object applicationData

constraintIndex

protected int constraintIndex

constraintLinkingEdge

protected IQuadEdge constraintLinkingEdge

maintainingTin

protected IIncrementalTin maintainingTin

isComplete

protected boolean isComplete

length

protected double length

Method Detail

getVertices

public List<Vertex> getVertices()

Description copied from interface: IPolyline

Gets the vertices for this feature. The vertices define a non-self-intersecting chain of line segments (that is, no line segments intersect except at their endpoints). The vertices are assumed to be unique and far enough apart that they are stable in numeric operations.

Specified by:

getVertices in interface IPolyline

Returns:

a valid list of two or more unique vertices.

add

public final void add(Vertex v)

Description copied from interface: IPolyline

Adds a vertex to the polyline feature. Implementations of this interface are expected to ensure that all vertices are unique and that no vertices are repeated.

Specified by:

add in interface IPolyline

Parameters:

v - a valid instance

getBounds

public Rectangle2D getBounds()

Description copied from interface: IPolyline

Gets the bounds of the feature.

Caution: Implementations of this method expose the Rectangle2D object used by the feature instance. Although this approach supports efficiency for the potentially intense processing conducted by the Tinfour classes, it does not provide a safe implementation for careless developers. Therefore, applications should not manipulate or modify the rectangle instance returned by this routine at any time.

Specified by:

getBounds in interface IPolyline

Returns:

a valid, potentially empty rectangle instance.

setApplicationData

public void setApplicationData(Object applicationData)

Description copied from interface: IConstraint

Permits an application to add data elements to the constraint for its own uses. The reference stored in this instance is not accessed by the Tinfour classes.

Specified by:

setApplicationData in interface IConstraint

Parameters:

applicationData - an object or null according to the needs of the calling application.

getApplicationData

public Object getApplicationData()

Description copied from interface: IConstraint

Gets the application data (if any) stored in the constraint. The reference stored in this instance is not accessed by the Tinfour classes.

Specified by:

getApplicationData in interface IConstraint

Returns:

an object or null according to the needs of the calling application.

setConstraintIndex

public void setConstraintIndex(IIncrementalTin tin,
                               int index)

Description copied from interface: IConstraint

Sets an index value used for internal bookkeeping by Tinfour code; not intended for use by application code. Application code that sets a constraint index runs the risk of damaging the internal data relations maintained by Tinfour.

Specified by:

setConstraintIndex in interface IConstraint

Parameters:

tin - the IIncrementalTin instance to while this constraint has been added (or null if not applicable).

index - a positive integer.

getConstraintIndex

public int getConstraintIndex()

Description copied from interface: IConstraint

Gets an index value used for internal bookkeeping by Tinfour code. The index value is assigned to a constraint when it is inserted into a Tinfour IIncrementalTin implementation. If an application used a getConstraints() call to get a list of the constraints stored in an IIncrementalTin, the constraint index can be used to get the constraint from that list.

Specified by:

getConstraintIndex in interface IConstraint

Returns:

the index of the constraint associated with the edge; undefined if the edge is not constrained or an interior member of a constrained region.

getLength

public double getLength()

Description copied from interface: IPolyline

Gets the total length of the feature. The length is the accumulated sum of the lengths of the line segments that comprise the feature. In the case of a closed polygon feature, the length is the perimeter of the polygon.

Specified by:

getLength in interface IPolyline

Returns:

if the feature geometry is defined, a positive floating point value, otherwise a zero.

iterator

public Iterator<Vertex> iterator()

Specified by:

iterator in interface Iterable<Vertex>

getConstraintLinkingEdge

public IQuadEdge getConstraintLinkingEdge()

Specified by:

getConstraintLinkingEdge in interface IConstraint

setConstraintLinkingEdge

public void setConstraintLinkingEdge(IQuadEdge edge)

Description copied from interface: IConstraint

Sets a reference to an arbitrarily selected edge that was produced when the constraint was added to a TIN. In effect, this reference links the constraint to the TIN. In the case of constraints that define a constrained region, the edge will be the interior side of the edge.

This method is not intended for use by application code. Application code that sets a constraint index runs the risk of damaging the internal data relations maintained by Tinfour.

Specified by:

setConstraintLinkingEdge in interface IConstraint

Parameters:

edge - a valid edge reference

getManagingTin

public IIncrementalTin getManagingTin()

Description copied from interface: IConstraint

Gets the instance of the incremental TIN interface that is managing this constraint, if any.

Specified by:

getManagingTin in interface IConstraint

Returns:

if under management, a valid instance; otherwise, a null.

isPointInsideConstraint

public boolean isPointInsideConstraint(double x,
                                       double y)

Description copied from interface: IConstraint

Indicates if a point at the specified coordinates is unambiguously inside the constraint. Points on the constraint border are not treated as inside the constraint.

This method will only return true for polygon constraints. For all other constraint implementations, it will return a value of false.

Specified by:

isPointInsideConstraint in interface IConstraint

Parameters:

x - the Cartesian coordinate for the point

y - the Cartesian coordinate for the point

Returns:

true if the point is in the interior of the constraint.