LineSegment

java.lang.Object
- geomss.geom.AbstractGeomElement<T>
- - geomss.geom.AbstractCurve<LineSegment>
  - - geomss.geom.LineSegment

All Implemented Interfaces:

Curve<LineSegment>, GeomElement<LineSegment>, ParametricGeometry<LineSegment>, PointGeometry<LineSegment>, Transformable<LineSegment>, j2me.io.Serializable, java.lang.Cloneable, java.lang.Comparable, javolution.lang.Reusable, javolution.xml.XMLSerializable

Direct Known Subclasses:

LineSeg, LineSegTrans
```
public abstract class LineSegment
extends AbstractCurve<LineSegment>
implements PointGeometry<LineSegment>
```
The interface and implementation in common to all line segments in n-dimensional space.
Modified by: Joseph A. Huwaldt

Version:

January 31, 2017

Author:

Joseph A. Huwaldt, Date: January 14, 2012

Field Summary
- Fields inherited from class geomss.geom.AbstractCurve
  GTOL
- Fields inherited from class geomss.geom.AbstractGeomElement
  RESOURCES

Constructor Summary

Constructors
Constructor and Description

LineSegment()

Constructors
Constructor and Description
`LineSegment()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`PointString<SubrangePoint>`	`extractGrid(GridRule gridRule, java.util.List<java.lang.Double> spacing)` Return a string of points that are gridded onto the curve using the specified spacing and gridding rule.
`Parameter<Length>`	`getArcLength(double s1, double s2, double eps)` Return the arc length of a segment of this curve.
`Parameter`	`getCurvature(double s)` Return the curvature (kappa = 1/rho; where rho = the radius of curvature) of the curve at the parametric position `s`.
`abstract GeomVector<Length>`	`getDerivativeVector()` Return the dimensional direction/derivative vector for this line segment.
`abstract GeomPoint`	`getEnd()` Return the end point of the line segment.
`SubrangePoint`	`getLimitPoint(int dim, boolean max, double tol)` Returns the most extreme point, either minimum or maximum, in the specified coordinate direction on this curve.
`int`	`getNumberOfPoints()` Return the total number of points in this geometry element.
`int`	`getPhyDimension()` Returns the number of physical dimensions of the geometry element.
`SubrangePoint`	`getPointAtArcLength(Parameter<Length> targetArcLength, double tol)` Return a subrange point at the position on the curve with the specified arc-length.
`abstract GeomPoint`	`getStart()` Return the starting point of the line segment.
`Parameter`	`getTorsion(double s)` Return the torsion of the curve at the parametric position `s`.
`LineSegTrans`	`getTransformed(GTransform transform)` Returns transformed version of this element.
`Unit<Length>`	`getUnit()` Returns the unit in which this curve is stated.
`abstract GeomVector<Dimensionless>`	`getUnitVector()` Get unit direction vector for the line segment.
`Parameter`	`getVariationOfCurvature(double s)` Return the variation of curvature or rate of change of curvature (VOC or dKappa(s)/ds) at the parametric position `s`.
`PointString<SubrangePoint>`	`gridToTolerance(Parameter<Length> tol)` Return a string of points that are gridded onto the curve with the number of points and spacing chosen to result in straight line segments between the points that have mid-points that are all within the specified tolerance of this curve.
`PointString<SubrangePoint>`	`intersect(GeomPlane plane, double tol)` Return the intersection between a plane and this curve.
`GeomList<PointString<SubrangePoint>>`	`intersect(LineSegment line, Parameter<Length> tol)` Return the intersection between a line segment and this curve.
`boolean`	`isCircular(Parameter<Length> tol)` Returns `true` if this curve is a circular arc to within the specified tolerance.
`boolean`	`isLine(Parameter<Length> tol)` Returns `true` if this curve is a line to within the specified tolerance.
`boolean`	`isPlanar(Parameter<Length> tol)` Return `true` if this curve is planar or `false` if it is not.
`boolean`	`isValid()` Return `true` if this LineSegment contains valid and finite numerical components.
`int`	`size()` Returns the number of child-elements that make up this geometry element.
`GeomList<LineSegment>`	`splitAt(double s)` Split this curve at the specified parametric position returning a list containing two curves (a lower curve with smaller parametric positions than "s" and an upper curve with larger parametric positions).
`abstract LineSegment`	`to(Unit<Length> unit)` Returns the equivalent to this LineSegment object but stated in the specified unit.
`NurbsCurve`	`toNurbs()` Return a NURBS curve representation of this line segment.
`NurbsCurve`	`toNurbs(Parameter<Length> tol)` Return a NURBS curve representation of this line segment.
`javolution.text.Text`	`toText()` Returns the text representation of this geometry element that consists of the name followed by the start and end points.

Methods inherited from class geomss.geom.AbstractCurve
getArcLength, getArcLength, getBinormal, getBinormal, getClosest, getClosest, getClosest, getClosest, getClosest, getClosest, getCurvature, getDerivatives, getEnclosedArea, getFarthest, getFarthest, getFarthest, getParDimension, getPoint, getPoint, getPrincipalNormal, getPrincipalNormal, getRealPoint, getSDerivative, getSDerivatives, getTangencyPoint, getTangent, getTangent, getTorsion, getVariationOfCurvature, intersect, intersect, intersect, isDegenerate, splitAt

Methods inherited from class geomss.geom.AbstractGeomElement
addChangeListener, clone, compareTo, equals, getAllUserData, getID, getName, getUserData, hashCode, putAllUserData, putUserData, removeChangeListener, removeUserData, reset, setName, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface geomss.geom.GeomElement
addChangeListener, copy, copyToReal, getAllUserData, getBoundsMax, getBoundsMin, getID, getName, getParDimension, getUserData, putAllUserData, putUserData, removeChangeListener, removeUserData, setName, toDimension

Methods inherited from interface java.lang.Comparable
compareTo

Methods inherited from interface geomss.geom.Curve
copy, copyToReal, getRealPoint, getSDerivatives, reverse, toDimension

- Constructor Detail
  - LineSegment
```
public LineSegment()
```
- Method Detail
  - getStart
```
public abstract GeomPoint getStart()
```
    Return the starting point of the line segment.
    
    Returns:
    
    The starting point for this line segment.
  - getEnd
```
public abstract GeomPoint getEnd()
```
    Return the end point of the line segment.
    
    Returns:
    
    The end point of this line segment.
  - getUnitVector
```
public abstract GeomVector<Dimensionless> getUnitVector()
```
    Get unit direction vector for the line segment.
    
    Returns:
    
    A unit vector indicating the direction of this line segment.
  - getDerivativeVector
```
public abstract GeomVector<Length> getDerivativeVector()
```
    Return the dimensional direction/derivative vector for this line segment. The length of this vector is the length of the line segment, the origin is at the start point and the end of the vector is the line end.
    
    Returns:
    
    The dimensional derivative vector for this line segment.
  - size
```
public int size()
```
    Returns the number of child-elements that make up this geometry element. This implementation always returns 2 as a LineSegment has two end points.
    
    Specified by:
    
    size in interface GeomElement<LineSegment>
    
    Returns:
    
    The number of points in this line segment (always returns 2).
  - getPhyDimension
```
public int getPhyDimension()
```
    Returns the number of physical dimensions of the geometry element.
    
    Specified by:
    
    getPhyDimension in interface GeomElement<LineSegment>
    
    Returns:
    
    The number of physical dimensions of this geometry element.
  - getNumberOfPoints
```
public int getNumberOfPoints()
```
    Return the total number of points in this geometry element.
    
    Specified by:
    
    getNumberOfPoints in interface PointGeometry<LineSegment>
    
    Returns:
    
    Always returns 2.
  - splitAt
```
public GeomList<LineSegment> splitAt(double s)
```
    Split this curve at the specified parametric position returning a list containing two curves (a lower curve with smaller parametric positions than "s" and an upper curve with larger parametric positions).
    
    Specified by:
    
    splitAt in interface Curve<LineSegment>
    
    Parameters:
    
    s - The parametric position where this curve should be split (must not be 0 or 1!).
    
    Returns:
    
    A list containing two curves: 0 == the lower curve, 1 == the upper curve.
  - getCurvature
```
public Parameter getCurvature(double s)
```
    Return the curvature (kappa = 1/rho; where rho = the radius of curvature) of the curve at the parametric position s. This implementation always returns zero.
    
    Specified by:
    
    getCurvature in interface Curve<LineSegment>
    
    Overrides:
    
    getCurvature in class AbstractCurve<LineSegment>
    
    Parameters:
    
    s - Parametric distance to calculate the curvature for (0.0 to 1.0 inclusive).
    
    Returns:
    
    The curvature of the curve at the specified parametric position in units of 1/Length.
  - getVariationOfCurvature
```
public Parameter getVariationOfCurvature(double s)
```
    Return the variation of curvature or rate of change of curvature (VOC or dKappa(s)/ds) at the parametric position s. The VOC for a line segment is always zero.
    
    Specified by:
    
    getVariationOfCurvature in interface Curve<LineSegment>
    
    Overrides:
    
    getVariationOfCurvature in class AbstractCurve<LineSegment>
    
    Parameters:
    
    s - Parametric distance to calculate the variation of curvature for (0.0 to 1.0 inclusive).
    
    Returns:
    
    The variation of curvature of the curve at the specified parametric position in units of 1/Length.
  - getTorsion
```
public Parameter getTorsion(double s)
```
    Return the torsion of the curve at the parametric position s. The torsion is a measure of the rotation or twist about the tangent vector. Torsion for a line segment is always zero.
    
    Specified by:
    
    getTorsion in interface Curve<LineSegment>
    
    Overrides:
    
    getTorsion in class AbstractCurve<LineSegment>
    
    Parameters:
    
    s - Parametric distance to calculate the torsion for (0.0 to 1.0 inclusive).
    
    Returns:
    
    The torsion of the curve at the specified parametric position in units of 1/Length.
  - getArcLength
```
public Parameter<Length> getArcLength(double s1,
                                      double s2,
                                      double eps)
```
    Return the arc length of a segment of this curve.
    
    Specified by:
    
    getArcLength in interface Curve<LineSegment>
    
    Overrides:
    
    getArcLength in class AbstractCurve<LineSegment>
    
    Parameters:
    
    s1 - The starting parametric distance along the curve to begin the arc-length calculation from.
    
    s2 - The ending parametric distance along the curve to end the arc-length calculation at.
    
    eps - The desired fractional accuracy on the arc-length. For this curve type, this parameter is ignored and the exact arc length is returned.
    
    Returns:
    
    The arc length of the specified segment of the curve.
  - getPointAtArcLength
```
public SubrangePoint getPointAtArcLength(Parameter<Length> targetArcLength,
                                         double tol)
```
    Return a subrange point at the position on the curve with the specified arc-length. If the requested arc-length is ≤ 0, the start of the curve is returned. If the requested arc length is > the total arc length of the curve, then the end point is returned.
    
    Specified by:
    
    getPointAtArcLength in interface Curve<LineSegment>
    
    Overrides:
    
    getPointAtArcLength in class AbstractCurve<LineSegment>
    
    Parameters:
    
    targetArcLength - The target arc length to find in meters. May not be null.
    
    tol - Fractional tolerance (in parameter space) to refine the point position to. For this curve, this parameter is ignored and the exact point position is always returned.
    
    Returns:
    
    A subrange point on the curve at the specified arc-length position.
  - extractGrid
```
public PointString<SubrangePoint> extractGrid(GridRule gridRule,
                                              java.util.List<java.lang.Double> spacing)
```
    Return a string of points that are gridded onto the curve using the specified spacing and gridding rule.
    
    Specified by:
    
    extractGrid in interface Curve<LineSegment>
    
    Overrides:
    
    extractGrid in class AbstractCurve<LineSegment>
    
    Parameters:
    
    gridRule - Specifies whether the subdivision spacing is applied with respect to arc-length in real space or parameter space. May not be null.
    
    spacing - A list of values used to define the subdivision spacing. gridRule specifies whether the subdivision spacing is applied with respect to arc-length in real space or parameter space. If the spacing is arc-length, then the values are interpreted as fractions of the arc length of the curve from 0 to 1. May not be null.
    
    Returns:
    
    A string of subrange points gridded onto the curve at the specified parametric positions.
  - gridToTolerance
```
public PointString<SubrangePoint> gridToTolerance(Parameter<Length> tol)
```
    Return a string of points that are gridded onto the curve with the number of points and spacing chosen to result in straight line segments between the points that have mid-points that are all within the specified tolerance of this curve.
    
    Specified by:
    
    gridToTolerance in interface Curve<LineSegment>
    
    Overrides:
    
    gridToTolerance in class AbstractCurve<LineSegment>
    
    Parameters:
    
    tol - The maximum distance that a straight line between gridded points may deviate from this curve. Ignored by this implementation.
    
    Returns:
    
    A string of subrange points gridded onto the curve.
  - intersect
```
public PointString<SubrangePoint> intersect(GeomPlane plane,
                                            double tol)
```
    Return the intersection between a plane and this curve.
    
    Specified by:
    
    intersect in interface Curve<LineSegment>
    
    Overrides:
    
    intersect in class AbstractCurve<LineSegment>
    
    Parameters:
    
    plane - The plane to intersect with this curve. May not be null.
    
    tol - Fractional tolerance (in parameter space) to refine the point positions to. For this curve, this parameter is ignored and the exact point positions are returned.
    
    Returns:
    
    A PointString containing zero or one subrange points made by the intersection of this curve with the specified plane. If no intersection is found, an empty PointString is returned.
  - intersect
```
public GeomList<PointString<SubrangePoint>> intersect(LineSegment line,
                                                      Parameter<Length> tol)
```
    Return the intersection between a line segment and this curve.
    
    Specified by:
    
    intersect in interface Curve<LineSegment>
    
    Overrides:
    
    intersect in class AbstractCurve<LineSegment>
    
    Parameters:
    
    line - The line segment to intersect. May not be null.
    
    tol - Tolerance (in physical space) to refine the point positions to. A null value indicates an exact intersection is required.
    
    Returns:
    
    A list containing two PointString instances each containing zero or 1 subrange points, on this line segment and the input line segment respectively, made by the intersection of this line segment with the specified line segment. If no intersections are found a list of two empty PointStrings are returned.
  - getLimitPoint
```
public SubrangePoint getLimitPoint(int dim,
                                   boolean max,
                                   double tol)
```
    Returns the most extreme point, either minimum or maximum, in the specified coordinate direction on this curve.
    
    Specified by:
    
    getLimitPoint in interface GeomElement<LineSegment>
    
    Overrides:
    
    getLimitPoint in class AbstractCurve<LineSegment>
    
    Parameters:
    
    dim - An index indicating the dimension to find the min/max point for (0=X, 1=Y, 2=Z, etc).
    
    max - Set to true to return the maximum value, false to return the minimum.
    
    tol - Fractional tolerance (in parameter space) to refine the min/max point position to.
    
    Returns:
    
    The point found on this curve that is the min or max in the specified coordinate direction.
    
    See Also:
    
    GeomElement.getBoundsMin(), GeomElement.getBoundsMax()
  - isValid
```
public boolean isValid()
```
    Return true if this LineSegment contains valid and finite numerical components. A value of false will be returned if any of the coordinate values are NaN or Inf.
    
    Specified by:
    
    isValid in interface GeomElement<LineSegment>
    
    Returns:
    
    true if this line segment contains valid and finite data.
  - isLine
```
public boolean isLine(Parameter<Length> tol)
```
    Returns true if this curve is a line to within the specified tolerance. This implementation always returns true if the line is not degenerate.
    
    Specified by:
    
    isLine in interface Curve<LineSegment>
    
    Overrides:
    
    isLine in class AbstractCurve<LineSegment>
    
    Parameters:
    
    tol - The tolerance for determining if this curve is a line. May not be null.
    
    Returns:
    
    Always returns true if the line is not degenerate.
  - isPlanar
```
public boolean isPlanar(Parameter<Length> tol)
```
    Return true if this curve is planar or false if it is not. This implementation always returns true
    
    Specified by:
    
    isPlanar in interface Curve<LineSegment>
    
    Overrides:
    
    isPlanar in class AbstractCurve<LineSegment>
    
    Parameters:
    
    tol - The geometric tolerance to use in determining if the curve is planar. Ignored by this implementation.
    
    Returns:
    
    Always returns true.
  - isCircular
```
public boolean isCircular(Parameter<Length> tol)
```
    Returns true if this curve is a circular arc to within the specified tolerance. This implementation always returns false.
    
    Specified by:
    
    isCircular in interface Curve<LineSegment>
    
    Overrides:
    
    isCircular in class AbstractCurve<LineSegment>
    
    Parameters:
    
    tol - The tolerance for determining if this curve is a circular arc. Ignored by this implementation.
    
    Returns:
    
    Always returns false.
  - getTransformed
```
public LineSegTrans getTransformed(GTransform transform)
```
    Returns transformed version of this element. The returned object implements GeomTransform and contains this element as a child.
    
    Specified by:
    
    getTransformed in interface Transformable<LineSegment>
    
    Parameters:
    
    transform - The transformation to apply to this geometry. May not be null.
    
    Returns:
    
    A new line segment that is identical to this one with the specified transformation applied.
    
    Throws:
    
    DimensionException - if this point is not 3D.
  - getUnit
```
public Unit<Length> getUnit()
```
    Returns the unit in which this curve is stated.
    
    Specified by:
    
    getUnit in interface GeomElement<LineSegment>
    
    Returns:
    
    The unit in which this curve is stated.
  - toNurbs
```
public NurbsCurve toNurbs(Parameter<Length> tol)
```
    Return a NURBS curve representation of this line segment. An exact representation is returned and the tolerance parameter is ignored.
    
    Specified by:
    
    toNurbs in interface Curve<LineSegment>
    
    Parameters:
    
    tol - Ignored. May pass null.
    
    Returns:
    
    A NURBS curve that exactly represents this line segment.
  - toNurbs
```
public NurbsCurve toNurbs()
```
    Return a NURBS curve representation of this line segment. An exact representation is returned.
    
    Returns:
    
    A NURBS curve that exactly represents this line segment.
  - toText
```
public javolution.text.Text toText()
```
    Returns the text representation of this geometry element that consists of the name followed by the start and end points. For example:
```
   {aLine = {{0.0 m, 0.0 m},{1.0 , 0.0 }}
 
```
    If there is no name, then the output looks like this:
```
   {{0.0 m, 0.0 m},{1.0 , 0.0 }}
 
```
    Specified by:
    
    toText in interface GeomElement<LineSegment>
    
    Overrides:
    
    toText in class AbstractGeomElement<LineSegment>
    
    Returns:
    
    the text representation of this geometry element.
  - to
```
public abstract LineSegment to(Unit<Length> unit)
                        throws ConversionException
```
    Returns the equivalent to this LineSegment object but stated in the specified unit.
    
    Specified by:
    
    to in interface Curve<LineSegment>
    
    Specified by:
    
    to in interface GeomElement<LineSegment>
    
    Specified by:
    
    to in interface ParametricGeometry<LineSegment>
    
    Specified by:
    
    to in interface PointGeometry<LineSegment>
    
    Parameters:
    
    unit - the length unit of the line segment to be returned. May not be null.
    
    Returns:
    
    an equivalent to this line segment object but stated in the specified unit.
    
    Throws:
    
    ConversionException - if the the input unit is not a length unit.

Class LineSegment

Field Summary

Fields inherited from class geomss.geom.AbstractCurve

Fields inherited from class geomss.geom.AbstractGeomElement

Constructor Summary

Method Summary

Methods inherited from class geomss.geom.AbstractCurve

Methods inherited from class geomss.geom.AbstractGeomElement

Methods inherited from class java.lang.Object

Methods inherited from interface geomss.geom.GeomElement

Methods inherited from interface java.lang.Comparable

Methods inherited from interface geomss.geom.Curve

Constructor Detail

LineSegment

Method Detail

getStart

getEnd

getUnitVector

getDerivativeVector

size

getPhyDimension

getNumberOfPoints

splitAt

getCurvature

getVariationOfCurvature

getTorsion

getArcLength

getPointAtArcLength

extractGrid

gridToTolerance

intersect

intersect

getLimitPoint

isValid

isLine

isPlanar

isCircular

getTransformed

getUnit

toNurbs

toNurbs

toText

to