Package georegression.struct.shapes

Class Quadrilateral_F32

java.lang.Object

georegression.struct.shapes.Quadrilateral_F32

All Implemented Interfaces:

Serializable, MapFormattable

@Generated("georegression.struct.shapes.Quadrilateral_F64")
public class Quadrilateral_F32
extends Object
implements Serializable, MapFormattable

A polygon with 4 vertices, a,b,c, and d. The vertices are in order sequential order of a,b,c,d.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
Point2D_F32	a
Point2D_F32	b
Point2D_F32	c
Point2D_F32	d

Constructor Summary

Constructors

Constructor	Description
Quadrilateral_F32()
Quadrilateral_F32(float x0, float y0, float x1, float y1, float x2, float y2, float x3, float y3)
Quadrilateral_F32(Point2D_F32 a, Point2D_F32 b, Point2D_F32 c, Point2D_F32 d)
Quadrilateral_F32(Point2D_F32 a, Point2D_F32 b, Point2D_F32 c, Point2D_F32 d, boolean copy)
Quadrilateral_F32(Quadrilateral_F32 quad)

Method Summary

Modifier and Type	Method	Description
float	area()	Returns the area of this quadrilateral
List<Point2D_F32>	convert(@Nullable List<Point2D_F32> storage, boolean copy)	Converts the polygon into a list.
Quadrilateral_F32	copy()
String	formatMap(MapPrintFormat format)
Point2D_F32	get(int index)
LineSegment2D_F32	getLine(int which, LineSegment2D_F32 storage)
float	getSideLength(int which)
float	getSideLength2(int which)
boolean	isEquals(Quadrilateral_F32 quad, float tol)	Returns true if the two quadrilaterals are equal to each other to within tolerance.
void	setTo(Quadrilateral_F32 quad)
void	setTo(List<Point2D_F32> list)	Sets the polygon to be the same as the list.
String	toString()
void	zero()	Sets the value of all vertexes to be zero

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ejml.MapFormattable

formatMap

Field Details

a

public Point2D_F32 a

b

public Point2D_F32 b

c

public Point2D_F32 c

d

public Point2D_F32 d

Constructor Details

Quadrilateral_F32

public Quadrilateral_F32()

Quadrilateral_F32

public Quadrilateral_F32(Quadrilateral_F32 quad)

Quadrilateral_F32

public Quadrilateral_F32(float x0,
 float y0,
 float x1,
 float y1,
 float x2,
 float y2,
 float x3,
 float y3)

Quadrilateral_F32

public Quadrilateral_F32(Point2D_F32 a,
 Point2D_F32 b,
 Point2D_F32 c,
 Point2D_F32 d)

Quadrilateral_F32

public Quadrilateral_F32(Point2D_F32 a,
 Point2D_F32 b,
 Point2D_F32 c,
 Point2D_F32 d,
 boolean copy)

Method Details

zero

public void zero()

Sets the value of all vertexes to be zero

area

public float area()

Returns the area of this quadrilateral

Returns:

area

get

public Point2D_F32 get(int index)

getLine

public LineSegment2D_F32 getLine(int which,
 LineSegment2D_F32 storage)

getSideLength

public float getSideLength(int which)

getSideLength2

public float getSideLength2(int which)

setTo

public void setTo(Quadrilateral_F32 quad)

convert

public List<Point2D_F32> convert(@Nullable
 @Nullable List<Point2D_F32> storage,
 boolean copy)

Converts the polygon into a list.

Parameters:

storage - (Optional) storage to put the vertexes into

copy - If points will be copied otherwise a reference of points will be returned

Returns:

List of vertexes

setTo

public void setTo(List<Point2D_F32> list)

Sets the polygon to be the same as the list. A true copy is created and no references to points in the list are saved.

Parameters:

list - List which the polygon will be set to

copy

public Quadrilateral_F32 copy()

isEquals

public boolean isEquals(Quadrilateral_F32 quad,
 float tol)

Returns true if the two quadrilaterals are equal to each other to within tolerance. Equality is defined by seeing if the distance between two equivalent vertexes is within tolerance.

Parameters:

quad - The second quadrilateral

tol - Maximum allowed distance between vertexes.

Returns:

true if equals or false if not

formatMap

public String formatMap(MapPrintFormat format)

Specified by:

formatMap in interface MapFormattable

toString

public String toString()

Overrides:

toString in class Object