Module org.arakhne.afc.core.mathgeom

Package org.arakhne.afc.math.geometry.d2

Interface MultiShape2D<ST extends Shape2D<?,?,I,P,V,B>,IT extends MultiShape2D<?,?,CT,I,P,V,B>,CT extends Shape2D<?,?,I,P,V,B>,I extends PathIterator2D<?>,P extends Point2D<? super P,? super V>,V extends Vector2D<? super V,? super P>,B extends Shape2D<?,?,I,P,V,B>>

Type Parameters:

ST - is the type of the general implementation.

IT - is the type of the implementation of this multishape.

CT - is the type of the shapes that are inside this multishape.

I - is the type of the iterator used to obtain the elements of the path.

P - is the type of the points.

V - is the type of the vectors.

B - is the type of the bounding boxes.

All Superinterfaces:

Cloneable, Collection<CT>, Iterable<CT>, JsonableObject, List<CT>, Serializable, Shape2D<ST,IT,I,P,V,B>

All Known Subinterfaces:

MultiShape2afp<ST,IT,CT,IE,P,V,B>, MultiShape2ai<ST,IT,CT,IE,P,V,B>

All Known Implementing Classes:

MultiShape2d, MultiShape2dfx, MultiShape2i, MultiShape2ifx

public interface MultiShape2D<ST extends Shape2D<?,?,I,P,V,B>,IT extends MultiShape2D<?,?,CT,I,P,V,B>,CT extends Shape2D<?,?,I,P,V,B>,I extends PathIterator2D<?>,P extends Point2D<? super P,? super V>,V extends Vector2D<? super V,? super P>,B extends Shape2D<?,?,I,P,V,B>>
extends Shape2D<ST,IT,I,P,V,B>, List<CT>

Container for grouping of shapes.

The coordinates of the shapes inside the multishape are global. They are not relative to the multishape.

Since:

13.0

Version:

17.0 2020-01-04 14:41:43

Author:

Thomas PIOTROWSKI, Stéphane GALLAND

Maven Group Id:

org.arakhne.afc.core

Maven Artifact Id:

mathgeom

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	MultiShape2D.BackendIterator<CT extends Shape2D<?,?,?,?,?,?>>	Iterator on elements of a list that is able to notify the backend when the iterator has change the backend data.
static class	MultiShape2D.BackendList<CT extends Shape2D<?,?,?,?,?,?>>	View on a list that is able to notify the backend when the view has change the backend data.

Method Summary

Modifier and Type	Method	Description
default void	add(int index, CT element)
default boolean	add(CT element)
default boolean	addAll(int index, Collection<? extends CT> collection)
default boolean	addAll(Collection<? extends CT> collection)
default void	clear()	Reset this shape to be equivalent to an just-created instance of this shape type.
default boolean	contains(Object obj)
default boolean	containsAll(Collection<?> collection)
default boolean	equalsToShape(IT shape)	Replies this shape is equal to the given shape.
default CT	get(int index)
List<CT>	getBackendDataList()	Replies the list that contains the backend data.
default P	getClosestPointTo(Point2D<?,?> point)	Replies the point on the shape that is closest to the given point.
default double	getDistanceL1(Point2D<?,?> point)	Computes the L-1 (Manhattan) distance between this shape and point p1.
default double	getDistanceLinf(Point2D<?,?> point)	Computes the L-infinite distance between this shape and point p1.
default double	getDistanceSquared(Point2D<?,?> point)	Replies the squared value of the minimal distance from this shape to the given point.
default P	getFarthestPointTo(Point2D<?,?> point)	Replies the point on the shape that is farthest the given point.
default CT	getFirstShapeContaining(Point2D<?,?> point)	Get the first shape in this multishape that is containing the given point.
CT	getFirstShapeIntersecting(ST shape)	Get the first shape in this multishape that is intersecting the given shape.
default List<CT>	getShapesContaining(Point2D<?,?> point)	Get the shapes in this multishape that are containing the given point.
List<CT>	getShapesIntersecting(ST shape)	Get the shapes in this multishape that are intersecting the given shape.
default int	indexOf(Object obj)
default boolean	isEmpty()	Replies if this shape is empty.
default Iterator<CT>	iterator()
default int	lastIndexOf(Object obj)
default ListIterator<CT>	listIterator()
default ListIterator<CT>	listIterator(int index)
default void	onBackendDataChange()	Invoked each time the backend data has changed.
default CT	remove(int index)
default boolean	remove(Object element)
default boolean	removeAll(Collection<?> collection)
default boolean	retainAll(Collection<?> collection)
default CT	set(int index, CT element)
default void	set(IT shape)	Set this shape with the attributes of the given shape.
default int	size()
default List<CT>	subList(int fromIndex, int toIndex)
default Object[]	toArray()
default <T> T[]	toArray(T[] array)

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface org.arakhne.afc.vmutil.json.JsonableObject

toJson

Methods inherited from interface java.util.List

equals, hashCode, replaceAll, sort, spliterator

Methods inherited from interface org.arakhne.afc.math.geometry.d2.Shape2D

clone, contains, contains, createTransformedShape, equalsToPathIterator, getClosestPointTo, getDistance, getDistance, getDistanceSquared, getGeomFactory, getPathIterator, getPathIterator, intersects, operator_add, operator_and, operator_and, operator_minus, operator_multiply, operator_plus, operator_remove, operator_upTo, toBoundingBox, toBoundingBox, translate

Method Detail

getFirstShapeContaining

@Pure
default CT getFirstShapeContaining(Point2D<?,?> point)

Get the first shape in this multishape that is containing the given point.

Parameters:

point - the point.

Returns:

the shape, or null if no shape contains the given point.

getShapesContaining

@Pure
default List<CT> getShapesContaining(Point2D<?,?> point)

Get the shapes in this multishape that are containing the given point.

Parameters:

point - the point.

Returns:

the shapes, or an empty list.

getFirstShapeIntersecting

@Pure
CT getFirstShapeIntersecting(ST shape)

Get the first shape in this multishape that is intersecting the given shape.

Parameters:

shape - the shape.

Returns:

the shape, or null if no shape intersecting the given shape.

getShapesIntersecting

@Pure
List<CT> getShapesIntersecting(ST shape)

Get the shapes in this multishape that are intersecting the given shape.

Parameters:

shape - the shape.

Returns:

the shapes, or an empty list.

getBackendDataList

@Pure
List<CT> getBackendDataList()

Replies the list that contains the backend data.

Use this function with caution. Indeed, any change made in the replied list has no consequence on the internal attributes of this multishape object.

Returns:

the backend data list.

onBackendDataChange

default void onBackendDataChange()

Invoked each time the backend data has changed.

set

default void set(IT shape)

Description copied from interface: Shape2D

Set this shape with the attributes of the given shape.

Specified by:

set in interface Shape2D<ST extends Shape2D<?,?,I,P,V,B>,IT extends MultiShape2D<?,?,CT,I,P,V,B>,CT extends Shape2D<?,?,I,P,V,B>,I extends PathIterator2D<?>,P extends Point2D<? super P,? super V>,V extends Vector2D<? super V,? super P>>

Parameters:

shape - the shape to copy.

set

default CT set(int index,
               CT element)

Specified by:

set in interface List<ST extends Shape2D<?,?,I,P,V,B>>

equalsToShape

@Pure
default boolean equalsToShape(IT shape)

Description copied from interface: Shape2D

Replies this shape is equal to the given shape.

Specified by:

equalsToShape in interface Shape2D<ST extends Shape2D<?,?,I,P,V,B>,IT extends MultiShape2D<?,?,CT,I,P,V,B>,CT extends Shape2D<?,?,I,P,V,B>,I extends PathIterator2D<?>,P extends Point2D<? super P,? super V>,V extends Vector2D<? super V,? super P>>

Parameters:

shape - the shape to compare to.

Returns:

true if this shape is equal is equal to the given path.

clear

default void clear()

Description copied from interface: Shape2D

Reset this shape to be equivalent to an just-created instance of this shape type.

Specified by:

clear in interface Collection<ST extends Shape2D<?,?,I,P,V,B>>

Specified by:

clear in interface List<ST extends Shape2D<?,?,I,P,V,B>>

Specified by:

clear in interface Shape2D<ST extends Shape2D<?,?,I,P,V,B>,IT extends MultiShape2D<?,?,CT,I,P,V,B>,CT extends Shape2D<?,?,I,P,V,B>,I extends PathIterator2D<?>,P extends Point2D<? super P,? super V>,V extends Vector2D<? super V,? super P>>

isEmpty

@Pure
default boolean isEmpty()

Description copied from interface: Shape2D

Replies if this shape is empty. The semantic associated to the state "empty" depends on the implemented shape. See the subclasses for details.

Specified by:

isEmpty in interface Collection<ST extends Shape2D<?,?,I,P,V,B>>

Specified by:

isEmpty in interface List<ST extends Shape2D<?,?,I,P,V,B>>

Specified by:

isEmpty in interface Shape2D<ST extends Shape2D<?,?,I,P,V,B>,IT extends MultiShape2D<?,?,CT,I,P,V,B>,CT extends Shape2D<?,?,I,P,V,B>,I extends PathIterator2D<?>,P extends Point2D<? super P,? super V>,V extends Vector2D<? super V,? super P>>

Returns:

true if the shape is empty; false otherwise.

getClosestPointTo

@Pure
default P getClosestPointTo(Point2D<?,?> point)

Description copied from interface: Shape2D

Replies the point on the shape that is closest to the given point.

Specified by:

getClosestPointTo in interface Shape2D<ST extends Shape2D<?,?,I,P,V,B>,IT extends MultiShape2D<?,?,CT,I,P,V,B>,CT extends Shape2D<?,?,I,P,V,B>,I extends PathIterator2D<?>,P extends Point2D<? super P,? super V>,V extends Vector2D<? super V,? super P>>

Parameters:

point - the point.

Returns:

the closest point on the shape; or the point itself if it is inside the shape.

getFarthestPointTo

@Pure
default P getFarthestPointTo(Point2D<?,?> point)

Description copied from interface: Shape2D

Replies the point on the shape that is farthest the given point.

Specified by:

getFarthestPointTo in interface Shape2D<ST extends Shape2D<?,?,I,P,V,B>,IT extends MultiShape2D<?,?,CT,I,P,V,B>,CT extends Shape2D<?,?,I,P,V,B>,I extends PathIterator2D<?>,P extends Point2D<? super P,? super V>,V extends Vector2D<? super V,? super P>>

Parameters:

point - the point.

Returns:

the farthest point on the shape.

getDistanceSquared

@Pure
default double getDistanceSquared(Point2D<?,?> point)

Description copied from interface: Shape2D

Replies the squared value of the minimal distance from this shape to the given point.

Specified by:

getDistanceSquared in interface Shape2D<ST extends Shape2D<?,?,I,P,V,B>,IT extends MultiShape2D<?,?,CT,I,P,V,B>,CT extends Shape2D<?,?,I,P,V,B>,I extends PathIterator2D<?>,P extends Point2D<? super P,? super V>,V extends Vector2D<? super V,? super P>>

Parameters:

point - the point.

Returns:

squared value of the minimal distance between this shape and the point.

getDistanceL1

@Pure
default double getDistanceL1(Point2D<?,?> point)

Description copied from interface: Shape2D

Computes the L-1 (Manhattan) distance between this shape and point p1. The L-1 distance is equal to abs(x1-x2) + abs(y1-y2).

Specified by:

getDistanceL1 in interface Shape2D<ST extends Shape2D<?,?,I,P,V,B>,IT extends MultiShape2D<?,?,CT,I,P,V,B>,CT extends Shape2D<?,?,I,P,V,B>,I extends PathIterator2D<?>,P extends Point2D<? super P,? super V>,V extends Vector2D<? super V,? super P>>

Parameters:

point - the point

Returns:

the distance.

getDistanceLinf

@Pure
default double getDistanceLinf(Point2D<?,?> point)

Description copied from interface: Shape2D

Computes the L-infinite distance between this shape and point p1. The L-infinite distance is equal to MAX[abs(x1-x2), abs(y1-y2)].

Specified by:

getDistanceLinf in interface Shape2D<ST extends Shape2D<?,?,I,P,V,B>,IT extends MultiShape2D<?,?,CT,I,P,V,B>,CT extends Shape2D<?,?,I,P,V,B>,I extends PathIterator2D<?>,P extends Point2D<? super P,? super V>,V extends Vector2D<? super V,? super P>>

Parameters:

point - the point

Returns:

the distance.

toArray

@Pure
default Object[] toArray()

Specified by:

toArray in interface Collection<ST extends Shape2D<?,?,I,P,V,B>>

Specified by:

toArray in interface List<ST extends Shape2D<?,?,I,P,V,B>>

toArray

default <T> T[] toArray(T[] array)

Specified by:

toArray in interface Collection<ST extends Shape2D<?,?,I,P,V,B>>

Specified by:

toArray in interface List<ST extends Shape2D<?,?,I,P,V,B>>

size

@Pure
default int size()

Specified by:

size in interface Collection<ST extends Shape2D<?,?,I,P,V,B>>

Specified by:

size in interface List<ST extends Shape2D<?,?,I,P,V,B>>

contains

@Pure
default boolean contains(Object obj)

Specified by:

contains in interface Collection<ST extends Shape2D<?,?,I,P,V,B>>

Specified by:

contains in interface List<ST extends Shape2D<?,?,I,P,V,B>>

iterator

@Pure
default Iterator<CT> iterator()

Specified by:

iterator in interface Collection<ST extends Shape2D<?,?,I,P,V,B>>

Specified by:

iterator in interface Iterable<ST extends Shape2D<?,?,I,P,V,B>>

Specified by:

iterator in interface List<ST extends Shape2D<?,?,I,P,V,B>>

add

default boolean add(CT element)

Specified by:

add in interface Collection<ST extends Shape2D<?,?,I,P,V,B>>

Specified by:

add in interface List<ST extends Shape2D<?,?,I,P,V,B>>

add

default void add(int index,
                 CT element)

Specified by:

add in interface List<ST extends Shape2D<?,?,I,P,V,B>>

remove

default boolean remove(Object element)

Specified by:

remove in interface Collection<ST extends Shape2D<?,?,I,P,V,B>>

Specified by:

remove in interface List<ST extends Shape2D<?,?,I,P,V,B>>

remove

default CT remove(int index)

Specified by:

remove in interface List<ST extends Shape2D<?,?,I,P,V,B>>

containsAll

@Pure
default boolean containsAll(Collection<?> collection)

Specified by:

containsAll in interface Collection<ST extends Shape2D<?,?,I,P,V,B>>

Specified by:

containsAll in interface List<ST extends Shape2D<?,?,I,P,V,B>>

addAll

default boolean addAll(Collection<? extends CT> collection)

Specified by:

addAll in interface Collection<ST extends Shape2D<?,?,I,P,V,B>>

Specified by:

addAll in interface List<ST extends Shape2D<?,?,I,P,V,B>>

addAll

default boolean addAll(int index,
                       Collection<? extends CT> collection)

Specified by:

addAll in interface List<ST extends Shape2D<?,?,I,P,V,B>>

removeAll

default boolean removeAll(Collection<?> collection)

Specified by:

removeAll in interface Collection<ST extends Shape2D<?,?,I,P,V,B>>

Specified by:

removeAll in interface List<ST extends Shape2D<?,?,I,P,V,B>>

retainAll

default boolean retainAll(Collection<?> collection)

Specified by:

retainAll in interface Collection<ST extends Shape2D<?,?,I,P,V,B>>

Specified by:

retainAll in interface List<ST extends Shape2D<?,?,I,P,V,B>>

get

@Pure
default CT get(int index)

Specified by:

get in interface List<ST extends Shape2D<?,?,I,P,V,B>>

indexOf

@Pure
default int indexOf(Object obj)

Specified by:

indexOf in interface List<ST extends Shape2D<?,?,I,P,V,B>>

lastIndexOf

@Pure
default int lastIndexOf(Object obj)

Specified by:

lastIndexOf in interface List<ST extends Shape2D<?,?,I,P,V,B>>

listIterator

@Pure
default ListIterator<CT> listIterator()

Specified by:

listIterator in interface List<ST extends Shape2D<?,?,I,P,V,B>>

listIterator

@Pure
default ListIterator<CT> listIterator(int index)

Specified by:

listIterator in interface List<ST extends Shape2D<?,?,I,P,V,B>>

subList

default List<CT> subList(int fromIndex,
                         int toIndex)

Specified by:

subList in interface List<ST extends Shape2D<?,?,I,P,V,B>>