Polygon (jcsg 0.5.7 API)

java.lang.Object
- eu.mihosoft.jcsg.Polygon

```
public final class Polygon
extends java.lang.Object
```
Represents a convex polygon. Each convex polygon has a shared property, which is shared between all polygons that are clones of each other or where split from the same polygon. This can be used to define per-polygon properties (such as surface color).

Field Summary

Fields
Modifier and Type Field and Description

eu.mihosoft.jcsg.Plane _csg_plane
Plane defined by this polygon.

java.util.List<Vertex> vertices
Polygon vertices

Fields
Modifier and Type	Field and Description
`eu.mihosoft.jcsg.Plane`	`_csg_plane` Plane defined by this polygon.
`java.util.List<Vertex>`	`vertices` Polygon vertices

Constructor Summary

Constructors
Constructor and Description
`Polygon(java.util.List<Vertex> vertices)` Constructor.
`Polygon(java.util.List<Vertex> vertices, PropertyStorage shared)` Constructor.
`Polygon(Vertex... vertices)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`eu.mihosoft.vvecmath.Vector3d`	`centroid()`
`Polygon`	`clone()`
`boolean`	`contains(Polygon p)`
`boolean`	`contains(eu.mihosoft.vvecmath.Vector3d p)` Indicates whether the specified point is contained within this polygon.
`Polygon`	`flip()` Flips this polygon.
`Polygon`	`flipped()` Returns a flipped copy of this polygon.
`static java.util.List<Polygon>`	`fromConcavePoints(java.util.List<eu.mihosoft.vvecmath.Vector3d> points)` Decomposes the specified concave polygon into convex polygons.
`static java.util.List<Polygon>`	`fromConcavePoints(eu.mihosoft.vvecmath.Vector3d... points)` Decomposes the specified concave polygon into convex polygons.
`static Polygon`	`fromPoints(java.util.List<eu.mihosoft.vvecmath.Vector3d> points)` Creates a polygon from the specified point list.
`static Polygon`	`fromPoints(java.util.List<eu.mihosoft.vvecmath.Vector3d> points, PropertyStorage shared)` Creates a polygon from the specified point list.
`static Polygon`	`fromPoints(eu.mihosoft.vvecmath.Vector3d... points)` Creates a polygon from the specified points.
`Bounds`	`getBounds()` Returns the bounds of this polygon.
`eu.mihosoft.vvecmath.Plane`	`getPlane()` Returns the plane defined by this triangle.
`PropertyStorage`	`getStorage()`
`boolean`	`intersects(Polygon p)` Deprecated.
`boolean`	`isValid()` Indicates whether this polyon is valid, i.e., if it
`java.lang.String`	`toStlString()` Returns this polygon in STL string format.
`java.lang.StringBuilder`	`toStlString(java.lang.StringBuilder sb)` Returns this polygon in STL string format.
`java.util.List<Polygon>`	`toTriangles()` Returns a triangulated version of this polygon.
`Polygon`	`transform(eu.mihosoft.vvecmath.Transform transform)` Applies the specified transformation to this polygon.
`Polygon`	`transformed(eu.mihosoft.vvecmath.Transform transform)` Returns a transformed copy of this polygon.
`Polygon`	`translate(eu.mihosoft.vvecmath.Vector3d v)` Translates this polygon.
`Polygon`	`translated(eu.mihosoft.vvecmath.Vector3d v)` Returns a translated copy of this polygon.

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

- Field Detail
  - vertices
```
public final java.util.List<Vertex> vertices
```
    Polygon vertices
  - _csg_plane
```
public final eu.mihosoft.jcsg.Plane _csg_plane
```
    Plane defined by this polygon. Note: uses first three vertices to define the plane.
- Constructor Detail
  - Polygon
```
public Polygon(java.util.List<Vertex> vertices,
               PropertyStorage shared)
```
    Constructor. Creates a new polygon that consists of the specified vertices. Note: the vertices used to initialize a polygon must be coplanar and form a convex loop.
    
    Parameters:
    
    vertices - polygon vertices
    
    shared - shared property
  - Polygon
```
public Polygon(java.util.List<Vertex> vertices)
```
    Constructor. Creates a new polygon that consists of the specified vertices. Note: the vertices used to initialize a polygon must be coplanar and form a convex loop.
    
    Parameters:
    
    vertices - polygon vertices
  - Polygon
```
public Polygon(Vertex... vertices)
```
    Constructor. Creates a new polygon that consists of the specified vertices. Note: the vertices used to initialize a polygon must be coplanar and form a convex loop.
    
    Parameters:
    
    vertices - polygon vertices
- Method Detail
  - getPlane
```
public eu.mihosoft.vvecmath.Plane getPlane()
```
    Returns the plane defined by this triangle.
    
    Returns:
    
    plane
  - fromConcavePoints
```
public static java.util.List<Polygon> fromConcavePoints(eu.mihosoft.vvecmath.Vector3d... points)
```
    Decomposes the specified concave polygon into convex polygons.
    
    Parameters:
    
    points - the points that define the polygon
    
    Returns:
    
    the decomposed concave polygon (list of convex polygons)
  - fromConcavePoints
```
public static java.util.List<Polygon> fromConcavePoints(java.util.List<eu.mihosoft.vvecmath.Vector3d> points)
```
    Decomposes the specified concave polygon into convex polygons.
    
    Parameters:
    
    points - the points that define the polygon
    
    Returns:
    
    the decomposed concave polygon (list of convex polygons)
  - isValid
```
public boolean isValid()
```
    Indicates whether this polyon is valid, i.e., if it
    
    Returns:
  - clone
```
public Polygon clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - flip
```
public Polygon flip()
```
    Flips this polygon.
    
    Returns:
    
    this polygon
  - flipped
```
public Polygon flipped()
```
    Returns a flipped copy of this polygon. Note: this polygon is not modified.
    
    Returns:
    
    a flipped copy of this polygon
  - toStlString
```
public java.lang.String toStlString()
```
    Returns this polygon in STL string format.
    
    Returns:
    
    this polygon in STL string format
  - toStlString
```
public java.lang.StringBuilder toStlString(java.lang.StringBuilder sb)
```
    Returns this polygon in STL string format.
    
    Parameters:
    
    sb - string builder
    
    Returns:
    
    the specified string builder
  - toTriangles
```
public java.util.List<Polygon> toTriangles()
```
    Returns a triangulated version of this polygon.
    
    Returns:
    
    triangles
  - translate
```
public Polygon translate(eu.mihosoft.vvecmath.Vector3d v)
```
    Translates this polygon.
    
    Parameters:
    
    v - the vector that defines the translation
    
    Returns:
    
    this polygon
  - translated
```
public Polygon translated(eu.mihosoft.vvecmath.Vector3d v)
```
    Returns a translated copy of this polygon. Note: this polygon is not modified
    
    Parameters:
    
    v - the vector that defines the translation
    
    Returns:
    
    a translated copy of this polygon
  - transform
```
public Polygon transform(eu.mihosoft.vvecmath.Transform transform)
```
    Applies the specified transformation to this polygon. Note: if the applied transformation performs a mirror operation the vertex order of this polygon is reversed.
    
    Parameters:
    
    transform - the transformation to apply
    
    Returns:
    
    this polygon
  - transformed
```
public Polygon transformed(eu.mihosoft.vvecmath.Transform transform)
```
    Returns a transformed copy of this polygon. Note: if the applied transformation performs a mirror operation the vertex order of this polygon is reversed. Note: this polygon is not modified
    
    Parameters:
    
    transform - the transformation to apply
    
    Returns:
    
    a transformed copy of this polygon
  - fromPoints
```
public static Polygon fromPoints(java.util.List<eu.mihosoft.vvecmath.Vector3d> points,
                                 PropertyStorage shared)
```
    Creates a polygon from the specified point list.
    
    Parameters:
    
    points - the points that define the polygon
    
    shared - shared property storage
    
    Returns:
    
    a polygon defined by the specified point list
  - fromPoints
```
public static Polygon fromPoints(java.util.List<eu.mihosoft.vvecmath.Vector3d> points)
```
    Creates a polygon from the specified point list.
    
    Parameters:
    
    points - the points that define the polygon
    
    Returns:
    
    a polygon defined by the specified point list
  - fromPoints
```
public static Polygon fromPoints(eu.mihosoft.vvecmath.Vector3d... points)
```
    Creates a polygon from the specified points.
    
    Parameters:
    
    points - the points that define the polygon
    
    Returns:
    
    a polygon defined by the specified point list
  - getBounds
```
public Bounds getBounds()
```
    Returns the bounds of this polygon.
    
    Returns:
    
    bouds of this polygon
  - centroid
```
public eu.mihosoft.vvecmath.Vector3d centroid()
```
  - contains
```
public boolean contains(eu.mihosoft.vvecmath.Vector3d p)
```
    Indicates whether the specified point is contained within this polygon.
    
    Parameters:
    
    p - point
    
    Returns:
    
    true if the point is inside the polygon or on one of the edges; false otherwise
  - intersects
```
@Deprecated
public boolean intersects(Polygon p)
```
    Deprecated.
  - contains
```
public boolean contains(Polygon p)
```
  - getStorage
```
public PropertyStorage getStorage()
```
    Returns:
    
    the shared

Class Polygon

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

vertices

_csg_plane

Constructor Detail

Polygon

Polygon

Polygon

Method Detail

getPlane

fromConcavePoints

fromConcavePoints

isValid

clone

flip

flipped

toStlString

toStlString

toTriangles

translate

translated

transform

transformed

fromPoints

fromPoints

fromPoints

getBounds

centroid

contains

intersects

contains

getStorage