XyLineSegment

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.partnersoft.geometry.xy
Class XyLineSegment

java.lang.Object
  com.partnersoft.geometry.xy.XyLineSegment

All Implemented Interfaces:: Immutable, XyPath<XyLineSegment>, XyShape<XyLineSegment>, java.lang.Iterable<XyPoint>

public class XyLineSegment
extends java.lang.Object
implements XyPath<XyLineSegment>
extends java.lang.Object
implements XyPath<XyLineSegment>

A line segment in (x, y) space. Has an explicit start and end point.

Version:: $Id: XyLineSegment.java 2474 2010-03-13 14:28:43Z paul $
Author:: Paul Reavis

Constructor Summary
`XyLineSegment(double startX, double startY, double endX, double endY)` Create a new line segment with the given starting and ending coordinates.
`XyLineSegment(XyPoint start, XyPoint end)` Create a new line segment starting and ending at the given points.

Method Summary
`XyLineSegment`	`clippedTo(XyBounds bounds)` Clip this line to the given bounds.
`XyPoint`	`closestPointTo(XyPoint nother)` Solves for the closest point to the segment.
`XyBounds`	`getBounds()` Returns an XyBounds object representing the rectangular extents of this shape.
`XyPoint`	`getCenterPoint()` Returns the midpoint, or center, of the segment.
`XyDirection`	`getDirection()` Returns the direction of the line segment, treating it as a vector from start to end.
`XyPoint`	`getEndPoint()` Returns the last point in the shape.
`double`	`getLength()` Returns the length of the path.
`XyLine`	`getLine()` The line this is a segment of.
`XyPoint`	`getStartPoint()` Returns the first point in the shape.
`java.util.Iterator<XyPoint>`	`iterator()`
`XyLineSegment`	`scaledBy(double factor)` Return a scaled version of the shape by multiplying all coordinates by the given factor in both dimensions.
`java.util.List<XyPoint>`	`splitAtIntervals(double... intervals)` Returns a list of points, determined by splitting this segment up using the sequence of intervals given.
`XyPolyline`	`toPolyline()` Same as `XyPath.toPolyline(XyAngle)` with a default angle granularity of 1/60 circle (6 degrees, pi/30 radians).
`XyPolyline`	`toPolyline(XyAngle granularity)` Converts this area to a polyline which approximates it in some fashion.
`XyVector`	`toVector()` Returns the vector equivalent for this line segment.
`XyShape`	`transformedBy(XyTransform transform)` Transform the shape using the given transform.
`XyLineSegment`	`translatedBy(double offsetX, double offsetY)` Translate the shape by adding all coordinates to the given x and y offsets.
`XyLineSegment`	`withEndPoint(XyPoint newEnd)` Returns a modified version of this line segment with the given end point.
`XyLineSegment`	`withStartPoint(XyPoint newStart)` Returns a modified version of this line segment with the given start point.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

XyLineSegment

public XyLineSegment(XyPoint start,
                     XyPoint end)

Create a new line segment starting and ending at the given points.

XyLineSegment

public XyLineSegment(double startX,
                     double startY,
                     double endX,
                     double endY)

Create a new line segment with the given starting and ending coordinates.

Method Detail

withStartPoint

public XyLineSegment withStartPoint(XyPoint newStart)

Returns a modified version of this line segment with the given start point.

withEndPoint

public XyLineSegment withEndPoint(XyPoint newEnd)

Returns a modified version of this line segment with the given end point.

toVector

public XyVector toVector()

Returns the vector equivalent for this line segment. The vector is generated by subtracting the starting coordinates from the end coordinates.

closestPointTo

public XyPoint closestPointTo(XyPoint nother)

Solves for the closest point to the segment. This is either the perpendicular to the line the segment is part of (if the perpendicular is between the endpoints) or one of the endpoints (if not).

splitAtIntervals

public java.util.List<XyPoint> splitAtIntervals(double... intervals)

Returns a list of points, determined by splitting this segment up using the sequence of intervals given. These intervals will be repeated as needed for the length of the line. The results include the start and end of the segment and are appropriate for creating a polyline.

clippedTo

public XyLineSegment clippedTo(XyBounds bounds)

Clip this line to the given bounds. Returns null if the line does not intersect the bounds.