PenetrationRegion (Artisynth API documentation)

java.lang.Object
- maspack.collision.PenetrationRegion

```
public class PenetrationRegion
extends java.lang.Object
```
Describes a penetration region for an oriented triangular mesh. This is a single connected region of the mesh that is either "inside" or "outside" another oriented mesh when the two meshes intersect. It is bounded by one or more intersection contours, and contains a set of edges that are associated with the intersection and a set of vertices contained within the region. The intersection between two meshes will generally result in one or more penetration regions for each mesh. The number of regions on each mesh may differ, and they will not necessarily share the same contours.
In some cases the penetration region may intersect only a single face of the intersecting mesh. The region is then referred to as a "single face region", and its bounding contours all lie within the single face of the intersecting mesh.

Field Summary

Fields
Modifier and Type Field and Description

static boolean debug

Fields
Modifier and Type	Field and Description
`static boolean`	`debug`

Constructor Summary

Constructors
Constructor and Description
`PenetrationRegion(PolygonalMesh mesh, boolean clockwise, double posTol)` Creates a new, empty penetration region for a specified mesh.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`containsEdge(HalfEdge he)` Returns `true` if a specified edge is contained in this region.
`boolean`	`containsFace(Face face)` Returns `true` if a specified face is contained in this region.
`boolean`	`containsVertex(Vertex3d vtx)` Returns `true` if a specified vertex is contained in this region.
`boolean`	`equals(PenetrationRegion region)` Returns true if this region equals another.
`double`	`getArea()` Returns the surface area for this penetration region.
`java.util.LinkedHashSet<IntersectionContour>`	`getContours()` Returns the contours which bound this region.
`java.util.LinkedHashSet<HalfEdge>`	`getEdges()` Returns the edges contained in this region.
`java.util.LinkedHashSet<Face>`	`getFaces()` Returns the faces contained in this region.
`PolygonalMesh`	`getMesh()` Returns the mesh associated with this region.
`double`	`getPositionTol()` Returns the position tolerance that was used to create this region.
`java.util.LinkedHashSet<Vertex3d>`	`getVertices()` Returns the vertices contained in this region.
`boolean`	`hasClockwiseContours()` Indicates if the contours of this region are oriented clockwise with respect to the region's mesh.
`int`	`numContours()` Returns the number of contours bounding this region.
`int`	`numEdges()` Returns the number of edges contained in this region.
`int`	`numFaces()` Returns the number of faces contained in this region.
`int`	`numVertices()` Returns the number of vertices contained in this region.
`java.lang.String`	`toString(java.util.List<IntersectionContour> contours)` Returns a string representation of this region consisting of the indices of the vertices and the indices of the contours with respect to a reference list.

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

- Field Detail
  - debug
```
public static boolean debug
```
- Constructor Detail
  - PenetrationRegion
```
public PenetrationRegion(PolygonalMesh mesh,
                         boolean clockwise,
                         double posTol)
```
    Creates a new, empty penetration region for a specified mesh.
    
    Parameters:
    
    mesh - mesh to which the region belongs
    
    clockwise - if true, indicates that the bounding contours for the region are oriented clockwise with respect to the mesh.
    
    posTol - position tolerance used to create the region
- Method Detail
  - getContours
```
public java.util.LinkedHashSet<IntersectionContour> getContours()
```
    Returns the contours which bound this region.
    
    Returns:
    
    hash set of the bounding contours. Should not be modified.
  - numContours
```
public int numContours()
```
    Returns the number of contours bounding this region.
    
    Returns:
    
    number of bounding contours
  - getVertices
```
public java.util.LinkedHashSet<Vertex3d> getVertices()
```
    Returns the vertices contained in this region.
    
    Returns:
    
    hash set of the region vertices. Should not be modified.
  - numVertices
```
public int numVertices()
```
    Returns the number of vertices contained in this region.
    
    Returns:
    
    number of vertices in this region
  - containsVertex
```
public boolean containsVertex(Vertex3d vtx)
```
    Returns true if a specified vertex is contained in this region.
    
    Parameters:
    
    vtx - vertex to test
    
    Returns:
    
    true if vtx is in this region
  - getFaces
```
public java.util.LinkedHashSet<Face> getFaces()
```
    Returns the faces contained in this region.
    
    Returns:
    
    hash set of the region faces. Should not be modified.
  - numFaces
```
public int numFaces()
```
    Returns the number of faces contained in this region.
    
    Returns:
    
    number of faces in this region
  - containsFace
```
public boolean containsFace(Face face)
```
    Returns true if a specified face is contained in this region.
    
    Parameters:
    
    face - face to test
    
    Returns:
    
    true if face is in this region
  - getEdges
```
public java.util.LinkedHashSet<HalfEdge> getEdges()
```
    Returns the edges contained in this region. Note that only primary edges are stored, so if he is an inside edge, he.opposite will not be.
    
    Returns:
    
    hash set of region edges. Should not be modified.
  - numEdges
```
public int numEdges()
```
    Returns the number of edges contained in this region.
    
    Returns:
    
    number of edges in this region
  - containsEdge
```
public boolean containsEdge(HalfEdge he)
```
    Returns true if a specified edge is contained in this region. The test will be made using he.getPrimary(), so that if he is inside, then he.opposite will also be inside.
    
    Parameters:
    
    he - edge to test
    
    Returns:
    
    true if he or he.opposite is in this region
  - getMesh
```
public PolygonalMesh getMesh()
```
    Returns the mesh associated with this region.
    
    Returns:
    
    mesh associated with this region
  - hasClockwiseContours
```
public boolean hasClockwiseContours()
```
    Indicates if the contours of this region are oriented clockwise with respect to the region's mesh.
    
    Returns:
    
    true if contours are oriented clockwise
  - equals
```
public boolean equals(PenetrationRegion region)
```
    Returns true if this region equals another. Two regions are equal if they contain the same contours, vertices, faces and edges.
  - toString
```
public java.lang.String toString(java.util.List<IntersectionContour> contours)
```
    Returns a string representation of this region consisting of the indices of the vertices and the indices of the contours with respect to a reference list.
  - getArea
```
public double getArea()
```
    Returns the surface area for this penetration region. This is the area on this region's mesh that is bounded by the region's intersection contours.
    
    Returns:
    
    surface area of this penetration region.
  - getPositionTol
```
public double getPositionTol()
```
    Returns the position tolerance that was used to create this region. This value is set by SurfaceMeshIntersector when the region is created.
    
    Returns:
    
    position tolerance.

Class PenetrationRegion

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

debug

Constructor Detail

PenetrationRegion

Method Detail

getContours

numContours

getVertices

numVertices

containsVertex

getFaces

numFaces

containsFace

getEdges

numEdges

containsEdge

getMesh

hasClockwiseContours

equals

toString

getArea

getPositionTol