Module org.arakhne.afc.advanced.mathfx

Package org.arakhne.afc.math.geometry.d3.ifx

Class AbstractRectangularShape3ifx<IT extends AbstractRectangularShape3ifx<?>>

java.lang.Object

org.arakhne.afc.math.geometry.d3.ifx.AbstractShape3ifx<IT>

org.arakhne.afc.math.geometry.d3.ifx.AbstractRectangularShape3ifx<IT>

Type Parameters:

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

All Implemented Interfaces:

Serializable, Cloneable, Prism3ai<Shape3ifx<?>,IT,PathElement3ifx,Point3ifx,Vector3ifx,RectangularPrism3ifx>, Shape3ai<Shape3ifx<?>,IT,PathElement3ifx,Point3ifx,Vector3ifx,RectangularPrism3ifx>, Shape3ifx<IT>, Shape3D<Shape3ifx<?>,IT,PathIterator3ai<PathElement3ifx>,Point3ifx,Vector3ifx,RectangularPrism3ifx>, JsonableObject

public abstract class AbstractRectangularShape3ifx<IT extends AbstractRectangularShape3ifx<?>>
extends AbstractShape3ifx<IT>
implements Prism3ai<Shape3ifx<?>,IT,PathElement3ifx,Point3ifx,Vector3ifx,RectangularPrism3ifx>

A rectangular shape with 3 integer FX properties.

Since:

13.0

Version:

17.0 2020-01-04 14:41:49

Author:

Stéphane GALLAND, Thomas PIOTROWSKI

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) Point3ifx	max	maxX property.
(package private) Point3ifx	min	minX property.

Fields inherited from class org.arakhne.afc.math.geometry.d3.ifx.AbstractShape3ifx

boundingBox

Constructor Summary

Constructors

Constructor	Description
AbstractRectangularShape3ifx()	Construct an empty rectangular shape.
AbstractRectangularShape3ifx(Prism3ai<?,?,?,?,?,?> shape)	Constructor by copy.

Method Summary

Modifier and Type	Method	Description
javafx.beans.property.ObjectProperty<RectangularPrism3ifx>	boundingBoxProperty()	Replies the property that contains the bounding box for this shape.
IT	clone()	Clone this shape.
javafx.beans.property.IntegerProperty	depthProperty()	Replies the property that is the depth of the box.
int	getDepth()	Replies the depth.
int	getHeight()	Replies the height.
int	getMaxX()	Replies the max x.
int	getMaxY()	Replies the max y.
int	getMaxZ()	Replies the max z.
int	getMinX()	Replies the min X.
int	getMinY()	Replies the min y.
int	getMinZ()	Replies the min z.
int	getWidth()	Replies the width.
int	hashCode()
javafx.beans.property.IntegerProperty	heightProperty()	Replies the property that is the height of the box.
javafx.beans.property.IntegerProperty	maxXProperty()	Replies the property that is the maximum x coordinate of the box.
javafx.beans.property.IntegerProperty	maxYProperty()	Replies the property that is the maximum y coordinate of the box.
javafx.beans.property.IntegerProperty	maxZProperty()	Replies the property that is the maximum z coordinate of the box.
javafx.beans.property.IntegerProperty	minXProperty()	Replies the property that is the minimum x coordinate of the box.
javafx.beans.property.IntegerProperty	minYProperty()	Replies the property that is the minimum y coordinate of the box.
javafx.beans.property.IntegerProperty	minZProperty()	Replies the property that is the minimum z coordinate of the box.
void	setFromCorners(int x1, int y1, int z1, int x2, int y2, int z2)	Change the frame of the prism conserving previous min and max if needed.
void	setMaxX(int x)	Set the max X conserving previous max if needed.
void	setMaxY(int y)	Set the max Y conserving previous max if needed.
void	setMaxZ(int z)	Set the max Z conserving previous max if needed.
void	setMinX(int x)	Set the min X conserving previous min if needed.
void	setMinY(int y)	Set the min Y conserving previous min if needed.
void	setMinZ(int z)	Set the min Z conserving previous min if needed.
javafx.beans.property.IntegerProperty	widthProperty()	Replies the property that is the width of the box.

Methods inherited from class org.arakhne.afc.math.geometry.d3.ifx.AbstractShape3ifx

equals, getGeomFactory, 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.d3.ai.Prism3ai

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

Methods inherited from interface org.arakhne.afc.math.geometry.d3.ai.Shape3ai

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

Methods inherited from interface org.arakhne.afc.math.geometry.d3.Shape3D

equalsToPathIterator, equalsToShape, getClosestPointTo, getDistance, getDistance, getDistanceL1, getDistanceLinf, getDistanceSquared, getFarthestPointTo, getPathIterator, getPathIterator, operator_add, operator_and, operator_and, operator_minus, operator_multiply, operator_plus, operator_remove, operator_upTo, set

Field Detail

min

Point3ifx min

minX property.

max

Point3ifx max

maxX property.

Constructor Detail

AbstractRectangularShape3ifx

public AbstractRectangularShape3ifx()

Construct an empty rectangular shape.

AbstractRectangularShape3ifx

public AbstractRectangularShape3ifx(Prism3ai<?,?,?,?,?,?> shape)

Constructor by copy.

Parameters:

shape - the shape to copy.

Method Detail

clone

public IT clone()

Description copied from interface: Shape3D

Clone this shape.

Specified by:

clone in interface Shape3D<Shape3ifx<?>,IT extends AbstractRectangularShape3ifx<?>,PathIterator3ai<PathElement3ifx>,Point3ifx,Vector3ifx,RectangularPrism3ifx>

Overrides:

clone in class AbstractShape3ifx<IT extends AbstractRectangularShape3ifx<?>>

Returns:

the clone.

setFromCorners

public void setFromCorners(int x1,
                           int y1,
                           int z1,
                           int x2,
                           int y2,
                           int z2)

Description copied from interface: Prism3ai

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

Specified by:

setFromCorners in interface Prism3ai<Shape3ifx<?>,IT extends AbstractRectangularShape3ifx<?>,PathElement3ifx,Point3ifx,Vector3ifx,RectangularPrism3ifx>

Parameters:

x1 - is the coordinate of the first corner.

y1 - is the coordinate of the first corner.

z1 - is the coordinate of the first corner.

x2 - is the coordinate of the second corner.

y2 - is the coordinate of the second corner.

z2 - is the coordinate of the first corner.

getMinX

@Pure
public int getMinX()

Description copied from interface: Prism3ai

Replies the min X.

Specified by:

getMinX in interface Prism3ai<Shape3ifx<?>,IT extends AbstractRectangularShape3ifx<?>,PathElement3ifx,Point3ifx,Vector3ifx,RectangularPrism3ifx>

Returns:

the min x.

setMinX

public void setMinX(int x)

Description copied from interface: Prism3ai

Set the min X conserving previous min if needed.

Specified by:

setMinX in interface Prism3ai<Shape3ifx<?>,IT extends AbstractRectangularShape3ifx<?>,PathElement3ifx,Point3ifx,Vector3ifx,RectangularPrism3ifx>

Parameters:

x - the min x.

minXProperty

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

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

Returns:

the minX property.

getMaxX

@Pure
public int getMaxX()

Description copied from interface: Prism3ai

Replies the max x.

Specified by:

getMaxX in interface Prism3ai<Shape3ifx<?>,IT extends AbstractRectangularShape3ifx<?>,PathElement3ifx,Point3ifx,Vector3ifx,RectangularPrism3ifx>

Returns:

the max x.

setMaxX

public void setMaxX(int x)

Description copied from interface: Prism3ai

Set the max X conserving previous max if needed.

Specified by:

setMaxX in interface Prism3ai<Shape3ifx<?>,IT extends AbstractRectangularShape3ifx<?>,PathElement3ifx,Point3ifx,Vector3ifx,RectangularPrism3ifx>

Parameters:

x - the max x.

maxXProperty

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

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

Returns:

the maxX property.

getMinY

@Pure
public int getMinY()

Description copied from interface: Prism3ai

Replies the min y.

Specified by:

getMinY in interface Prism3ai<Shape3ifx<?>,IT extends AbstractRectangularShape3ifx<?>,PathElement3ifx,Point3ifx,Vector3ifx,RectangularPrism3ifx>

Returns:

the min y.

setMinY

public void setMinY(int y)

Description copied from interface: Prism3ai

Set the min Y conserving previous min if needed.

Specified by:

setMinY in interface Prism3ai<Shape3ifx<?>,IT extends AbstractRectangularShape3ifx<?>,PathElement3ifx,Point3ifx,Vector3ifx,RectangularPrism3ifx>

Parameters:

y - the min y.

minYProperty

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

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

Returns:

the minY property.

getMaxY

@Pure
public int getMaxY()

Description copied from interface: Prism3ai

Replies the max y.

Specified by:

getMaxY in interface Prism3ai<Shape3ifx<?>,IT extends AbstractRectangularShape3ifx<?>,PathElement3ifx,Point3ifx,Vector3ifx,RectangularPrism3ifx>

Returns:

the max y.

setMaxY

public void setMaxY(int y)

Description copied from interface: Prism3ai

Set the max Y conserving previous max if needed.

Specified by:

setMaxY in interface Prism3ai<Shape3ifx<?>,IT extends AbstractRectangularShape3ifx<?>,PathElement3ifx,Point3ifx,Vector3ifx,RectangularPrism3ifx>

Parameters:

y - the max y.

maxYProperty

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

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

Returns:

the maxY property.

getMinZ

@Pure
public int getMinZ()

Description copied from interface: Prism3ai

Replies the min z.

Specified by:

getMinZ in interface Prism3ai<Shape3ifx<?>,IT extends AbstractRectangularShape3ifx<?>,PathElement3ifx,Point3ifx,Vector3ifx,RectangularPrism3ifx>

Returns:

the min z.

setMinZ

public void setMinZ(int z)

Description copied from interface: Prism3ai

Set the min Z conserving previous min if needed.

Specified by:

setMinZ in interface Prism3ai<Shape3ifx<?>,IT extends AbstractRectangularShape3ifx<?>,PathElement3ifx,Point3ifx,Vector3ifx,RectangularPrism3ifx>

Parameters:

z - the min z.

minZProperty

@Pure
public javafx.beans.property.IntegerProperty minZProperty()

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

Returns:

the minZ property.

getMaxZ

@Pure
public int getMaxZ()

Description copied from interface: Prism3ai

Replies the max z.

Specified by:

getMaxZ in interface Prism3ai<Shape3ifx<?>,IT extends AbstractRectangularShape3ifx<?>,PathElement3ifx,Point3ifx,Vector3ifx,RectangularPrism3ifx>

Returns:

the max z.

setMaxZ

public void setMaxZ(int z)

Description copied from interface: Prism3ai

Set the max Z conserving previous max if needed.

Specified by:

setMaxZ in interface Prism3ai<Shape3ifx<?>,IT extends AbstractRectangularShape3ifx<?>,PathElement3ifx,Point3ifx,Vector3ifx,RectangularPrism3ifx>

Parameters:

z - the max z.

maxZProperty

@Pure
public javafx.beans.property.IntegerProperty maxZProperty()

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

Returns:

the maxZ property.

hashCode

@Pure
public int hashCode()

Specified by:

hashCode in class AbstractShape3ifx<IT extends AbstractRectangularShape3ifx<?>>

getWidth

public int getWidth()

Description copied from interface: Prism3ai

Replies the width.

Specified by:

getWidth in interface Prism3ai<Shape3ifx<?>,IT extends AbstractRectangularShape3ifx<?>,PathElement3ifx,Point3ifx,Vector3ifx,RectangularPrism3ifx>

Returns:

the width.

widthProperty

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

Replies the property that is the width of the box.

Returns:

the width property.

getHeight

public int getHeight()

Description copied from interface: Prism3ai

Replies the height.

Specified by:

getHeight in interface Prism3ai<Shape3ifx<?>,IT extends AbstractRectangularShape3ifx<?>,PathElement3ifx,Point3ifx,Vector3ifx,RectangularPrism3ifx>

Returns:

the height.

heightProperty

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

Replies the property that is the height of the box.

Returns:

the height property.

getDepth

public int getDepth()

Description copied from interface: Prism3ai

Replies the depth.

Specified by:

getDepth in interface Prism3ai<Shape3ifx<?>,IT extends AbstractRectangularShape3ifx<?>,PathElement3ifx,Point3ifx,Vector3ifx,RectangularPrism3ifx>

Returns:

the depth.

depthProperty

@Pure
public javafx.beans.property.IntegerProperty depthProperty()

Replies the property that is the depth of the box.

Returns:

the depth property.

boundingBoxProperty

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

Description copied from interface: Shape3ifx

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

Specified by:

boundingBoxProperty in interface Shape3ifx<IT extends AbstractRectangularShape3ifx<?>>

Returns:

the bounding box.