Class TLcdXYZFloatPolyline

All Implemented Interfaces:
ILcdBounded, ILcdCurve, ILcdPointList, ILcdPolyline, ILcdPolypoint, ILcdShape, ILcd2DEditablePointList, ILcd2DEditablePolyline, ILcd2DEditablePolypoint, ILcd2DEditableShape, ILcd3DEditablePointList, ILcd3DEditablePolyline, ILcd3DEditablePolypoint, ILcd3DEditableShape, ILcdCloneable, Serializable, Cloneable
Direct Known Subclasses:
TLcdDGNFloatCurve3D, TLcdDGNFloatLineString3D

public class TLcdXYZFloatPolyline extends ALcd3DEditableFloatPolypoint implements ILcd3DEditablePolyline, ILcdCurve
This class provides an implementation of ILcd3DEditablePolyline in the cartesian space with a reduced memory footprint.

It uses an array of floats instead of a TLcd3DEditablePointList of ILcd3DEditablePoint objects. A single array of floats stores the 3D coordinates. The points are stored as (x,y,z) triplets.

The array can also contain the bounds of the polyline in the last 6 places. Whether or not this is the case is controlled by a boolean passed at construction time. These bounds are then stored as (x,y,z)(width,height,depth).

This class is thread-hostile, even for read-only access, since point instances are being reused from an internal pool.

See Also:
  • Constructor Details

    • TLcdXYZFloatPolyline

      public TLcdXYZFloatPolyline()
      Constructs an empty polyline, containing zero points. No space is reserved to store the bounds of the polyline.
    • TLcdXYZFloatPolyline

      public TLcdXYZFloatPolyline(float[] aCoordinates, boolean aHasBounds, boolean aBoundsInitialized, boolean aClone)
      Constructs an XYZ polyline with the points as given in the array. If aHasBounds is true, the last 6 entries of the array will be used to store the bounds of the polyline.
      Parameters:
      aCoordinates - an array containing the coordinates of the points and possibly the bounds of the polyline.
      aHasBounds - whether to reserve the last 6 entries of the array for the bounds of the polyline or not.
      aBoundsInitialized - whether the last 6 entries of the array passed represent the calculated values of the bounds of the polyline or not. This is only of importance when aHasBounds is true.
      aClone - whether the array containing the coordinates (and possibly the bounds) should be cloned.
    • TLcdXYZFloatPolyline

      public TLcdXYZFloatPolyline(TLcdXYZFloatPolyline aXYZFloatPolyline)
      Clones the array of the polyline passed and interprets the its values alike (containing bounds or not).
      Parameters:
      aXYZFloatPolyline - the polyline to assume all values from.
  • Method Details

    • contains2D

      public boolean contains2D(double aX, double aY)
      Checks if the point (aX,aY) lies on the 2D projection of one of the line segments of the TLcdXYZPolyline.
      Specified by:
      contains2D in interface ILcdShape
      Overrides:
      contains2D in class ALcd3DEditableFloatPolypoint
      Parameters:
      aX - the x coordinate of the point.
      aY - the y coordinate of the point.
      Returns:
      the boolean result of the containment test.
    • contains3D

      public boolean contains3D(double aX, double aY, double aZ)
      Checks if the point (aX,aY,aZ) lies on one of the line segments of the TLcdXYZPolyline.
      Specified by:
      contains3D in interface ILcdShape
      Overrides:
      contains3D in class ALcd3DEditableFloatPolypoint
      Parameters:
      aX - the x coordinate of the point.
      aY - the y coordinate of the point.
      aZ - the z coordinate of the point.
      Returns:
      true if the bounds of this shape contain the point in the 3D space and the shape itself contains the point in the 2D space, false otherwise.
    • clone

      public Object clone()
      Description copied from class: ALcdShape
      Creates and returns a copy of this object, by delegating to Object.clone(). Extensions should delegate to this implementation with super.clone(), in order to create an object instance of the right type, with all fields copied. They then should explicitly clone any non-primitive fields for which a deeper clone is required.
      Specified by:
      clone in interface ILcdCloneable
      Overrides:
      clone in class ALcd3DEditableFloatPolypoint
      See Also:
    • createPoint

      protected ILcd3DEditablePoint createPoint()
      Description copied from class: ALcd3DEditableFloatPolypoint
      Creates an uninitialized ILcd3DEditablePoint point of a type compatible with the concrete implementation of this class (geodesic/cartesian). The created point will be updated and returned by the ALcd3DEditableFloatPolypoint.getPoint(int) and ALcd3DEditableFloatPolypoint.getFocusPoint() methods.
      Specified by:
      createPoint in class ALcd3DEditableFloatPolypoint
    • createBounds

      protected ILcd3DEditableBounds createBounds()
      Description copied from class: ALcd3DEditableFloatPolypoint
      Creates an uninitialized ILcd3DEditableBounds object of a type compatible with the concrete implementation of this class. This bounds object will be updated and returned by the ALcd3DEditableFloatPolypoint.getBounds() method.
      Specified by:
      createBounds in class ALcd3DEditableFloatPolypoint
    • computePointSFCT

      public void computePointSFCT(double aParam, ILcd3DEditablePoint aPointSFCT)
      Description copied from interface: ILcdCurve
      Computes a point of the curve, defined by the given parameter.
      Specified by:
      computePointSFCT in interface ILcdCurve
      Parameters:
      aParam - a value of the closed interval [0,1]
      aPointSFCT - the point to store the computed curve point in
    • getEndPoint

      public ILcdPoint getEndPoint()
      Description copied from interface: ILcdCurve
      Retrieves the end point of the curve.

      This is equivalent to computePointSFCT(1).

      Specified by:
      getEndPoint in interface ILcdCurve
      Returns:
      the end point of the curve
    • getEndTangent2D

      public double getEndTangent2D()
      Description copied from interface: ILcdCurve
      Returns the angle of the curve's tangent at the end point, in degrees counterclockwise from the direction at 3 o'clock.

      The tangent orientation is from the end point, away from the curve before it.

      This is the same as getTangent2D(1).

      Specified by:
      getEndTangent2D in interface ILcdCurve
      Returns:
      the curve's angle in the end point
    • getInterpolation

      public String getInterpolation()
      Description copied from interface: ILcdCurve
      Returns the interpolation method used by this curve.

      A set of predefined constants are defined in this interface, which are used by the default ILcdCurve implementations provided by LuciadLightspeed.

      Custom implementations can define their own constants, and use them to interpret the interpolation of the curve.

      Specified by:
      getInterpolation in interface ILcdCurve
      Returns:
      the interpolation method used by this curve.
    • getLength2D

      public double getLength2D(double aParam1, double aParam2)
      Description copied from interface: ILcdCurve
      Returns the length between two points of the curve, defined by the given parameters.
      • When aParam1 == aParam2, the length is 0.
      • When aParam1 == 0 and aParam2 == 1, the length is the whole length of the curve.
      • When aParam1 > aParam2, the length is (aParam1 to 1) + (0 to aParam2).
      Specified by:
      getLength2D in interface ILcdCurve
      Parameters:
      aParam1 - a value of the closed interval [0,1]
      aParam2 - a value of the closed interval [0,1]
      Returns:
      the length of the curve.
    • getLineSegmentIntersectionCount

      public int getLineSegmentIntersectionCount(ILcdPoint aP1, ILcdPoint aP2)
      Description copied from interface: ILcdCurve
      Returns the number of intersections between this curve and a line segment defined by the two specified points.

      This information can be used to perform containment calculations, if this curve is closed or if this curve is part of a composite closed curve. By determining the number of intersections between this curve and a line segment starting from a given point in a fixed direction, one can determine whether a point is located within the closed curve by using the even-odd rule.

      Specified by:
      getLineSegmentIntersectionCount in interface ILcdCurve
      Parameters:
      aP1 - the first point of the line segment
      aP2 - the second point of the line segment
      Returns:
      the number of intersections between the curve and the line segment
    • getStartPoint

      public ILcdPoint getStartPoint()
      Description copied from interface: ILcdCurve
      Retrieves the start point of the curve.

      This is equivalent to computePointSFCT(0).

      Specified by:
      getStartPoint in interface ILcdCurve
      Returns:
      the start point of the curve
    • getStartTangent2D

      public double getStartTangent2D()
      Description copied from interface: ILcdCurve
      Returns the angle of the curve's tangent at the start point, in degrees counterclockwise from the direction at 3 o'clock.

      The tangent orientation is from the start point towards the rest of the shape.

      This is the same as getTangent2D(0).

      Specified by:
      getStartTangent2D in interface ILcdCurve
      Returns:
      the curve's angle in the start point
    • getTangent2D

      public double getTangent2D(double aParam)
      Description copied from interface: ILcdCurve
      Returns the angle of the curve's tangent in the point defined by the given parameter, in degrees counterclockwise from the direction at 3 o'clock.

      The tangent orientation is from the point at parameter aParam towards the rest of the shape.

      Specified by:
      getTangent2D in interface ILcdCurve
      Parameters:
      aParam - a value of the closed interval [0,1]
      Returns:
      the curve's angle in the point defined by the given parameter