Interface ILcdGeneralPath

All Known Implementing Classes:
TLcdGeneralPath

public interface ILcdGeneralPath
ILcdGeneralPath is an interface defining a general path in world coordinates. Such a path is generally used as support for converting and caching polygons and polylines. A path contains 0 or more subpaths. A subpath contains 0 or more points. Each subpath is terminated by a line break, a polygon break, or a polygon closure.
  • Method Summary Link icon

    Modifier and Type
    Method
    Description
    void
    Appends a line break to the path.
    void
    Appends a polygon break to the path.
    void
    Returns a bounding box of this ILcdGeneralPath (in world coordinates) in the side effect parameter aBoundsSFCT.
    void
    Closes the current polygon.
    double
    getX(int aSubpathIndex, int aPointIndex)
     
    double
    getY(int aSubpathIndex, int aPointIndex)
     
    void
    lineTo(double aX, double aY)
    Appends a line to the world point (aX, aY).
    void
    moveTo(double aX, double aY)
    Breaks the current line and moves to the world point (aX, aY).
    boolean
    polygonContains(double aX, double aY)
    Checks whether the given point is contained by the polygon represented by this ILcdGeneralPath.
    void
    Resets the path.
    boolean
    subPathBreaksLine(int aSubpathIndex)
     
    boolean
    subPathBreaksPolygon(int aSubpathIndex)
     
    boolean
    subPathClosesPolygon(int aSubpathIndex)
     
    int
     
    int
    subPathLength(int aSubpathIndex)
     
  • Method Details Link icon

    • moveTo Link icon

      void moveTo(double aX, double aY)
      Breaks the current line and moves to the world point (aX, aY).
    • lineTo Link icon

      void lineTo(double aX, double aY)
      Appends a line to the world point (aX, aY).
    • reset Link icon

      void reset()
      Resets the path. The path becomes empty, containing no subpaths and thus no points.
    • breakLine Link icon

      void breakLine()
      Appends a line break to the path. Subsequent points will define a new polyline. The points will continue to define the same current polygon, however. For example, when a polygon in a model is represented by more than 1 polygon in world coordinates. This is possible in some projections where the polygon is at the edge of the projection and wraps around to the other edge.
    • breakPolygon Link icon

      void breakPolygon()
      Appends a polygon break to the path. Subsequent points will define a detached polygonal piece of the current polygon.
    • closePolygon Link icon

      void closePolygon()
      Closes the current polygon. Subsequent points will define a new polygon or hole.
    • subPathCount Link icon

      int subPathCount()
      Returns:
      the number of subpaths.
    • subPathLength Link icon

      int subPathLength(int aSubpathIndex)
      Returns:
      the length of the subpath at the given index.
    • subPathBreaksLine Link icon

      boolean subPathBreaksLine(int aSubpathIndex)
      Returns:
      whether the subpath at the given index represents a broken line.
    • subPathBreaksPolygon Link icon

      boolean subPathBreaksPolygon(int aSubpathIndex)
      Returns:
      whether the subpath at the given index represents a broken part of a polygon.
    • subPathClosesPolygon Link icon

      boolean subPathClosesPolygon(int aSubpathIndex)
      Returns:
      whether the subpath at the given index represents a closing part of a polygon.
    • getX Link icon

      double getX(int aSubpathIndex, int aPointIndex)
      Returns:
      the x coordinate of the subpath point at the given indices.
    • getY Link icon

      double getY(int aSubpathIndex, int aPointIndex)
      Returns:
      the y coordinate of the subpath point at the given indices.
    • calculateWorldBoundsSFCT Link icon

      void calculateWorldBoundsSFCT(ILcd2DEditableBounds aBoundsSFCT) throws TLcdNoBoundsException
      Returns a bounding box of this ILcdGeneralPath (in world coordinates) in the side effect parameter aBoundsSFCT.
      Throws:
      TLcdNoBoundsException - if no bounds are available
    • polygonContains Link icon

      boolean polygonContains(double aX, double aY)
      Checks whether the given point is contained by the polygon represented by this ILcdGeneralPath.