Module org.arakhne.afc.advanced.mathfx

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

Class Tuple2ifx<RT extends Tuple2ifx<? super RT>>

java.lang.Object

org.arakhne.afc.math.geometry.d2.ifx.Tuple2ifx<RT>

Type Parameters:

RT - is the type of return tuples by the tuple.

All Implemented Interfaces:

Serializable, Cloneable, Tuple2D<RT>, JsonableObject

Direct Known Subclasses:

Point2ifx, Vector2ifx

public class Tuple2ifx<RT extends Tuple2ifx<? super RT>>
extends Object
implements Tuple2D<RT>

2D tuple with 2 integer FX properties.

Since:

13.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.IntegerProperty	x	x coordinate.
(package private) javafx.beans.property.IntegerProperty	y	y coordinate.

Constructor Summary

Constructors

Constructor	Description
Tuple2ifx()	Construct a zero tuple.
Tuple2ifx(double[] tuple)	Constructor by copy.
Tuple2ifx(double x, double y)	Construct a tuple with the given coordinates.
Tuple2ifx(int[] tuple)	Constructor by copy.
Tuple2ifx(int x, int y)	Construct a tuple with the given coordinates.
Tuple2ifx(javafx.beans.property.IntegerProperty xProperty, javafx.beans.property.IntegerProperty yProperty)	Construct a tuple with the given properties for the coordinates.
Tuple2ifx(Tuple2D<?> tuple)	Constructor by copy.

Method Summary

Modifier and Type	Method	Description
RT	clone()	Clone this point.
boolean	equals(Object object)	Returns true if the Object t1 is of type Tuple2D and all of the data members of t1 are equal to the corresponding data members in this Tuple2D.
double	getX()	Get the x coordinate.
double	getY()	Get the y coordinate.
int	hashCode()	Returns a hash code value based on the data values in this object.
int	ix()	Get the x coordinate.
int	iy()	Get the y coordinate.
void	setX(double x)	Set the x coordinate.
void	setX(int x)	Set the x coordinate.
void	setY(double y)	Set the y coordinate.
void	setY(int y)	Set the y coordinate.
void	toJson(JsonBuffer buffer)	Replies the Json representation of this node.
String	toString()
javafx.beans.property.IntegerProperty	xProperty()	Replies the x property.
javafx.beans.property.IntegerProperty	yProperty()	Replies the y property.

Methods inherited from class java.lang.Object

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

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

absolute, absolute, add, add, addX, addX, addY, addY, clamp, clamp, clamp, clamp, clampMax, clampMax, clampMax, clampMax, clampMin, clampMin, clampMin, clampMin, epsilonEquals, equals, get, get, get, interpolate, interpolate, negate, negate, scale, scale, scale, scale, set, set, set, set, set, sub, sub, subX, subX, subY, subY

Field Detail

x

javafx.beans.property.IntegerProperty x

x coordinate.

y

javafx.beans.property.IntegerProperty y

y coordinate.

Constructor Detail

Tuple2ifx

public Tuple2ifx()

Construct a zero tuple.

Tuple2ifx

public Tuple2ifx(javafx.beans.property.IntegerProperty xProperty,
                 javafx.beans.property.IntegerProperty yProperty)

Construct a tuple with the given properties for the coordinates.

Parameters:

xProperty - property for the x coordinate.

yProperty - property for the y coordinate.

Tuple2ifx

public Tuple2ifx(Tuple2D<?> tuple)

Constructor by copy.

Parameters:

tuple - is the tuple to copy.

Tuple2ifx

public Tuple2ifx(int[] tuple)

Constructor by copy.

Parameters:

tuple - is the tuple to copy.

Tuple2ifx

public Tuple2ifx(double[] tuple)

Constructor by copy.

Parameters:

tuple - is the tuple to copy.

Tuple2ifx

public Tuple2ifx(double x,
                 double y)

Construct a tuple with the given coordinates.

Parameters:

x - x coordinate.

y - y coordinate.

Tuple2ifx

public Tuple2ifx(int x,
                 int y)

Construct a tuple with the given coordinates.

Parameters:

x - x coordinate.

y - y coordinate.

Method Detail

clone

@Pure
public RT clone()

Description copied from interface: Tuple2D

Clone this point.

Specified by:

clone in interface Tuple2D<RT extends Tuple2ifx<? super RT>>

Overrides:

clone in class Object

Returns:

the clone.

equals

@Pure
public boolean equals(Object object)

Description copied from interface: Tuple2D

Returns true if the Object t1 is of type Tuple2D and all of the data members of t1 are equal to the corresponding data members in this Tuple2D.

Specified by:

equals in interface Tuple2D<RT extends Tuple2ifx<? super RT>>

Overrides:

equals in class Object

Parameters:

object - the object with which the comparison is made

Returns:

true or false

hashCode

@Pure
public int hashCode()

Description copied from interface: Tuple2D

Returns a hash code value based on the data values in this object. Two different Tuple2D objects with identical data values (i.e., Tuple2D.equals(Object) returns true) will return the same hash code value. Two objects with different data members may return the same hash value, although this is not likely.

Specified by:

hashCode in interface Tuple2D<RT extends Tuple2ifx<? super RT>>

Overrides:

hashCode in class Object

Returns:

the integer hash code value

toString

@Pure
public String toString()

Overrides:

toString in class Object

toJson

public void toJson(JsonBuffer buffer)

Description copied from interface: JsonableObject

Replies the Json representation of this node.

Specified by:

toJson in interface JsonableObject

Parameters:

buffer - the Json buffer.

xProperty

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

Replies the x property.

Returns:

the x property.

yProperty

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

Replies the y property.

Returns:

the y property.

getX

public double getX()

Description copied from interface: Tuple2D

Get the x coordinate.

Specified by:

getX in interface Tuple2D<RT extends Tuple2ifx<? super RT>>

Returns:

the x coordinate.

ix

public int ix()

Description copied from interface: Tuple2D

Get the x coordinate.

Specified by:

ix in interface Tuple2D<RT extends Tuple2ifx<? super RT>>

Returns:

the x coordinate.

setX

public void setX(int x)

Description copied from interface: Tuple2D

Set the x coordinate.

Specified by:

setX in interface Tuple2D<RT extends Tuple2ifx<? super RT>>

Parameters:

x - value to x coordinate.

setX

public void setX(double x)

Description copied from interface: Tuple2D

Set the x coordinate.

Specified by:

setX in interface Tuple2D<RT extends Tuple2ifx<? super RT>>

Parameters:

x - value to x coordinate.

getY

public double getY()

Description copied from interface: Tuple2D

Get the y coordinate.

Specified by:

getY in interface Tuple2D<RT extends Tuple2ifx<? super RT>>

Returns:

the y coordinate.

iy

public int iy()

Description copied from interface: Tuple2D

Get the y coordinate.

Specified by:

iy in interface Tuple2D<RT extends Tuple2ifx<? super RT>>

Returns:

the y coordinate.

setY

public void setY(int y)

Description copied from interface: Tuple2D

Set the y coordinate.

Specified by:

setY in interface Tuple2D<RT extends Tuple2ifx<? super RT>>

Parameters:

y - value to y coordinate.

setY

public void setY(double y)

Description copied from interface: Tuple2D

Set the y coordinate.

Specified by:

setY in interface Tuple2D<RT extends Tuple2ifx<? super RT>>

Parameters:

y - value to y coordinate.