org.monospark.geometrix.shape.flat.polygon.model

Class PolygonModelFactory

java.lang.Object

org.monospark.geometrix.shape.flat.polygon.model.PolygonModelFactory

public final class PolygonModelFactory
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL This action value is a shortcut for (MERGE_EDGES | VERIFIY_TYPE | CHECK_EDGE_INTERSECTIONS)
static int	CHECK_EDGE_INTERSECTIONS This action value determines whether it should be checked if there are edge-edge intersections between the edges of the polygon, which are not allowed.
static int	MERGE_EDGES Since polygon models do not allow two neighboring edges with an angle of 180 degrees between them, these kind of edges have to be merged to create a valid polygon model.
static int	NONE No actions will be executed when calling createPolygonModel(PolygonModelType, LinkedHashSet, int).
static int	VERIFIY_TYPE This action value determines whether it should be checked if the polygon model fits the definition of the given polygon model type.

Method Summary

Modifier and Type	Method and Description
static java.util.Optional<PolygonModel<PolygonModelType.Convex>>	createConvexHull(java.util.Set<Vec<Two>> points) Creates a polygon hull on which all points of a given list of points lie on.
static <T extends PolygonModelType> java.util.Optional<PolygonModel<T>>	createPolygonModel(T type, java.util.LinkedHashSet<Vec<Two>> points, int actions) Creates a polygon model from an ordered set of points.
static java.util.Set<PolygonModel<PolygonModelType.Convex>>	triangulate(PolygonModel<?> p) Converts a simple polygon model into many smaller triangle models.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NONE

public static final int NONE

No actions will be executed when calling createPolygonModel(PolygonModelType, LinkedHashSet, int).

See Also:

Constant Field Values

MERGE_EDGES

public static final int MERGE_EDGES

Since polygon models do not allow two neighboring edges with an angle of 180 degrees between them, these kind of edges have to be merged to create a valid polygon model.

If it's possible that these kind of edges exist, this action value should be used when calling createPolygonModel(PolygonModelType, LinkedHashSet, int).

See Also:

Constant Field Values

VERIFIY_TYPE

public static final int VERIFIY_TYPE

This action value determines whether it should be checked if the polygon model fits the definition of the given polygon model type.

This action value should be used when calling createPolygonModel(PolygonModelType, LinkedHashSet, int) if it's possible that the polygon model and the specified polygon model type are not compatible.

See Also:

Constant Field Values

CHECK_EDGE_INTERSECTIONS

public static final int CHECK_EDGE_INTERSECTIONS

This action value determines whether it should be checked if there are edge-edge intersections between the edges of the polygon, which are not allowed.

This action value should be used when calling createPolygonModel(PolygonModelType, LinkedHashSet, int) if it's possible that the polygon can have intersecting edges.

See Also:

Constant Field Values

ALL

public static final int ALL

This action value is a shortcut for (MERGE_EDGES | VERIFIY_TYPE | CHECK_EDGE_INTERSECTIONS)

See Also:

Constant Field Values

Method Detail

createPolygonModel

public static <T extends PolygonModelType> java.util.Optional<PolygonModel<T>> createPolygonModel(T type,
                                                                                                  java.util.LinkedHashSet<Vec<Two>> points,
                                                                                                  int actions)

Creates a polygon model from an ordered set of points.

Parameters:

type - the type of the polygon model

points - the list of points out of which the polygon model should be created

actions - the actions which should be executed to verifiy that the polygon model will be valid. Multiple actions can be combined using the bitwise OR operator.

Returns:

A polygon on which every point of points lies on. If no polygon model can be created, an empty Optional will be returned.

Throws:

java.lang.NullPointerException - if type or points is null

createConvexHull

public static java.util.Optional<PolygonModel<PolygonModelType.Convex>> createConvexHull(java.util.Set<Vec<Two>> points)

Creates a polygon hull on which all points of a given list of points lie on. To create the polygon, this method uses the Quickhull algorithm.

Parameters:

points - the list of points out of which the hull should be created

Returns:

A polygon on which every point of points lies on. If no polygon model can be created, an empty Optional will be returned.

Throws:

java.lang.NullPointerException - if points is null

triangulate

public static java.util.Set<PolygonModel<PolygonModelType.Convex>> triangulate(PolygonModel<?> p)

Converts a simple polygon model into many smaller triangle models.

Parameters:

p - the polygon model which should be split into triangles

Returns:

a set of triangles which are all a part of p

Throws:

java.lang.NullPointerException - if pp is null