Module org.arakhne.afc.advanced.mathfx

Package org.arakhne.afc.math.geometry.d1.dfx

Class Rectangle1dfx

java.lang.Object

org.arakhne.afc.math.geometry.d1.dfx.AbstractShape1dfx<Rectangle1dfx>

org.arakhne.afc.math.geometry.d1.dfx.Rectangle1dfx

All Implemented Interfaces:

Serializable, Cloneable, Rectangle1afp<Shape1dfx<?>,Rectangle1dfx,Point1dfx,Vector1dfx,Segment1D<?,?>,Rectangle1dfx>, RectangularShape1afp<Shape1dfx<?>,Rectangle1dfx,Point1dfx,Vector1dfx,Segment1D<?,?>,Rectangle1dfx>, Shape1afp<Shape1dfx<?>,Rectangle1dfx,Point1dfx,Vector1dfx,Segment1D<?,?>,Rectangle1dfx>, Shape1dfx<Rectangle1dfx>, Shape1D<Shape1dfx<?>,Rectangle1dfx,Point1dfx,Vector1dfx,Segment1D<?,?>,Rectangle1dfx>, JsonableObject

public class Rectangle1dfx
extends AbstractShape1dfx<Rectangle1dfx>
implements Rectangle1afp<Shape1dfx<?>,Rectangle1dfx,Point1dfx,Vector1dfx,Segment1D<?,?>,Rectangle1dfx>

A rectangle with 2 double precision floating-point numbers.

Since:

14.0

Version:

17.0 2020-01-04 14:41:49

Author:

Stéphane GALLAND

See Also:

Serialized Form

Maven Group Id:

org.arakhne.afc.advanced

Maven Artifact Id:

mathfx

Field Summary

Fields

Modifier and Type	Field	Description
(package private) javafx.beans.property.DoubleProperty	height	height property.
(package private) javafx.beans.property.DoubleProperty	maxX	maxX property.
(package private) javafx.beans.property.DoubleProperty	maxY	maxY property.
(package private) javafx.beans.property.DoubleProperty	minX	minX property.
(package private) javafx.beans.property.DoubleProperty	minY	minY property.
(package private) javafx.beans.property.DoubleProperty	width	width property.

Fields inherited from class org.arakhne.afc.math.geometry.d1.dfx.AbstractShape1dfx

boundingBox, segment

Constructor Summary

Constructors

Constructor	Description
Rectangle1dfx()	Construct an empty rectangle.
Rectangle1dfx(Rectangle1dfx rectangle)	Constructor by copy.
Rectangle1dfx(Point1D<?,?,?> min, Point1D<?,?,?> max)	Construct a rectangle with the given minimum and maxium corners.
Rectangle1dfx(Segment1D<?,?> segment, double x, double y, double width, double height)	Construct a rectangle with the given minimum corner and sizes.

Method Summary

Modifier and Type	Method	Description
javafx.beans.property.ObjectProperty<Rectangle1dfx>	boundingBoxProperty()	Replies the property that contains the bounding box for this shape.
double	getHeight()	Replies the height.
double	getMaxX()	Replies the max x.
double	getMaxY()	Replies the max y.
double	getMinX()	Replies the min X.
double	getMinY()	Replies the min y.
double	getWidth()	Replies the width.
int	hashCode()
javafx.beans.property.DoubleProperty	heightProperty()	Replies the property that is the height of the box.
javafx.beans.property.DoubleProperty	maxXProperty()	Replies the property that is the maximum x coordinate of the box.
javafx.beans.property.DoubleProperty	maxYProperty()	Replies the property that is the maximum y coordinate of the box.
javafx.beans.property.DoubleProperty	minXProperty()	Replies the property that is the minimum x coordinate of the box.
javafx.beans.property.DoubleProperty	minYProperty()	Replies the property that is the minimum y coordinate of the box.
void	setFromCorners(double x1, double y1, double x2, double y2)	Change the frame of the rectangle conserving previous min and max if needed.
void	setMaxX(double x)	Set the max X conserving previous max if needed.
void	setMaxY(double y)	Set the max Y conserving previous max if needed.
void	setMinX(double x)	Set the min X conserving previous min if needed.
void	setMinY(double y)	Set the min Y conserving previous min if needed.
javafx.beans.property.DoubleProperty	widthProperty()	Replies the property that is the width of the box.

Methods inherited from class org.arakhne.afc.math.geometry.d1.dfx.AbstractShape1dfx

clone, equals, getGeomFactory, getSegment, segmentProperty, setSegment, toJson, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

toJson

Methods inherited from interface org.arakhne.afc.math.geometry.d1.afp.Rectangle1afp

contains, contains, equalsToShape, getClosestPointTo, getClosestPointTo, getDistanceL1, getDistanceLinf, getDistanceSquared, getFarthestPointTo, intersects

Methods inherited from interface org.arakhne.afc.math.geometry.d1.afp.RectangularShape1afp

clear, getCenter, getCenterX, getCenterY, inflate, isEmpty, set, set, set, setFromCenter, setFromCenter, setFromCorners, setHeight, setWidth, toBoundingBox, translate

Methods inherited from interface org.arakhne.afc.math.geometry.d1.afp.Shape1afp

contains, contains, getClosestPointTo, getDistanceSquared, getDistanceSquared, getGeomFactory, intersects, toBoundingBox, translate

Methods inherited from interface org.arakhne.afc.math.geometry.d1.Shape1D

clone, getDistance, getDistance, getSegment, operator_add, operator_and, operator_and, operator_minus, operator_plus, operator_remove, operator_upTo, setSegment

Field Detail

minX

javafx.beans.property.DoubleProperty minX

minX property.

minY

javafx.beans.property.DoubleProperty minY

minY property.

maxX

javafx.beans.property.DoubleProperty maxX

maxX property.

maxY

javafx.beans.property.DoubleProperty maxY

maxY property.

width

javafx.beans.property.DoubleProperty width

width property.

height

javafx.beans.property.DoubleProperty height

height property.

Constructor Detail

Rectangle1dfx

public Rectangle1dfx()

Construct an empty rectangle.

Rectangle1dfx

public Rectangle1dfx(Point1D<?,?,?> min,
                     Point1D<?,?,?> max)

Construct a rectangle with the given minimum and maxium corners.

Parameters:

min - is the min corner of the rectangle.

max - is the max corner of the rectangle.

Rectangle1dfx

public Rectangle1dfx(Segment1D<?,?> segment,
                     double x,
                     double y,
                     double width,
                     double height)

Construct a rectangle with the given minimum corner and sizes.

Parameters:

segment - the segment.

x - x coordinate of the minimum corner.

y - y coordinate of the minimum corner.

width - width of the rectangle.

height - height of the rectangle.

Rectangle1dfx

public Rectangle1dfx(Rectangle1dfx rectangle)

Constructor by copy.

Parameters:

rectangle - the rectangle to copy.

Method Detail

hashCode

@Pure
public int hashCode()

Specified by:

hashCode in class AbstractShape1dfx<Rectangle1dfx>

getMinX

@Pure
public double getMinX()

Description copied from interface: RectangularShape1afp

Replies the min X.

Specified by:

getMinX in interface RectangularShape1afp<Shape1dfx<?>,Rectangle1dfx,Point1dfx,Vector1dfx,Segment1D<?,?>,Rectangle1dfx>

Returns:

the min x.

setMinX

public void setMinX(double x)

Description copied from interface: RectangularShape1afp

Set the min X conserving previous min if needed.

Specified by:

setMinX in interface RectangularShape1afp<Shape1dfx<?>,Rectangle1dfx,Point1dfx,Vector1dfx,Segment1D<?,?>,Rectangle1dfx>

Parameters:

x - the min x.

minXProperty

@Pure
public javafx.beans.property.DoubleProperty minXProperty()

Replies the property that is the minimum x coordinate of the box.

Returns:

the minX property.

getMaxX

@Pure
public double getMaxX()

Description copied from interface: RectangularShape1afp

Replies the max x.

Specified by:

getMaxX in interface RectangularShape1afp<Shape1dfx<?>,Rectangle1dfx,Point1dfx,Vector1dfx,Segment1D<?,?>,Rectangle1dfx>

Returns:

the max x.

setMaxX

public void setMaxX(double x)

Description copied from interface: RectangularShape1afp

Set the max X conserving previous max if needed.

Specified by:

setMaxX in interface RectangularShape1afp<Shape1dfx<?>,Rectangle1dfx,Point1dfx,Vector1dfx,Segment1D<?,?>,Rectangle1dfx>

Parameters:

x - the max x.

maxXProperty

@Pure
public javafx.beans.property.DoubleProperty maxXProperty()

Replies the property that is the maximum x coordinate of the box.

Returns:

the maxX property.

getMinY

@Pure
public double getMinY()

Description copied from interface: RectangularShape1afp

Replies the min y.

Specified by:

getMinY in interface RectangularShape1afp<Shape1dfx<?>,Rectangle1dfx,Point1dfx,Vector1dfx,Segment1D<?,?>,Rectangle1dfx>

Returns:

the min y.

setMinY

public void setMinY(double y)

Description copied from interface: RectangularShape1afp

Set the min Y conserving previous min if needed.

Specified by:

setMinY in interface RectangularShape1afp<Shape1dfx<?>,Rectangle1dfx,Point1dfx,Vector1dfx,Segment1D<?,?>,Rectangle1dfx>

Parameters:

y - the min y.

minYProperty

@Pure
public javafx.beans.property.DoubleProperty minYProperty()

Replies the property that is the minimum y coordinate of the box.

Returns:

the minY property.

getMaxY

@Pure
public double getMaxY()

Description copied from interface: RectangularShape1afp

Replies the max y.

Specified by:

getMaxY in interface RectangularShape1afp<Shape1dfx<?>,Rectangle1dfx,Point1dfx,Vector1dfx,Segment1D<?,?>,Rectangle1dfx>

Returns:

the max y.

setMaxY

public void setMaxY(double y)

Description copied from interface: RectangularShape1afp

Set the max Y conserving previous max if needed.

Specified by:

setMaxY in interface RectangularShape1afp<Shape1dfx<?>,Rectangle1dfx,Point1dfx,Vector1dfx,Segment1D<?,?>,Rectangle1dfx>

Parameters:

y - the max y.

maxYProperty

@Pure
public javafx.beans.property.DoubleProperty maxYProperty()

Replies the property that is the maximum y coordinate of the box.

Returns:

the maxY property.

getWidth

public double getWidth()

Description copied from interface: RectangularShape1afp

Replies the width.

Specified by:

getWidth in interface RectangularShape1afp<Shape1dfx<?>,Rectangle1dfx,Point1dfx,Vector1dfx,Segment1D<?,?>,Rectangle1dfx>

Returns:

the width.

widthProperty

@Pure
public javafx.beans.property.DoubleProperty widthProperty()

Replies the property that is the width of the box.

Returns:

the width property.

getHeight

public double getHeight()

Description copied from interface: RectangularShape1afp

Replies the height.

Specified by:

getHeight in interface RectangularShape1afp<Shape1dfx<?>,Rectangle1dfx,Point1dfx,Vector1dfx,Segment1D<?,?>,Rectangle1dfx>

Returns:

the height.

heightProperty

@Pure
public javafx.beans.property.DoubleProperty heightProperty()

Replies the property that is the height of the box.

Returns:

the height property.

setFromCorners

public void setFromCorners(double x1,
                           double y1,
                           double x2,
                           double y2)

Description copied from interface: RectangularShape1afp

Change the frame of the rectangle conserving previous min and max if needed.

Specified by:

setFromCorners in interface RectangularShape1afp<Shape1dfx<?>,Rectangle1dfx,Point1dfx,Vector1dfx,Segment1D<?,?>,Rectangle1dfx>

Parameters:

x1 - is the coordinate of the first corner.

y1 - is the coordinate of the first corner.

x2 - is the coordinate of the second corner.

y2 - is the coordinate of the second corner.

boundingBoxProperty

public javafx.beans.property.ObjectProperty<Rectangle1dfx> boundingBoxProperty()

Description copied from interface: Shape1dfx

Replies the property that contains the bounding box for this shape.

Specified by:

boundingBoxProperty in interface Shape1dfx<Rectangle1dfx>

Returns:

the bounding box.