uk.co.strangeskies.mathematics.geometry.shape

Interface ConvexPolygon<S extends ConvexPolygon<S,V>,V extends Value<V>>

Type Parameters:

V - The type of value for the coordinate system of the polygon

All Superinterfaces:

ANDable<CompoundPolygon<?,V>,CompoundPolygon<?,V>>, BooleanCombinationBehaviour<CompoundPolygon<?,V>,CompoundPolygon<?,V>>, ComplexPolygon<S,V>, CompoundPolygon<S,V>, Copyable<S>, Expression<S>, NANDable<CompoundPolygon<?,V>,CompoundPolygon<?,V>>, NORable<CompoundPolygon<?,V>,CompoundPolygon<?,V>>, ORable<CompoundPolygon<?,V>,CompoundPolygon<?,V>>, Self<S>, SelfExpression<S>, Shape<S>, SimplePolygon<S,V>, XNORable<CompoundPolygon<?,V>,CompoundPolygon<?,V>>, XORable<CompoundPolygon<?,V>,CompoundPolygon<?,V>>

All Known Subinterfaces:

Triangle<V>

public interface ConvexPolygon<S extends ConvexPolygon<S,V>,V extends Value<V>>
extends SimplePolygon<S,V>

Nested Class Summary

Nested classes/interfaces inherited from interface uk.co.strangeskies.mathematics.geometry.shape.SimplePolygon

SimplePolygon.WindingDirection

Nested classes/interfaces inherited from interface uk.co.strangeskies.mathematics.geometry.shape.CompoundPolygon

CompoundPolygon.WindingRule

Method Summary

Modifier and Type	Method and Description
default CompoundPolygon<?,V>	and(CompoundPolygon<?,V> value)
java.util.Set<Vector2<V>>	hullVertexSet() This method returns a modifiable set containing all vertices which currently effectively make a contribution to the convex Hull of this Polygon, i.e.
java.util.Set<Vector2<V>>	vertexSet() This method returns a modifiable set representing the underlying collection of vertices from which the convex hull represented by this polygon is generated.

Methods inherited from interface uk.co.strangeskies.mathematics.geometry.shape.SimplePolygon

getArea, getSignedArea, getWindingDirection, windingRule

Methods inherited from interface uk.co.strangeskies.mathematics.geometry.shape.ComplexPolygon

boundary, boundaryComponents, nand, nor, or, xnor, xor

Methods inherited from interface uk.co.strangeskies.mathematics.geometry.shape.CompoundPolygon

contains, getAnd, getBounds, getNand, getNor, getOr, getPerimeter, getXnor, getXor, touches

Methods inherited from interface uk.co.strangeskies.mathematics.geometry.shape.Shape

intersects, touches

Methods inherited from interface uk.co.strangeskies.utility.Copyable

copy, deepCopy

Methods inherited from interface uk.co.strangeskies.expression.Expression

anonymize, decoupleValue, getValue, immutable, invalidations, over, over

Methods inherited from interface uk.co.strangeskies.utility.Self

getThis

Method Detail

hullVertexSet

java.util.Set<Vector2<V>> hullVertexSet()

This method returns a modifiable set containing all vertices which currently effectively make a contribution to the convex Hull of this Polygon, i.e. all vertices which form a part of the outside edge and are returned by the vertexSet(). The Set is backed by the shape and changes will be reflected in it. If vertices are moved around such that the convex hull changes any set previously returned will reflect this change. Adding vertices to the set will succeed if they are not already present, and fall outside the current perimeter of the shape, and the shape will be updated to reflect the addition. If the vertices being added lie within the perimeter the addition to the set will fail and the underlying model will not be changed. If more than one vertex is added at the same time, only those which remain a part of this set after they have all been added will remain a part of the underlying model.

Returns:

The vertices describing the convex hull of the polygon

vertexSet

java.util.Set<Vector2<V>> vertexSet()

This method returns a modifiable set representing the underlying collection of vertices from which the convex hull represented by this polygon is generated. This set may contain vertices which lie within the convex hull, such that on removal of other vertices, or movement of vertices, they may become a part of the convex hull. The Set is backed by the shape and changes will be reflected in it. If vertices are added or removed from the shape, they will be added to or removed from this set. Adding vertices to the set will always succeed if they are not already present.

Returns:

The vertices contained within this polygon

and

default CompoundPolygon<?,V> and(CompoundPolygon<?,V> value)

Specified by:

and in interface ANDable<CompoundPolygon<?,V extends Value<V>>,CompoundPolygon<?,V extends Value<V>>>

Specified by:

and in interface CompoundPolygon<S extends ConvexPolygon<S,V>,V extends Value<V>>