Package com.luciad.shape.shape3D

Class TLcdXYZPolygon

java.lang.Object
com.luciad.shape.ALcdShape
com.luciad.shape.shape2D.ALcd2DEditableShape
com.luciad.shape.shape3D.ALcd3DEditableShape
com.luciad.shape.shape3D.ALcd3DEditablePolypoint
com.luciad.shape.shape3D.TLcdXYZPolypoint
com.luciad.shape.shape3D.TLcdXYZPolygon
All Implemented Interfaces:
ILcdBounded, ILcdCurve, ILcdPointList, ILcdPointList2, ILcdPolygon, ILcdPolypoint, ILcdRing, ILcdShape, ILcd2DEditablePointList, ILcd2DEditablePolygon, ILcd2DEditablePolypoint, ILcd2DEditableShape, ILcd3DEditablePointList, ILcd3DEditablePolygon, ILcd3DEditablePolypoint, ILcd3DEditableShape, ILcdCache, ILcdCloneable, Serializable, Cloneable
Direct Known Subclasses:
TLcdMeasureXYZPolygon, TLcdXYZMPolygon
public class TLcdXYZPolygon extends TLcdXYZPolypoint implements ILcd3DEditablePolygon, ILcd2DEditablePolygon, ILcdRing
This class provides an implementation of ILcd3DEditablePolygon in the cartesian space.

This class is thread-safe for concurrent read-only access of its contents. For read-write access, external locking must be used. Such locking is typically done at the model level.

See Also:

  • Constructor Details

    • TLcdXYZPolygon

      public TLcdXYZPolygon()
      Default constructor.

    • TLcdXYZPolygon

      public TLcdXYZPolygon(ILcd3DEditablePointList a3DEditablePointList)

    • TLcdXYZPolygon

      public TLcdXYZPolygon(TLcdXYZPolygon aXYZPolyline, boolean aDeepCopy)
      Makes a clone of the point list that represents the polyline if it implements the interface ILcdCloneable and aDeepCopy is true. #see com.luciad.util.ILcdCloneable

    • TLcdXYZPolygon

      public TLcdXYZPolygon(TLcdXYZPolygon aXYZPolyline)
      Copy constructor.
      Parameters:
      aXYZPolyline - The TLcdXYZPolyline to copy.

  • Method Details

    • getOrientation

      public int getOrientation()
      Description copied from interface: ILcdPolygon
      Returns the orientation of this ILcdPolygon: ILcdPolygon.CLOCKWISE or ILcdPolygon.COUNTERCLOCKWISE.
      Specified by:
      getOrientation in interface ILcdPolygon
      Returns:
      the orientation of this ILcdPolygon: ILcdPolygon.CLOCKWISE or ILcdPolygon.COUNTERCLOCKWISE. This method should not return INVALID_ORIENTATION, which is only to be used for resetting the orientation so that it can be recalculated.

    • setOrientation

      public void setOrientation(int aOrientation)
      Description copied from interface: ILcd2DEditablePolygon
      Sets the orientation of this ILcd2DEditablePolygon.
      Specified by:
      setOrientation in interface ILcd2DEditablePolygon
      Parameters:
      aOrientation - ILcd2DEditablePolygon.CLOCKWISE, ILcd2DEditablePolygon.COUNTERCLOCKWISE or ILcd2DEditablePolygon.INVALID_ORIENTATION.

    • calculateBounds

      protected ILcd3DEditableBounds calculateBounds()
      The bounds are determined by including all points that determine the polyline.
      Overrides:
      calculateBounds in class TLcdXYZPolypoint
      Returns:
      a bounds that contains all points of the polypoint.

    • contains2D

      public boolean contains2D(ILcdPoint aPoint)
      Description copied from class: ALcdShape
      Checks whether this ALcdShape contains the given point in the 2D cartesian plane.
      Specified by:
      contains2D in interface ILcdShape
      Overrides:
      contains2D in class ALcdShape
      Parameters:
      aPoint - the point to test.
      Returns:
      the boolean result of the containment test.
      See Also:

    • contains3D

      public boolean contains3D(ILcdPoint aPoint)
      Description copied from class: ALcdShape
      Checks whether this ALcdShape contains the given point in the 3D space.
      Specified by:
      contains3D in interface ILcdShape
      Overrides:
      contains3D in class ALcdShape
      Parameters:
      aPoint - the point to test.
      Returns:
      the boolean result of the containment test.
      See Also:

    • contains3D

      public boolean contains3D(double aX, double aY, double aZ)
      Returns whether the specified point is contained within this polygon. A point is considered contained inside the polygon if:
      • the projection (on the earth's surface, aZ == 0) of the point is contained within the projection (on the earth's surface) of this polygon
      • and the z value of the point lies between the minimum and maximum z value of this polygon.
      If the z values of the tested point and all points of the polygon are identical, this corresponds to a simple contains2D test.
      Specified by:
      contains3D in interface ILcdShape
      Overrides:
      contains3D in class ALcd3DEditablePolypoint
      Parameters:
      aX - the first coordinate of the point
      aY - the second coordinate of the point
      aZ - the third coordinate of the point
      Returns:
      whether the specified point is contained within this polygon.

    • contains2D

      public boolean contains2D(double aX, double aY)
      Determines whether this contains the given point.
      Specified by:
      contains2D in interface ILcdShape
      Overrides:
      contains2D in class ALcd3DEditablePolypoint
      Parameters:
      aX - the X coordinate of the point to be tested.
      aY - the Y coordinate of the point to be tested.
      Returns:
      the boolean result of the containment test.

    • clone

      public Object clone()
      Creates and returns a copy of this object.

      The contained editable points list is cloned. If cloning is not possible, a warning is sent to the log and a shallow copy is returned.

      The cache, the bounds and the focus point are not copied or cloned at all, but recalculated when needed.

      Specified by:
      clone in interface ILcdCloneable
      Overrides:
      clone in class TLcdXYZPolypoint
      See Also:

    • 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