eu.printingin3d.javascad.models2d

Class Area2d

java.lang.Object

java.util.AbstractCollection<Coords2d>

eu.printingin3d.javascad.models2d.Area2d

All Implemented Interfaces:

Iterable<Coords2d>, Collection<Coords2d>

public class Area2d
extends AbstractCollection<Coords2d>

Represents a list of 2D points.

Constructor Summary

Constructors

Constructor and Description
Area2d(List<Coords2d> coords) Instantiate a new object with the given list of coordinates.

Method Summary

Modifier and Type	Method and Description
PointRelation	calculatePointRelation(Coords2d p) Calculates the relation of the given point and this area.
List<Coords2d>	findCrossing(LineSegment2d segment, boolean includeEndPoints) Checks if the given line segment has crossing with this geometric form.
Coords2d	get(int index) Gives access to the points of this area.
boolean	isDistinct(Area2d other) Checks if the two list of coordinates are distinct.
Iterator<Coords2d>	iterator()
Area2d	move(Coords2d move) Moves this list of coordinates with the given coordinate.
Area2d	reverse() Creates a new object where the order of the points are reversed.
Area2d	rotate(Angle angle) Rotates this list of coordinates with the given degree.
int	size() Returns with the number of points this area consists.
Area2d	subList(Coords2d first, Coords2d last) Returns with a list of coordinates which contains the coordinates from first to last inclusive.
Area2d	subList(int start, int end) Returns with a list of coordinates which contains the coordinates indexed from start to end inclusive.
String	toString()
Area2d	union(Area2d other) Creates a new object which covers the union of this and the given area.
List<Coords3d>	withZ(double z) Extends this list of 2D coordinates to a 3D list of coordinates.

Methods inherited from class java.util.AbstractCollection

add, addAll, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

Area2d

public Area2d(List<Coords2d> coords)

Instantiate a new object with the given list of coordinates.

Parameters:

coords - the coordinates to be used

Method Detail

move

public Area2d move(Coords2d move)

Moves this list of coordinates with the given coordinate. Creates a new object, this object remains untouched.

Parameters:

move - the coordinate move with

Returns:

a new object with the new coordinates

rotate

public Area2d rotate(Angle angle)

Rotates this list of coordinates with the given degree. Creates a new object, this object remains untouched.

Parameters:

angle - the angle in degree to rotate with

Returns:

a new object with the new coordinates

withZ

public List<Coords3d> withZ(double z)

Extends this list of 2D coordinates to a 3D list of coordinates.

Parameters:

z - the Z value to be used for the transformation

Returns:

a list of 3D coordinates

iterator

public Iterator<Coords2d> iterator()

Specified by:

iterator in interface Iterable<Coords2d>

Specified by:

iterator in interface Collection<Coords2d>

Specified by:

iterator in class AbstractCollection<Coords2d>

union

public Area2d union(Area2d other)

Creates a new object which covers the union of this and the given area.

Parameters:

other - the other area to be used

Returns:

a new object which holds the union of the two areas

findCrossing

public List<Coords2d> findCrossing(LineSegment2d segment,
                                   boolean includeEndPoints)

Checks if the given line segment has crossing with this geometric form.

Parameters:

segment - the line segment

includeEndPoints - if the cross point is one of the two given end points this method will return null if this parameter is false

Returns:

true if and only if the given line segment crosses any line segment of area.

isDistinct

public boolean isDistinct(Area2d other)

Checks if the two list of coordinates are distinct.

Parameters:

other - the other list of coordinates

Returns:

true if and only if the two list of coordinates are distinct

calculatePointRelation

public PointRelation calculatePointRelation(Coords2d p)

Calculates the relation of the given point and this area.

Parameters:

p - the point to be checked

Returns:

returns with INSIDE if the point is inside of this area;
returns with OUTSIDE if the point is outside of this area;
returns with BORDER if the point is on the border of this area.

reverse

public Area2d reverse()

Creates a new object where the order of the points are reversed.

Returns:

new object with reversed point order

get

public Coords2d get(int index)

Gives access to the points of this area.

Parameters:

index - the index of the point we want to get.

Returns:

the indexth point of this area.

size

public int size()

Returns with the number of points this area consists.

Specified by:

size in interface Collection<Coords2d>

Specified by:

size in class AbstractCollection<Coords2d>

Returns:

the number of points

subList

public Area2d subList(int start,
                      int end)

Returns with a list of coordinates which contains the coordinates indexed from start to end inclusive. The end index can be smaller then start index in which case the values are start over after the last item and start from zero.

Parameters:

start - the first index to include

end - the last index to include

Returns:

a new list object

subList

public Area2d subList(Coords2d first,
                      Coords2d last)

Returns with a list of coordinates which contains the coordinates from first to last inclusive. The last item can be before then first in which case the values are start over after the last item and start from first.

Parameters:

first - the first item to include

last - the last item to include

Returns:

a new list object

toString

public String toString()

Overrides:

toString in class AbstractCollection<Coords2d>