RMPath3D (ignition 7.9.3 API)

java.lang.Object
- com.reportmill.graphics.RMPath3D

All Implemented Interfaces:

java.lang.Cloneable
```
public class RMPath3D
extends java.lang.Object
implements java.lang.Cloneable
```
This class represents a path in 3D space.

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

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`

Constructor Summary

Constructors
Constructor and Description

RMPath3D()
Creates a new empty path.

RMPath3D(RMPath aPath, float aDepth)
Creates a 3D path from a 2D path with a depth.

Constructors
Constructor and Description
`RMPath3D()` Creates a new empty path.
`RMPath3D(RMPath aPath, float aDepth)` Creates a 3D path from a 2D path with a depth.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPath(RMPath aPath, float aDepth)` Adds a 2D path to the path3D at the given depth.
`void`	`align(RMVector3D vector)` Transforms the path so the normal is aligned with the given vector.
`java.lang.Object`	`clone()`
`void`	`close()` Adds a close element to the path3d.
`int`	`compare(java.lang.Object anObj)` UNUSED!!! Returns wether the given path is behind (ASCEND) or in front (DESCEND) of this path.
`int`	`comparePlane(RMPath3D aPath)` Returns whether receiver is in front (ORDER_ASCEND) or aPath in front (ORDER_DESCEND).
`void`	`curveTo(float cp1x, float cp1y, float cp1z, float cp2x, float cp2y, float cp2z, float x, float y, float z)` Adds a curve-to to the path3d with the given 3d coords.
`RMPoint3D[]`	`getBBox()` Returns the bounding box for the path as {min,max}
`RMPoint3D`	`getCenter()` Returns the center point of the path.
`float`	`getDistance(RMPoint3D aPoint)` Returns the distance from a point to the plane of this polygon.
`byte`	`getElement(int anIndex, RMPoint3D[] points)` Returns the element at the given index.
`int`	`getElementCount()` Returns the number of elements in the path3d.
`RMVector3D`	`getNormal()` Returns the normal of the path3d.
`RMPath`	`getPath()` Returns a path for the path3d.
`RMPoint3D`	`getPoint(int anIndex)` Returns the point3d at the given index.
`int`	`getPointCount()` Returns the number of points in the path3d.
`float`	`getXMax()` Returns the max X for the path.
`float`	`getXMin()` Returns the max X for the path.
`float`	`getYMax()` Returns the max Y for the path.
`float`	`getYMin()` Returns the max Y for the path.
`float`	`getZMax()` Returns the max Z for the path.
`float`	`getZMin()` Returns the max Z for the path.
`void`	`lineTo(float x, float y, float z)` Adds a line to the path3d with the given 3D coords.
`void`	`moveTo(float x, float y, float z)` Adds a moveto to the path3d with the given 3D coords.
`void`	`quadTo(float cpx, float cpy, float cpz, float x, float y, float z)` Adds a quad to to the path3d with the given 3D control point and coords.
`void`	`reverse()` Reverses the path3d.
`void`	`setCenter(RMPoint3D aPoint)` Sets the center point of the path.
`void`	`transform(RMTransform3D xform)` Transforms the path by the given transform3d.

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

- Field Detail
  - 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
  - RMPath3D
```
public RMPath3D()
```
    Creates a new empty path.
  - RMPath3D
```
public RMPath3D(RMPath aPath,
                float aDepth)
```
    Creates a 3D path from a 2D path with a depth.
- Method Detail
  - clone
```
public java.lang.Object clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - getElement
```
public byte getElement(int anIndex,
                       RMPoint3D[] points)
```
    Returns the element at the given index.
  - getElementCount
```
public int getElementCount()
```
    Returns the number of elements in the path3d.
  - getPoint
```
public RMPoint3D getPoint(int anIndex)
```
    Returns the point3d at the given index.
  - getPointCount
```
public int getPointCount()
```
    Returns the number of points in the path3d.
  - getCenter
```
public RMPoint3D getCenter()
```
    Returns the center point of the path.
  - setCenter
```
public void setCenter(RMPoint3D aPoint)
```
    Sets the center point of the path.
  - getNormal
```
public RMVector3D getNormal()
```
    Returns the normal of the path3d. Right hand rule for clockwise/counter-clockwise defined polygons.
  - getDistance
```
public float getDistance(RMPoint3D aPoint)
```
    Returns the distance from a point to the plane of this polygon.
  - moveTo
```
public void moveTo(float x,
                   float y,
                   float z)
```
    Adds a moveto to the path3d with the given 3D coords.
  - lineTo
```
public void lineTo(float x,
                   float y,
                   float z)
```
    Adds a line to the path3d with the given 3D coords.
  - quadTo
```
public void quadTo(float cpx,
                   float cpy,
                   float cpz,
                   float x,
                   float y,
                   float z)
```
    Adds a quad to to the path3d with the given 3D control point and coords.
  - curveTo
```
public void curveTo(float cp1x,
                    float cp1y,
                    float cp1z,
                    float cp2x,
                    float cp2y,
                    float cp2z,
                    float x,
                    float y,
                    float z)
```
    Adds a curve-to to the path3d with the given 3d coords.
  - close
```
public void close()
```
    Adds a close element to the path3d.
  - addPath
```
public void addPath(RMPath aPath,
                    float aDepth)
```
    Adds a 2D path to the path3D at the given depth.
  - reverse
```
public void reverse()
```
    Reverses the path3d.
  - transform
```
public void transform(RMTransform3D xform)
```
    Transforms the path by the given transform3d.
  - align
```
public void align(RMVector3D vector)
```
    Transforms the path so the normal is aligned with the given vector.
  - getPath
```
public RMPath getPath()
```
    Returns a path for the path3d.
  - compare
```
public int compare(java.lang.Object anObj)
```
    UNUSED!!! Returns wether the given path is behind (ASCEND) or in front (DESCEND) of this path.
  - comparePlane
```
public int comparePlane(RMPath3D aPath)
```
    Returns whether receiver is in front (ORDER_ASCEND) or aPath in front (ORDER_DESCEND). Returns (ORDER_SAME) if the two paths are coplanar, or (ORDER_INDETERMINATE) if they intersect.
  - getBBox
```
public RMPoint3D[] getBBox()
```
    Returns the bounding box for the path as {min,max}
  - getXMin
```
public float getXMin()
```
    Returns the max X for the path.
  - getXMax
```
public float getXMax()
```
    Returns the max X for the path.
  - getYMin
```
public float getYMin()
```
    Returns the max Y for the path.
  - getYMax
```
public float getYMax()
```
    Returns the max Y for the path.
  - getZMin
```
public float getZMin()
```
    Returns the max Z for the path.
  - getZMax
```
public float getZMax()
```
    Returns the max Z for the path.

Class RMPath3D

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MOVE_TO

LINE_TO

QUAD_TO

CURVE_TO

CLOSE

Constructor Detail

RMPath3D

RMPath3D

Method Detail

clone

getElement

getElementCount

getPoint

getPointCount

getCenter

setCenter

getNormal

getDistance

moveTo

lineTo

quadTo

curveTo

close

addPath

reverse

transform

align

getPath

compare

comparePlane

getBBox

getXMin

getXMax

getYMin

getYMax

getZMin

getZMax