RMPath (ReportMill 15 API)

java.lang.Object
- Shape
- - com.reportmill.graphics.RMPath

All Implemented Interfaces:

java.lang.Cloneable
```
public class RMPath
extends Shape
implements java.lang.Cloneable
```
RMPath - A graphics path (moveTo, lineTo, etc.). It provides the following functionality: - Allows for easy initialization with the path constructions methods (moveToPoint:, lineToPoint:, etc.). - Provides simple methods for path operations (stroke, fill, clip, etc.). Iterate over path like this: Point points[] = new Point[3]; for(int i=0, iMax=path.getElmtCount(); i

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RMPath.RMPathIter
A PathIter for Path.

Nested Classes
Modifier and Type	Class and Description
`static class`	`RMPath.RMPathIter` A PathIter for Path.

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`CLOSE`
`static byte`	`CURVE_TO`
`static byte`	`LINE_TO`
`static byte`	`MOVE_TO`
`static byte`	`QUAD_TO`
`static byte`	`WIND_EVEN_ODD`
`static byte`	`WIND_NON_ZERO`

Constructor Summary

Constructors
Constructor and Description
`RMPath()` Creates an empty path.
`RMPath(PathIter aPI)` Creates a path for the given path iterator.
`RMPath(Shape aShape)` Creates a path for the given shape.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSegment(RMLine aSegment)` Adds the list of segments to the path, starting with a moveto.
`void`	`addSegments(java.util.List<? extends RMLine> theSegments)` Adds the list of segments to the path, starting with a moveto.
`void`	`appendPathIter(PathIter aPI)` Returns a new path from a PathIter.
`void`	`appendShape(Shape aShape)` Returns a new path from a shape.
`RMPath`	`clone()` Standard clone implementation.
`void`	`closePath()` Adds a Close element to the given path.
`boolean`	`contains(double x, double y)` Returns whether the given xy coordinate is inside the path.
`void`	`curveTo(double cp1x, double cp1y, double cp2x, double cp2y, double px, double py)` Adds a CurveTo element to the path for the given point and control points.
`void`	`curveTo(Point cp1, Point cp2, Point p)` Adds a CurveTo element to the path for the given point and control points.
`boolean`	`equals(java.lang.Object anObj)` Standard equals implementation.
`java.lang.Object`	`fromXML(XMLArchiver anArchiver, XMLElement anElement)` XML unarchival.
`Rect`	`getBounds()` Returns the bounds for the path.
`byte`	`getElmt(int anIndex)` Returns the element type at the given index.
`int`	`getElmtCount()` Returns the number of elements in this path.
`int`	`getElmtIndexForPointIndex(int index)` Returns the element index for the given point index.
`byte`	`getElmtLast()` Returns the last element.
`int`	`getElmtPointIndex(int anIndex)` Returns the point index for a given element.
`RMHitInfo`	`getHitInfo(RMBezier aBezier, boolean findFirstHit)` Returns the hit info for the given bezier curve against this path.
`RMHitInfo`	`getHitInfo(RMLine aLine, boolean findFirstHit)` Returns the hit info for the given line against this path.
`RMPath`	`getPathFlattened()` Returns a path with only moveto, lineto.
`RMPath`	`getPathInRect(Rect aRect)` Returns a copy of the path scaled to exactly fit in the given rect.
`RMPath.RMPathIter`	`getPathIter(Transform aTrans)` Returns a PathIter for RMPath.
`Point`	`getPoint(int anIndex)` Returns the point at the given index.
`int`	`getPointCount()` Returns the number of points in the path.
`Point`	`getPointLast()` Returns the last point in the path.
`java.util.List<? extends RMLine>`	`getSegments()` Converts a path into a list of RMLine/RMQuadratic/RMBezier.
`java.util.List<java.util.List<? extends RMLine>>`	`getSubpathsSegments()` Converts a path into a list subpath lists of RMLine/RMQuadratic/RMBezier.
`byte`	`getWindingRule()` Returns the winding rule which describes how inner path perimeters are filled and clipped.
`int`	`handleAtPointForBounds(Point aPoint, Rect aRect, int selectedPoint, Size handleSize)` Returns the handle index for a given point against this path scaled to the given rect.
`boolean`	`intersects(RMLine aLine)` Returns whether path is hit by a line.
`boolean`	`intersects(RMPath aPath, float lineWidth)` Returns whether path drawn with given linewidth is hit by given path.
`boolean`	`isClosed()` Returns whether path has any open subpaths.
`void`	`lineTo(double px, double py)` Adds a LineTo element to the path for the given point.
`void`	`lineTo(Point p)` Adds a LineTo element to the path for the given point.
`void`	`moveTo(double px, double py)` Adds a MoveTo element to the path for the given point.
`void`	`moveTo(Point p)` Adds a MoveTo element to the path for the given point.
`int`	`pointCountForElmt(int element)` Returns the total number of points associated with a given type of path element.
`Point`	`pointInPathCoordsFromPoint(Point aPoint, Rect aRect)` Returns the given point converted to path coords for given path bounds.
`boolean`	`pointOnPath(int pointIndex)` Returns true of the point at pointIndex is on the path, and false if it is on the convex hull.
`void`	`quadTo(double cpx, double cpy, double px, double py)` Adds a QuadTo element to the path for the given point and control point.
`void`	`quadTo(Point cp, Point p)` Adds a QuadTo element to the path for the given point and control point.
`void`	`removeElmt(int elmtIndex)` Removes an element, reconnecting the elements on either side of the deleted element.
`void`	`removeLastElmt()` Removes the last element from the path.
`void`	`reset()` Resets the current path with no elements or points.
`void`	`setPoint(int index, double px, double py)` Sets the path point at the given index to the given point.
`void`	`setPointStructured(int index, Point point)` Resets the point at the given index to the given point, while preserving something.
`void`	`setWindingRule(byte windingRule)` Sets the winding rule which describes how inner path perimeters are filled and clipped.
`XMLElement`	`toXML(XMLArchiver anArchiver)` XML archival.
`void`	`transformBy(Transform aTrans)` Transforms the points in the path by the given transform.

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

- Field Detail
  - WIND_NON_ZERO
```
public static final byte WIND_NON_ZERO
```
    See Also:
    
    Constant Field Values
  - WIND_EVEN_ODD
```
public static final byte WIND_EVEN_ODD
```
    See Also:
    
    Constant Field Values
  - MOVE_TO
```
public static final byte MOVE_TO
```
    See Also:
    
    Constant Field Values
  - LINE_TO
```
public static final byte LINE_TO
```
    See Also:
    
    Constant Field Values
  - QUAD_TO
```
public static final byte QUAD_TO
```
    See Also:
    
    Constant Field Values
  - CURVE_TO
```
public static final byte CURVE_TO
```
    See Also:
    
    Constant Field Values
  - CLOSE
```
public static final byte CLOSE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RMPath
```
public RMPath()
```
    Creates an empty path.
  - RMPath
```
public RMPath(Shape aShape)
```
    Creates a path for the given shape.
  - RMPath
```
public RMPath(PathIter aPI)
```
    Creates a path for the given path iterator.
- Method Detail
  - moveTo
```
public void moveTo(Point p)
```
    Adds a MoveTo element to the path for the given point.
  - moveTo
```
public void moveTo(double px,
                   double py)
```
    Adds a MoveTo element to the path for the given point.
  - lineTo
```
public void lineTo(Point p)
```
    Adds a LineTo element to the path for the given point.
  - lineTo
```
public void lineTo(double px,
                   double py)
```
    Adds a LineTo element to the path for the given point.
  - quadTo
```
public void quadTo(Point cp,
                   Point p)
```
    Adds a QuadTo element to the path for the given point and control point.
  - quadTo
```
public void quadTo(double cpx,
                   double cpy,
                   double px,
                   double py)
```
    Adds a QuadTo element to the path for the given point and control point.
  - curveTo
```
public void curveTo(Point cp1,
                    Point cp2,
                    Point p)
```
    Adds a CurveTo element to the path for the given point and control points.
  - curveTo
```
public void curveTo(double cp1x,
                    double cp1y,
                    double cp2x,
                    double cp2y,
                    double px,
                    double py)
```
    Adds a CurveTo element to the path for the given point and control points.
  - closePath
```
public void closePath()
```
    Adds a Close element to the given path.
  - reset
```
public void reset()
```
    Resets the current path with no elements or points.
  - appendShape
```
public void appendShape(Shape aShape)
```
    Returns a new path from a shape.
  - appendPathIter
```
public void appendPathIter(PathIter aPI)
```
    Returns a new path from a PathIter.
  - getWindingRule
```
public byte getWindingRule()
```
    Returns the winding rule which describes how inner path perimeters are filled and clipped.
  - setWindingRule
```
public void setWindingRule(byte windingRule)
```
    Sets the winding rule which describes how inner path perimeters are filled and clipped.
  - getElmtCount
```
public int getElmtCount()
```
    Returns the number of elements in this path.
  - getElmt
```
public byte getElmt(int anIndex)
```
    Returns the element type at the given index.
  - getElmtLast
```
public byte getElmtLast()
```
    Returns the last element.
  - getPointCount
```
public int getPointCount()
```
    Returns the number of points in the path.
  - getPoint
```
public Point getPoint(int anIndex)
```
    Returns the point at the given index.
  - getPointLast
```
public Point getPointLast()
```
    Returns the last point in the path.
  - getBounds
```
public Rect getBounds()
```
    Returns the bounds for the path.
  - getPathIter
```
public RMPath.RMPathIter getPathIter(Transform aTrans)
```
    Returns a PathIter for RMPath.
  - getElmtPointIndex
```
public int getElmtPointIndex(int anIndex)
```
    Returns the point index for a given element.
  - getElmtIndexForPointIndex
```
public int getElmtIndexForPointIndex(int index)
```
    Returns the element index for the given point index.
  - pointCountForElmt
```
public int pointCountForElmt(int element)
```
    Returns the total number of points associated with a given type of path element.
  - pointOnPath
```
public boolean pointOnPath(int pointIndex)
```
    Returns true of the point at pointIndex is on the path, and false if it is on the convex hull.
  - isClosed
```
public boolean isClosed()
```
    Returns whether path has any open subpaths.
  - getPathInRect
```
public RMPath getPathInRect(Rect aRect)
```
    Returns a copy of the path scaled to exactly fit in the given rect.
  - contains
```
public boolean contains(double x,
                        double y)
```
    Returns whether the given xy coordinate is inside the path.
  - intersects
```
public boolean intersects(RMLine aLine)
```
    Returns whether path is hit by a line.
  - intersects
```
public boolean intersects(RMPath aPath,
                          float lineWidth)
```
    Returns whether path drawn with given linewidth is hit by given path.
  - getHitInfo
```
public RMHitInfo getHitInfo(RMLine aLine,
                            boolean findFirstHit)
```
    Returns the hit info for the given line against this path.
  - getSegments
```
public java.util.List<? extends RMLine> getSegments()
```
    Converts a path into a list of RMLine/RMQuadratic/RMBezier.
  - getSubpathsSegments
```
public java.util.List<java.util.List<? extends RMLine>> getSubpathsSegments()
```
    Converts a path into a list subpath lists of RMLine/RMQuadratic/RMBezier.
  - addSegments
```
public void addSegments(java.util.List<? extends RMLine> theSegments)
```
    Adds the list of segments to the path, starting with a moveto.
  - addSegment
```
public void addSegment(RMLine aSegment)
```
    Adds the list of segments to the path, starting with a moveto.
  - getHitInfo
```
public RMHitInfo getHitInfo(RMBezier aBezier,
                            boolean findFirstHit)
```
    Returns the hit info for the given bezier curve against this path.
  - handleAtPointForBounds
```
public int handleAtPointForBounds(Point aPoint,
                                  Rect aRect,
                                  int selectedPoint,
                                  Size handleSize)
```
    Returns the handle index for a given point against this path scaled to the given rect. Only returns points that are on the path, except for the control points of selectedPoint (if not -1)
  - pointInPathCoordsFromPoint
```
public Point pointInPathCoordsFromPoint(Point aPoint,
                                        Rect aRect)
```
    Returns the given point converted to path coords for given path bounds.
  - removeLastElmt
```
public void removeLastElmt()
```
    Removes the last element from the path.
  - removeElmt
```
public void removeElmt(int elmtIndex)
```
    Removes an element, reconnecting the elements on either side of the deleted element.
  - setPoint
```
public void setPoint(int index,
                     double px,
                     double py)
```
    Sets the path point at the given index to the given point.
  - setPointStructured
```
public void setPointStructured(int index,
                               Point point)
```
    Resets the point at the given index to the given point, while preserving something.
  - getPathFlattened
```
public RMPath getPathFlattened()
```
    Returns a path with only moveto, lineto.
  - transformBy
```
public void transformBy(Transform aTrans)
```
    Transforms the points in the path by the given transform.
  - equals
```
public boolean equals(java.lang.Object anObj)
```
    Standard equals implementation.
  - clone
```
public RMPath clone()
```
    Standard clone implementation.
  - toXML
```
public XMLElement toXML(XMLArchiver anArchiver)
```
    XML archival.
  - fromXML
```
public java.lang.Object fromXML(XMLArchiver anArchiver,
                                XMLElement anElement)
```
    XML unarchival.

Class RMPath

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WIND_NON_ZERO

WIND_EVEN_ODD

MOVE_TO

LINE_TO

QUAD_TO

CURVE_TO

CLOSE

Constructor Detail

RMPath

RMPath

RMPath

Method Detail

moveTo

moveTo

lineTo

lineTo

quadTo

quadTo

curveTo

curveTo

closePath

reset

appendShape

appendPathIter

getWindingRule

setWindingRule

getElmtCount

getElmt

getElmtLast

getPointCount

getPoint

getPointLast

getBounds

getPathIter

getElmtPointIndex

getElmtIndexForPointIndex

pointCountForElmt

pointOnPath

isClosed

getPathInRect

contains

intersects

intersects

getHitInfo

getSegments

getSubpathsSegments

addSegments

addSegment

getHitInfo

handleAtPointForBounds

pointInPathCoordsFromPoint

removeLastElmt

removeElmt

setPoint

setPointStructured

getPathFlattened

transformBy

equals

clone

toXML

fromXML