Polygon3d (Artisynth API documentation)

java.lang.Object
- maspack.geometry.Polygon3d

All Implemented Interfaces:

java.lang.Iterable<PolygonVertex3d>

Direct Known Subclasses:

ConvexPolygon3d
```
public class Polygon3d
extends java.lang.Object
implements java.lang.Iterable<PolygonVertex3d>
```

Constructor Summary

Constructors
Constructor and Description
`Polygon3d()`
`Polygon3d(java.util.Collection<? extends Point3d> pnts)`
`Polygon3d(double[] coords)`
`Polygon3d(Point3d[] pnts)`
`Polygon3d(Polygon2d poly, RigidTransform3d TPW)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addVertexAfter(PolygonVertex3d vtx, PolygonVertex3d ref)`
`void`	`appendVertex(PolygonVertex3d vtx)`
`void`	`clear()`
`Point3d`	`computeCentroid()` Computes the centroid of the vertices of this polygon.
`double`	`computePlanarArea()` Computes the area of this contour with respect to a plane formed by computing the centroid and then summing the cross products of rays from the centroid to adjacent contour points.
`boolean`	`epsilonEquals(Polygon3d poly, double eps)` Returns true if this polygon is equal to another polygon within a prescribed tolerance eps.
`boolean`	`equals(Polygon3d poly)` Returns true if this polygon is equal to another polygon.
`void`	`getBounds(Point3d minValues, Point3d maxValues)`
`PolygonVertex3d`	`getFirstVertex()`
`PolygonVertex3d`	`getLastVertex()`
`double`	`getMaxCoordinate()`
`Point3d[]`	`getPoints()`
`java.util.ListIterator`	`getVertices()`
`void`	`inverseTransform(AffineTransform3dBase X)` Applies an inverse affine transformation to the vertices of this polygon.
`boolean`	`isConvex(Vector3d nrml)` Returns `true` if this 3d polygon is convex with respect to the plane defined by the normal vector `nrml`.
`boolean`	`isConvex(Vector3d nrml, double angTol)` Returns `true` if this 3d polygon is convex, within a presribed angular tolerance, with respect to the plane defined by the normal vector `nrml`.
`boolean`	`isEmpty()`
`java.util.Iterator<PolygonVertex3d>`	`iterator()`
`int`	`numVertices()`
`void`	`prependVertex(PolygonVertex3d vtx)`
`void`	`scan(ReaderTokenizer rtok)`
`<P extends Point3d> void`	`set(java.util.Collection<P> pnts)`
`void`	`set(double[] coords, int numVertices)`
`void`	`set(Point3d[] pnts, int numVertices)`
`void`	`set(Polygon3d poly)`
`java.lang.String`	`toString()`
`java.lang.String`	`toString(NumberFormat fmt)`
`java.lang.String`	`toString(java.lang.String fmtStr)`
`void`	`transform(AffineTransform3dBase X)` Applies a affine transformation to the vertices of this polygon.
`void`	`updateBounds(Point3d minValues, Point3d maxValues)`

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - Polygon3d
```
public Polygon3d()
```
  - Polygon3d
```
public Polygon3d(double[] coords)
```
  - Polygon3d
```
public Polygon3d(Point3d[] pnts)
```
  - Polygon3d
```
public Polygon3d(java.util.Collection<? extends Point3d> pnts)
```
  - Polygon3d
```
public Polygon3d(Polygon2d poly,
                 RigidTransform3d TPW)
```
- Method Detail
  - getVertices
```
public java.util.ListIterator getVertices()
```
  - iterator
```
public java.util.Iterator<PolygonVertex3d> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<PolygonVertex3d>
  - getPoints
```
public Point3d[] getPoints()
```
  - computePlanarArea
```
public double computePlanarArea()
```
    Computes the area of this contour with respect to a plane formed by computing the centroid and then summing the cross products of rays from the centroid to adjacent contour points.
    
    Returns:
    
    planar area
  - computeCentroid
```
public Point3d computeCentroid()
```
    Computes the centroid of the vertices of this polygon. If the polygon is empty, a zero vector is returned.
    
    Returns:
    
    centroid of the polygon
  - numVertices
```
public int numVertices()
```
  - getMaxCoordinate
```
public double getMaxCoordinate()
```
  - getBounds
```
public void getBounds(Point3d minValues,
                      Point3d maxValues)
```
  - updateBounds
```
public void updateBounds(Point3d minValues,
                         Point3d maxValues)
```
  - addVertexAfter
```
public void addVertexAfter(PolygonVertex3d vtx,
                           PolygonVertex3d ref)
```
  - appendVertex
```
public void appendVertex(PolygonVertex3d vtx)
```
  - prependVertex
```
public void prependVertex(PolygonVertex3d vtx)
```
  - isEmpty
```
public boolean isEmpty()
```
  - getLastVertex
```
public PolygonVertex3d getLastVertex()
```
  - getFirstVertex
```
public PolygonVertex3d getFirstVertex()
```
  - clear
```
public void clear()
```
  - set
```
public void set(Polygon3d poly)
```
  - set
```
public void set(double[] coords,
                int numVertices)
```
  - set
```
public void set(Point3d[] pnts,
                int numVertices)
```
  - set
```
public <P extends Point3d> void set(java.util.Collection<P> pnts)
```
  - isConvex
```
public boolean isConvex(Vector3d nrml)
```
    Returns true if this 3d polygon is convex with respect to the plane defined by the normal vector nrml.
  - isConvex
```
public boolean isConvex(Vector3d nrml,
                        double angTol)
```
    Returns true if this 3d polygon is convex, within a presribed angular tolerance, with respect to the plane defined by the normal vector nrml.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - toString
```
public java.lang.String toString(java.lang.String fmtStr)
```
  - toString
```
public java.lang.String toString(NumberFormat fmt)
```
  - scan
```
public void scan(ReaderTokenizer rtok)
          throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - epsilonEquals
```
public boolean epsilonEquals(Polygon3d poly,
                             double eps)
```
    Returns true if this polygon is equal to another polygon within a prescribed tolerance eps. The two polyons are considered to be equal if their vertex lists are equal (within the specified tolerance) except for possibly being shifted with respect to each other.
    
    Parameters:
    
    poly - polygon to be compared with
    
    eps - tolerance value
    
    Returns:
    
    true if the polygons are equal
    
    See Also:
    
    epsilonEquals(maspack.geometry.Polygon3d, double)
  - equals
```
public boolean equals(Polygon3d poly)
```
    Returns true if this polygon is equal to another polygon. The two polyons are considered to be equal if their vertex lists are equal except for possibly being shifted with respect to each other.
    
    Parameters:
    
    poly - polygon to be compared with
    
    Returns:
    
    true if the polygons are equal
    
    See Also:
    
    epsilonEquals(maspack.geometry.Polygon3d, double)
  - transform
```
public void transform(AffineTransform3dBase X)
```
    Applies a affine transformation to the vertices of this polygon.
    
    Parameters:
    
    X - affine transformation
  - inverseTransform
```
public void inverseTransform(AffineTransform3dBase X)
```
    Applies an inverse affine transformation to the vertices of this polygon.
    
    Parameters:
    
    X - affine transformation

Class Polygon3d

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

Polygon3d

Polygon3d

Polygon3d

Polygon3d

Polygon3d

Method Detail

getVertices

iterator

getPoints

computePlanarArea

computeCentroid

numVertices

getMaxCoordinate

getBounds

updateBounds

addVertexAfter

appendVertex

prependVertex

isEmpty

getLastVertex

getFirstVertex

clear

set

set

set

set

isConvex

isConvex

toString

toString

toString

scan

epsilonEquals

equals

transform

inverseTransform