LineSegment3D (java-geom 3.3.1 API)

java.lang.Object
- math.geom3d.line.LineSegment3D

All Implemented Interfaces:

Serializable, ContinuousCurve3D, Curve3D, Shape3D
```
public class LineSegment3D
extends Object
implements ContinuousCurve3D
```
Author:

dlegland

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface math.geom3d.Shape3D
  Shape3D.EmptySet3D

Field Summary

Fields
Modifier and Type Field and Description

protected double x1

protected double x2

protected double y1

protected double y2

protected double z1

protected double z2
- Fields inherited from interface math.geom3d.Shape3D
  ACCURACY, EMPTY_SET

Fields
Modifier and Type	Field and Description
`protected double`	`x1`
`protected double`	`x2`
`protected double`	`y1`
`protected double`	`y2`
`protected double`	`z1`
`protected double`	`z2`

Constructor Summary

Constructors
Constructor and Description

LineSegment3D(Point3D p1, Point3D p2)

Constructors
Constructor and Description
`LineSegment3D(Point3D p1, Point3D p2)`

Method Summary

Methods
Modifier and Type	Method and Description
`Shape3D`	`clip(Box3D box)`
`boolean`	`contains(Point3D point)`
`Box3D`	`getBoundingBox()`
`Collection<LineSegment3D>`	`getContinuousCurves()` Returns the collection of continuous curves which constitute this curve.
`double`	`getDistance(LineSegment3D segment)` Returns distance of this segment from 'segment'.
`double`	`getDistance(Point3D point)` Gets the distance of the shape to the given point, or the distance of point to the frontier of the shape in the case of a plain shape.
`Point3D`	`getFirstPoint()` Get the first point of the curve.
`Point3D`	`getLastPoint()` Get the last point of the curve.
`Point3D`	`getPoint(double t)` Gets the point from a parametric representation of the curve.
`Point3D`	`getPoint(double t, Point3D point)` Same as getPoint(t), but gives the point as a parameter.
`double`	`getPosition(Point3D point)` If point does not project on the line segment, return Double.NaN.
`Curve3D`	`getReverseCurve()` Returns the curve with same trace on the plane with parametrization in reverse order.
`Collection<Point3D>`	`getSingularPoints()` Returns the2 end points.
`LineSegment3D`	`getSubCurve(double t0, double t1)` Returns a portion of the original curve, delimited by two positions on the curve.
`StraightLine3D`	`getSupportingLine()`
`double`	`getT0()` Return 0, by definition of LineSegment.
`double`	`getT1()` Return 1, by definition of LineSegment.
`boolean`	`isBounded()` Returns true, as a LineSegment3D is always bounded.
`boolean`	`isEmpty()` Returns false, as a LineSegment3D is never empty.
`double`	`project(Point3D point)` Returns the position of the closest orthogonal projection of the point on the curve, or of the closest singular point.
`Point3D`	`projectPoint(Point3D point)`
`Curve3D`	`transform(AffineTransform3D trans)` Transforms the curve by an affine transform.

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

- Field Detail
  - x1
```
protected double x1
```
  - y1
```
protected double y1
```
  - z1
```
protected double z1
```
  - x2
```
protected double x2
```
  - y2
```
protected double y2
```
  - z2
```
protected double z2
```
- Constructor Detail
  - LineSegment3D
```
public LineSegment3D(Point3D p1,
             Point3D p2)
```
- Method Detail
  - getSupportingLine
```
public StraightLine3D getSupportingLine()
```
  - projectPoint
```
public Point3D projectPoint(Point3D point)
```
  - getContinuousCurves
```
public Collection<LineSegment3D> getContinuousCurves()
```
    Description copied from interface: Curve3D
    
    Returns the collection of continuous curves which constitute this curve.
    
    Specified by:
    
    getContinuousCurves in interface Curve3D
    
    Returns:
    a collection of continuous curves.
  - getFirstPoint
```
public Point3D getFirstPoint()
```
    Description copied from interface: Curve3D
    
    Get the first point of the curve. It must returns the same result as getPoint(getT0()).
    
    Specified by:
    
    getFirstPoint in interface Curve3D
    
    Returns:
    the first point of the curve
  - getLastPoint
```
public Point3D getLastPoint()
```
    Description copied from interface: Curve3D
    
    Get the last point of the curve. It must returns the same result as getPoint(getT1()).
    
    Specified by:
    
    getLastPoint in interface Curve3D
    
    Returns:
    the last point of the curve.
  - getPoint
```
public Point3D getPoint(double t)
```
    Description copied from interface: Curve3D
    
    Gets the point from a parametric representation of the curve. If the parameter lies outside the definition range, the parameter corresponding to the closest bound is used instead. This method can be used to draw an approximated outline of a curve, by selecting multiple values for t and drawing lines between them.
    
    Specified by:
    
    getPoint in interface Curve3D
  - getPoint
```
public Point3D getPoint(double t,
               Point3D point)
```
    Description copied from interface: Curve3D
    
    Same as getPoint(t), but gives the point as a parameter. This avoids repetitive memory allocations.
    
    Specified by:
    
    getPoint in interface Curve3D
  - getPosition
```
public double getPosition(Point3D point)
```
    If point does not project on the line segment, return Double.NaN.
    
    Specified by:
    
    getPosition in interface Curve3D
    
    Parameters:
    point - a point belonging to the curve
    
    Returns:
    the position of the point on the curve
    See Also:
    Curve3D.getPosition(math.geom3d.Point3D)
  - getReverseCurve
```
public Curve3D getReverseCurve()
```
    Description copied from interface: Curve3D
    
    Returns the curve with same trace on the plane with parametrization in reverse order.
    
    Specified by:
    
    getReverseCurve in interface Curve3D
  - getSingularPoints
```
public Collection<Point3D> getSingularPoints()
```
    Returns the2 end points.
    
    Specified by:
    
    getSingularPoints in interface Curve3D
    
    Returns:
    a collection of Point3D.
    See Also:
    Curve3D.getSingularPoints()
  - getSubCurve
```
public LineSegment3D getSubCurve(double t0,
                        double t1)
```
    Description copied from interface: Curve3D
    
    Returns a portion of the original curve, delimited by two positions on the curve.
    
    Specified by:
    
    getSubCurve in interface Curve3D
    
    Parameters:
    t0 - position of the start of the sub-curve
    t1 - position of the end of the sub-curve
    
    Returns:
    the portion of original curve comprised between t0 and t1.
  - getT0
```
public double getT0()
```
    Return 0, by definition of LineSegment.
    
    Specified by:
    
    getT0 in interface Curve3D
    
    See Also:
    Curve3D.getT0()
  - getT1
```
public double getT1()
```
    Return 1, by definition of LineSegment.
    
    Specified by:
    
    getT1 in interface Curve3D
    
    See Also:
    Curve3D.getT1()
  - project
```
public double project(Point3D point)
```
    Description copied from interface: Curve3D
    
    Returns the position of the closest orthogonal projection of the point on the curve, or of the closest singular point. This function should always returns a valid value.
    
    Specified by:
    
    project in interface Curve3D
    
    Parameters:
    point - a point to project
    
    Returns:
    the position of the closest orthogonal projection
  - transform
```
public Curve3D transform(AffineTransform3D trans)
```
    Description copied from interface: Curve3D
    
    Transforms the curve by an affine transform. The result is an instance of Curve3D.
    
    Specified by:
    
    transform in interface Curve3D
    
    Specified by:
    
    transform in interface Shape3D
  - clip
```
public Shape3D clip(Box3D box)
```
    Specified by:
    
    clip in interface Shape3D
  - contains
```
public boolean contains(Point3D point)
```
    Specified by:
    
    contains in interface Shape3D
  - getBoundingBox
```
public Box3D getBoundingBox()
```
    Specified by:
    
    getBoundingBox in interface Shape3D
  - getDistance
```
public double getDistance(Point3D point)
```
    Description copied from interface: Shape3D
    
    Gets the distance of the shape to the given point, or the distance of point to the frontier of the shape in the case of a plain shape.
    
    Specified by:
    
    getDistance in interface Shape3D
  - getDistance
```
public double getDistance(LineSegment3D segment)
```
    Returns distance of this segment from 'segment'.
    Based on: http://softsurfer.com/Archive/algorithm_0106/
    dist3D_Segment_to_Segment()
    
    Parameters:
    segment -
    
    Returns:
  - isBounded
```
public boolean isBounded()
```
    Returns true, as a LineSegment3D is always bounded.
    
    Specified by:
    
    isBounded in interface Shape3D
    
    See Also:
    Shape3D.isBounded()
  - isEmpty
```
public boolean isEmpty()
```
    Returns false, as a LineSegment3D is never empty.
    
    Specified by:
    
    isEmpty in interface Shape3D
    
    See Also:
    Shape3D.isEmpty()

Class LineSegment3D

Nested Class Summary

Nested classes/interfaces inherited from interface math.geom3d.Shape3D

Field Summary

Fields inherited from interface math.geom3d.Shape3D

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

x1

y1

z1

x2

y2

z2

Constructor Detail

LineSegment3D

Method Detail

getSupportingLine

projectPoint

getContinuousCurves

getFirstPoint

getLastPoint

getPoint

getPoint

getPosition

getReverseCurve

getSingularPoints

getSubCurve

getT0

getT1

project

transform

clip

contains

getBoundingBox

getDistance

getDistance

isBounded

isEmpty