LineSegment1D (euclid 0.8.2 API)

java.lang.Object
- us.ihmc.euclid.geometry.LineSegment1D

All Implemented Interfaces:

us.ihmc.euclid.interfaces.Clearable, us.ihmc.euclid.interfaces.EpsilonComparable<LineSegment1D>, us.ihmc.euclid.interfaces.GeometricallyComparable<LineSegment1D>, us.ihmc.euclid.interfaces.Settable<LineSegment1D>
```
public class LineSegment1D
extends java.lang.Object
implements us.ihmc.euclid.interfaces.Clearable, us.ihmc.euclid.interfaces.Settable<LineSegment1D>, us.ihmc.euclid.interfaces.EpsilonComparable<LineSegment1D>, us.ihmc.euclid.interfaces.GeometricallyComparable<LineSegment1D>
```
Represents a finite-length 1D line segment defined by its two 1D endpoints.

Constructor Summary

Constructors
Constructor and Description
`LineSegment1D()` Default constructor that initializes both endpoints of this line segment to `Double.NaN`.
`LineSegment1D(double[] endpoints)` Initializes this line segment to have the given endpoints.
`LineSegment1D(double firstEndpoint, double secondEndpoint)` Initializes this line segment to have the given endpoints.
`LineSegment1D(LineSegment1D other)` Creates a new line segment 1D and initializes it to `other`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LineSegment1D`	`computeOverlap(LineSegment1D other)` Computes the overlap between this line segment and the other line segment and stores the result in `intersectionToPack`.
`boolean`	`computeOverlap(LineSegment1D other, LineSegment1D intersectionToPack)` Computes the overlap between this line segment and the other line segment and stores the result in `intersectionToPack`.
`boolean`	`containsNaN()`
`double`	`distance(double point)` Calculates the distance between the query and the closest endpoint.
`boolean`	`epsilonEquals(LineSegment1D other, double epsilon)` Tests on a per-component basis on both endpoints if this line segment is equal to `other` with the tolerance `epsilon`.
`boolean`	`equals(LineSegment1D other)` Tests on a per component basis, if this line segment 1D is exactly equal to `other`.
`boolean`	`equals(java.lang.Object object)` Tests if the given `object`'s class is the same as this, in which case the method returns `equals(LineSegment1D)`, it returns `false` otherwise.
`void`	`extendSegmentToPoint(double point)` Extends this line segment to include the given point.
`boolean`	`geometricallyEquals(LineSegment1D other, double epsilon)` Compares `this` to `other` to determine if the two line segments are geometrically similar.
`double`	`getFirstEndpoint()` Gets the coordinate of this line segment's first endpoint.
`double`	`getMaxPoint()` Gets the highest coordinate of this line segment.
`double`	`getMidPoint()` Calculates the coordinate of the point located in the middle of this line segment.
`double`	`getMinPoint()` Gets the lowest coordinate of this line segment.
`double`	`getSecondEndpoint()` Gets the coordinate of this line segment's second endpoint.
`boolean`	`isAfter(double point)` Tests if the given point is located outside this line segment and that this line segment is point toward the point.
`boolean`	`isBefore(double point)` Tests if the given point is located outside this line segment and that this line segment is point away from the point.
`boolean`	`isBetweenEndpoints(double point, double epsilon)` Tests whether the given point is located between the two endpoints with a given conservative tolerance `epsilon`:
`boolean`	`isBetweenEndpointsExclusive(double point)` Tests if this line segment contains the given `point`.
`boolean`	`isBetweenEndpointsExclusive(LineSegment1D other)` Tests if this line segment entirely contains the given line segment `other`.
`boolean`	`isBetweenEndpointsInclusive(double point)` Tests if this line segment contains the given `point`.
`boolean`	`isBetweenEndpointsInclusive(LineSegment1D other)` Tests if this line segment entirely contains the given line segment `other`.
`boolean`	`isOverlappingExclusive(LineSegment1D other)` Tests if this line segment and the other overlap or not.
`boolean`	`isOverlappingInclusive(LineSegment1D other)` Tests if this line segment and the other overlap or not.
`double`	`length()` Calculates the (absolute) length of this line segment.
`void`	`set(double[] endpoints)` Redefines this line segment with new endpoints.
`void`	`set(double firstEndpoint, double secondEndpoint)` Sets this line segment's endpoints.
`void`	`set(LineSegment1D other)`
`void`	`setFirstEndpoint(double firstEndpoint)` Sets the first endpoint of this line segment.
`void`	`setMaxPoint(double newMaxPoint)` Updates the endpoint of this line segment with the highest coordinate.
`void`	`setMinPoint(double newMinPoint)` Updates the endpoint of this line segment with the lowest coordinate.
`void`	`setSecondEndpoint(double secondEndpoint)` Sets the second endpoint of this line segment.
`void`	`setToNaN()`
`void`	`setToZero()`
`double`	`signedDistance(double point)` Calculates the distance between the query and the closest endpoint.
`LineSegment2D`	`toLineSegment2d(us.ihmc.euclid.tuple2D.interfaces.Point2DReadOnly zero2d, us.ihmc.euclid.tuple2D.interfaces.Vector2DReadOnly direction2d)` Compute the 2D equivalent of this line segment.
`LineSegment3D`	`toLineSegment3d(Line3DReadOnly line3d)` Compute the 3D equivalent of this line segment.
`LineSegment3D`	`toLineSegment3d(us.ihmc.euclid.tuple3D.interfaces.Point3DReadOnly zero3d, us.ihmc.euclid.tuple3D.interfaces.Vector3DReadOnly direction3d)` Compute the 3D equivalent of this line segment.
`java.lang.String`	`toString()` Provides a `String` representation of this line segment 1D as follows: Line segment 1D: 1st endpoint = (x), 2nd endpoint = (x)

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

- Constructor Detail
  - LineSegment1D
```
public LineSegment1D()
```
    Default constructor that initializes both endpoints of this line segment to Double.NaN.
  - LineSegment1D
```
public LineSegment1D(double firstEndpoint,
                     double secondEndpoint)
```
    Initializes this line segment to have the given endpoints.
    
    Parameters:
    
    firstEndpoint - coordinate of the first endpoint of this line segment.
    
    secondEndpoint - coordinate of the second endpoint of this line segment.
  - LineSegment1D
```
public LineSegment1D(LineSegment1D other)
```
    Creates a new line segment 1D and initializes it to other.
    
    Parameters:
    
    other - the other line segment used to initialize this line segment. Not modified.
  - LineSegment1D
```
public LineSegment1D(double[] endpoints)
```
    Initializes this line segment to have the given endpoints.
    
    Parameters:
    
    endpoints - a two-element array containing in order the first and second endpoints for this line segment. Not modified.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the given array has a length different than 2.
- Method Detail
  - computeOverlap
```
public boolean computeOverlap(LineSegment1D other,
                              LineSegment1D intersectionToPack)
```
    Computes the overlap between this line segment and the other line segment and stores the result in intersectionToPack.
    Edge cases:
    - If the two line segments do not overlap, this method fails, returns false and intersecitonToPack remains unchanged.
    Parameters:
    
    other - the other line segment. Not modified.
    
    intersectionToPack - line segment used to store the result. Modified.
    
    Returns:
    
    whether the two line segment overlap or no.
  - computeOverlap
```
public LineSegment1D computeOverlap(LineSegment1D other)
```
    Computes the overlap between this line segment and the other line segment and stores the result in intersectionToPack.
    Edge cases:
    - If the two line segments do not overlap, this method fails, returns false and intersecitonToPack remains unchanged.
    WARNING: This method generates garbage.
    Parameters:
    
    other - the other line segment. Not modified.
    
    Returns:
    
    the line segment representing the overlap, or null if the line segments do not overlap.
  - isOverlappingInclusive
```
public boolean isOverlappingInclusive(LineSegment1D other)
```
    Tests if this line segment and the other overlap or not.
    Edge cases:
    - If the two line segments only share one of their endpoint, they are considered to be overlapping.
    Parameters:
    
    other - the query. Not modified.
    
    Returns:
    
    true if the two line segments overlap, false otherwise.
  - isOverlappingExclusive
```
public boolean isOverlappingExclusive(LineSegment1D other)
```
    Tests if this line segment and the other overlap or not.
    Edge cases:
    - If the two line segments only share one of their endpoint, they do not overlap.
    Parameters:
    
    other - the query. Not modified.
    
    Returns:
    
    true if the two line segments overlap, false otherwise.
  - isBetweenEndpointsInclusive
```
public boolean isBetweenEndpointsInclusive(LineSegment1D other)
```
    Tests if this line segment entirely contains the given line segment other.
    Edge cases:
    - If the two line segments have one or two endpoints in common, this line segment entirely contains other.
    Parameters:
    
    other - the query. Not modified.
    
    Returns:
    
    true if this line segment contains other, false otherwise.
  - isBetweenEndpointsExclusive
```
public boolean isBetweenEndpointsExclusive(LineSegment1D other)
```
    Tests if this line segment entirely contains the given line segment other.
    Edge cases:
    - If the two line segments have one or two endpoints in common, this line segment does not contain other.
    Parameters:
    
    other - the query. Not modified.
    
    Returns:
    
    true if this line segment contains other, false otherwise.
  - isBetweenEndpointsInclusive
```
public boolean isBetweenEndpointsInclusive(double point)
```
    Tests if this line segment contains the given point.
    Edge cases:
    - If the given point is equal to one of this line segment's endpoints, the point is considered to be between this line segment endpoints.
    Parameters:
    
    point - the query.
    
    Returns:
    
    true if this line segment contains point, false otherwise.
  - isBetweenEndpointsExclusive
```
public boolean isBetweenEndpointsExclusive(double point)
```
    Tests if this line segment contains the given point.
    Edge cases:
    - If the given point is equal to one of this line segment's endpoints, the point is considered to be outside this line segment.
    Parameters:
    
    point - the query.
    
    Returns:
    
    true if this line segment contains point, false otherwise.
  - isBetweenEndpoints
```
public boolean isBetweenEndpoints(double point,
                                  double epsilon)
```
    Tests whether the given point is located between the two endpoints with a given conservative tolerance epsilon:
  - if epsilon > 0, the point has to be between the endpoints and at a minimum distance of epsilon * this.length() from the closest endpoint.
  - if epsilon < 0, the point has to be between the endpoints or at a maximum distance of -epsilon * this.length() from the closest endpoint.
  - if epsilon = 0, the point has to be between the endpoints or equal to one of the endpoints.

Parameters:: point - the query.; epsilon - the tolerance to use for this test. If positive, the test becomes less restrictive. If negative, the test becomes more conservative.
Returns:: true if the point is considered to be between this line segment's endpoints, false otherwise.

signedDistance
```
public double signedDistance(double point)
```
Calculates the distance between the query and the closest endpoint.
If the point is located between the endpoints of this line segment, the returned value of the distance is negative.

Parameters:

point - the query.

Returns:

the distance between the query and this line segment.

distance
```
public double distance(double point)
```
Calculates the distance between the query and the closest endpoint.
If the point is located between the endpoints of this line segment, this method returns 0.

Parameters:

point - the query.

Returns:

the distance between the query and this line segment.

extendSegmentToPoint
```
public void extendSegmentToPoint(double point)
```
Extends this line segment to include the given point.
If the point is between this line segment's endpoints, this line segment remains unchanged.

Parameters:

point - the point to be included by extended this line segment.

isBefore
```
public boolean isBefore(double point)
```
Tests if the given point is located outside this line segment and that this line segment is point away from the point.

Parameters:

point - the query.

Returns:

true if the point is located before this line segment, false if the point is located between the endpoints of this line segment or if this line segment is pointed toward the point.

isAfter
```
public boolean isAfter(double point)
```
Tests if the given point is located outside this line segment and that this line segment is point toward the point.

Parameters:

point - the query.

Returns:

true if the point is located after this line segment, false if the point is located between the endpoints of this line segment or if this line segment is pointed away from the point.

containsNaN
```
public boolean containsNaN()
```
Specified by:

containsNaN in interface us.ihmc.euclid.interfaces.Clearable

setToNaN
```
public void setToNaN()
```
Specified by:

setToNaN in interface us.ihmc.euclid.interfaces.Clearable

setToZero
```
public void setToZero()
```
Specified by:

setToZero in interface us.ihmc.euclid.interfaces.Clearable

set
```
public void set(LineSegment1D other)
```
Specified by:

set in interface us.ihmc.euclid.interfaces.Settable<LineSegment1D>

set
```
public void set(double firstEndpoint,
                double secondEndpoint)
```
Sets this line segment's endpoints.

Parameters:

firstEndpoint - coordinate of the first endpoint.

secondEndpoint - coordinate of the second endpoint.

set
```
public void set(double[] endpoints)
```
Redefines this line segment with new endpoints.

Parameters:

endpoints - a two-element array containing in order the first and second endpoints for this line segment. Not modified.

Throws:

java.lang.IllegalArgumentException - if the given array has a length different than 2.

setFirstEndpoint
```
public void setFirstEndpoint(double firstEndpoint)
```
Sets the first endpoint of this line segment.

Parameters:

firstEndpoint - coordinate of the first endpoint.

setSecondEndpoint
```
public void setSecondEndpoint(double secondEndpoint)
```
Sets the second endpoint of this line segment.

Parameters:

secondEndpoint - coordinate of the second endpoint.

setMinPoint
```
public void setMinPoint(double newMinPoint)
```
Updates the endpoint of this line segment with the lowest coordinate.

Parameters:

newMinPoint - the new coordinate for the endpoint with the lowest coordinate.

Throws:

java.lang.RuntimeException - if the argument is greater or equal to the endpoint with greatest coordinate. This prevents to flip this line segment's direction.

setMaxPoint
```
public void setMaxPoint(double newMaxPoint)
```
Updates the endpoint of this line segment with the highest coordinate.

Parameters:

newMaxPoint - the new coordinate for the endpoint with the highest coordinate.

Throws:

java.lang.RuntimeException - if the argument is less or equal to the endpoint with lowest coordinate. This prevents to flip this line segment's direction.

getFirstEndpoint
```
public double getFirstEndpoint()
```
Gets the coordinate of this line segment's first endpoint.

Returns:

the first endpoint coordinate.

getSecondEndpoint
```
public double getSecondEndpoint()
```
Gets the coordinate of this line segment's second endpoint.

Returns:

the second endpoint coordinate.

getMaxPoint
```
public double getMaxPoint()
```
Gets the highest coordinate of this line segment.

Returns:

the endpoint with the maximum coordinate value.

getMinPoint
```
public double getMinPoint()
```
Gets the lowest coordinate of this line segment.

Returns:

the endpoint with the minimum coordinate value.

getMidPoint
```
public double getMidPoint()
```
Calculates the coordinate of the point located in the middle of this line segment.

Returns:

the coordinate of the middle of this line segment.

length
```
public double length()
```
Calculates the (absolute) length of this line segment.

Returns:

the value of this line segment's length.

toLineSegment3d
```
public LineSegment3D toLineSegment3d(Line3DReadOnly line3d)
```
Compute the 3D equivalent of this line segment. The 3D equivalent of each end point is computed as follows: endPoint3d = endPoint1d * lineDirection3d + lineStart3d.

Parameters:

line3d - the 3D line used as reference to compute the 3D line segment.

Returns:

the 3D equivalent of this line segment.

toLineSegment3d
```
public LineSegment3D toLineSegment3d(us.ihmc.euclid.tuple3D.interfaces.Point3DReadOnly zero3d,
                                     us.ihmc.euclid.tuple3D.interfaces.Vector3DReadOnly direction3d)
```
Compute the 3D equivalent of this line segment. The 3D equivalent of each end point is computed as follows: endPoint3d = endPoint1d * direction3d + zero3d.

Parameters:

zero3d - position of the 3D equivalent of an endpoint equal to zero.

direction3d - direction toward greater values of endPoint1d.

Returns:

the 3D equivalent of this line segment.

toLineSegment2d
```
public LineSegment2D toLineSegment2d(us.ihmc.euclid.tuple2D.interfaces.Point2DReadOnly zero2d,
                                     us.ihmc.euclid.tuple2D.interfaces.Vector2DReadOnly direction2d)
```
Compute the 2D equivalent of this line segment. The 2D equivalent of each end point is computed as follows: endPoint2d = endPoint1d * direction2d + zero2d.

Parameters:

zero2d - position of the 2D equivalent of an endpoint equal to zero.

direction2d - direction toward greater values of endPoint1d.

Returns:

the 2D equivalent of this line segment.

epsilonEquals
```
public boolean epsilonEquals(LineSegment1D other,
                             double epsilon)
```
Tests on a per-component basis on both endpoints if this line segment is equal to other with the tolerance epsilon.

Specified by:

epsilonEquals in interface us.ihmc.euclid.interfaces.EpsilonComparable<LineSegment1D>

Parameters:

other - the query. Not modified.

epsilon - the tolerance to use.

Returns:

true if the two line segments are equal, false otherwise.

geometricallyEquals
```
public boolean geometricallyEquals(LineSegment1D other,
                                   double epsilon)
```
Compares this to other to determine if the two line segments are geometrically similar.
The comparison is based on comparing the line segments' endpoints. Two line segments are considered geometrically equal even if they are defined with opposite direction.

Specified by:

geometricallyEquals in interface us.ihmc.euclid.interfaces.GeometricallyComparable<LineSegment1D>

Parameters:

other - the line segment to compare to. Not modified.

epsilon - the tolerance of the comparison.

Returns:

true if the two line segments represent the same geometry, false otherwise.

equals
```
public boolean equals(LineSegment1D other)
```
Tests on a per component basis, if this line segment 1D is exactly equal to other.

Parameters:

other - the other line segment 1D to compare against this. Not modified.

Returns:

true if the two line segments are exactly equal component-wise, false otherwise.

equals
```
public boolean equals(java.lang.Object object)
```
Tests if the given object's class is the same as this, in which case the method returns equals(LineSegment1D), it returns false otherwise.

Overrides:

equals in class java.lang.Object

Parameters:

object - the object to compare against this. Not modified.

Returns:

true if object and this are exactly equal, false otherwise.

toString
```
public java.lang.String toString()
```
Provides a String representation of this line segment 1D as follows:
Line segment 1D: 1st endpoint = (x), 2nd endpoint = (x)

Overrides:

toString in class java.lang.Object

Returns:

the String representing this line segment 1D.

Class LineSegment1D

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LineSegment1D

LineSegment1D

LineSegment1D

LineSegment1D

Method Detail

computeOverlap

computeOverlap

isOverlappingInclusive

isOverlappingExclusive

isBetweenEndpointsInclusive

isBetweenEndpointsExclusive

isBetweenEndpointsInclusive

isBetweenEndpointsExclusive

isBetweenEndpoints

signedDistance

distance

extendSegmentToPoint

isBefore

isAfter

containsNaN

setToNaN

setToZero

set

set

set

setFirstEndpoint

setSecondEndpoint

setMinPoint

setMaxPoint

getFirstEndpoint

getSecondEndpoint

getMaxPoint

getMinPoint

getMidPoint

length

toLineSegment3d

toLineSegment3d

toLineSegment2d

epsilonEquals

geometricallyEquals

equals

equals

toString