Module org.arakhne.afc.core.mathgeom

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

Class Tuple3d<RT extends Tuple3d<? super RT>>

java.lang.Object

org.arakhne.afc.math.geometry.d3.d.Tuple3d<RT>

Type Parameters:

RT - is the type of the data returned by the tuple.

All Implemented Interfaces:

Serializable, Cloneable, Tuple3D<RT>, JsonableObject

Direct Known Subclasses:

Point3d, Vector3d

public class Tuple3d<RT extends Tuple3d<? super RT>>
extends Object
implements Tuple3D<RT>

3D tuple with 3 double precision floating-point numbers.

Since:

13.0

Version:

17.0 2020-01-04 14:41:43

Author:

Stéphane GALLAND, Thomas PIOTROWSKI

See Also:

Serialized Form

Maven Group Id:

org.arakhne.afc.core

Maven Artifact Id:

mathgeom

Field Summary

Fields

Modifier and Type	Field	Description
(package private) double	x	x coordinate.
(package private) double	y	y coordinate.
(package private) double	z	z coordinate.

Constructor Summary

Constructors

Constructor	Description
Tuple3d()	Construct a zero tuple.
Tuple3d(double[] tuple)	Constructor.
Tuple3d(double x, double y, double z)	Construct a tuple with the given coordinates.
Tuple3d(int[] tuple)	Constructor.
Tuple3d(int x, int y, int z)	Construct a tuple with the given coordinates.
Tuple3d(Tuple3D<?> tuple)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	absolute()	Sets each component of this tuple to its absolute value.
void	absolute(Tuple3D<?> tuple)	Sets each component of the tuple parameter to its absolute value and places the modified values into this tuple.
void	add(double x, double y, double z)	Sets the value of this tuple to the sum of itself and x and y.
void	add(int x, int y, int z)	Sets the value of this tuple to the sum of itself and x and y.
void	addX(double x)	Sets the x value of this tuple to the sum of itself and x.
void	addX(int x)	Sets the x value of this tuple to the sum of itself and x.
void	addY(double y)	Sets the y value of this tuple to the sum of itself and y.
void	addY(int y)	Sets the y value of this tuple to the sum of itself and y.
void	addZ(double z)	Sets the z value of this tuple to the sum of itself and z.
void	addZ(int z)	Sets the z value of this tuple to the sum of itself and z.
RT	clone()	Clone this point.
boolean	equals(Object t1)	Returns true if the Object t1 is of type Tuple2f and all of the data members of t1 are equal to the corresponding data members in this Tuple2f.
double	getX()	Get the x coordinate.
double	getY()	Get the y coordinate.
double	getZ()	Get the z 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.
int	iz()	Get the z coordinate.
void	negate()	Negates the value of this tuple in place.
void	negate(Tuple3D<?> tuple)	Sets the value of this tuple to the negation of tuple t1.
void	scale(double scale)	Sets the value of this tuple to the scalar multiplication of the scale factor with this.
void	scale(double scale, Tuple3D<?> tuple)	Sets the value of this tuple to the scalar multiplication of tuple t1.
void	scale(int scale)	Sets the value of this tuple to the scalar multiplication of the scale factor with this.
void	scale(int scale, Tuple3D<?> tuple)	Sets the value of this tuple to the scalar multiplication of tuple t1.
void	set(double[] tuple)	Sets the value of this tuple from the 2 values specified in the array.
void	set(double x, double y, double z)	Sets the value of this tuple to the specified x and y and z coordinates.
void	set(int[] tuple)	Sets the value of this tuple from the 3 values specified in the array.
void	set(int x, int y, int z)	Sets the value of this tuple to the specified x and y and z coordinates.
void	set(Tuple3D<?> tuple)	Sets the value of this tuple to the value of tuple t1.
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	setZ(double z)	Set the z coordinate.
void	setZ(int z)	Set the z coordinate.
void	sub(double x, double y, double z)	Sets the value of this tuple to the difference of itself and x, y and z.
void	sub(int x, int y, int z)	Sets the value of this tuple to the difference of itself and x, y and z.
void	subX(double x)	Sets the x value of this tuple to the difference of itself and x.
void	subX(int x)	Sets the x value of this tuple to the difference of itself and x.
void	subY(double y)	Sets the y value of this tuple to the difference of itself and y.
void	subY(int y)	Sets the y value of this tuple to the difference of itself and y.
void	subZ(double z)	Sets the z value of this tuple to the difference of itself and z.
void	subZ(int z)	Sets the z value of this tuple to the difference of itself and z.
void	toJson(JsonBuffer buffer)	Replies the Json representation of this node.
String	toString()

Methods inherited from class java.lang.Object

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

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

clamp, clamp, clamp, clamp, clampMax, clampMax, clampMax, clampMax, clampMin, clampMin, clampMin, clampMin, epsilonEquals, equals, get, get, get, interpolate, interpolate

Field Detail

x

double x

x coordinate.

y

double y

y coordinate.

z

double z

z coordinate.

Constructor Detail

Tuple3d

public Tuple3d()

Construct a zero tuple.

Tuple3d

public Tuple3d(Tuple3D<?> tuple)

Constructor.

Parameters:

tuple - is the tuple to copy.

Tuple3d

public Tuple3d(int[] tuple)

Constructor.

Parameters:

tuple - is the tuple to copy.

Tuple3d

public Tuple3d(double[] tuple)

Constructor.

Parameters:

tuple - is the tuple to copy.

Tuple3d

public Tuple3d(int x,
               int y,
               int z)

Construct a tuple with the given coordinates.

Parameters:

x - x coordinate.

y - y coordinate.

z - z coordinate.

Tuple3d

public Tuple3d(double x,
               double y,
               double z)

Construct a tuple with the given coordinates.

Parameters:

x - x coordinate.

y - y coordinate.

z - z coordinate.

Method Detail

clone

@Pure
public RT clone()

Description copied from interface: Tuple3D

Clone this point.

Specified by:

clone in interface Tuple3D<RT extends Tuple3d<? super RT>>

Overrides:

clone in class Object

Returns:

the clone.

absolute

public void absolute()

Description copied from interface: Tuple3D

Sets each component of this tuple to its absolute value.

Specified by:

absolute in interface Tuple3D<RT extends Tuple3d<? super RT>>

absolute

public void absolute(Tuple3D<?> tuple)

Description copied from interface: Tuple3D

Sets each component of the tuple parameter to its absolute value and places the modified values into this tuple.

Specified by:

absolute in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

tuple - the source tuple, which will not be modified

add

public void add(int x,
                int y,
                int z)

Description copied from interface: Tuple3D

Sets the value of this tuple to the sum of itself and x and y.

Specified by:

add in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

x - x coordinate to add.

y - y coordinate to add.

z - z coordinate to add.

add

public void add(double x,
                double y,
                double z)

Description copied from interface: Tuple3D

Sets the value of this tuple to the sum of itself and x and y.

Specified by:

add in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

x - x coordinate to add.

y - y coordinate to add.

z - z coordinate to add.

addX

public void addX(int x)

Description copied from interface: Tuple3D

Sets the x value of this tuple to the sum of itself and x.

Specified by:

addX in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

x - x coordinate to add.

addX

public void addX(double x)

Description copied from interface: Tuple3D

Sets the x value of this tuple to the sum of itself and x.

Specified by:

addX in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

x - x coordinate to add.

addY

public void addY(int y)

Description copied from interface: Tuple3D

Sets the y value of this tuple to the sum of itself and y.

Specified by:

addY in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

y - y coordinate to add.

addY

public void addY(double y)

Description copied from interface: Tuple3D

Sets the y value of this tuple to the sum of itself and y.

Specified by:

addY in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

y - y coordinate to add.

addZ

public void addZ(int z)

Description copied from interface: Tuple3D

Sets the z value of this tuple to the sum of itself and z.

Specified by:

addZ in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

z - z coordinate to add.

addZ

public void addZ(double z)

Description copied from interface: Tuple3D

Sets the z value of this tuple to the sum of itself and z.

Specified by:

addZ in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

z - z coordinate to add.

negate

public void negate(Tuple3D<?> tuple)

Description copied from interface: Tuple3D

Sets the value of this tuple to the negation of tuple t1.

Specified by:

negate in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

tuple - the source tuple

negate

public void negate()

Description copied from interface: Tuple3D

Negates the value of this tuple in place.

Specified by:

negate in interface Tuple3D<RT extends Tuple3d<? super RT>>

scale

public void scale(int scale,
                  Tuple3D<?> tuple)

Description copied from interface: Tuple3D

Sets the value of this tuple to the scalar multiplication of tuple t1.

Specified by:

scale in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

scale - the scalar value

tuple - the source tuple

scale

public void scale(double scale,
                  Tuple3D<?> tuple)

Description copied from interface: Tuple3D

Sets the value of this tuple to the scalar multiplication of tuple t1.

Specified by:

scale in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

scale - the scalar value

tuple - the source tuple

scale

public void scale(int scale)

Description copied from interface: Tuple3D

Sets the value of this tuple to the scalar multiplication of the scale factor with this.

Specified by:

scale in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

scale - the scalar value

scale

public void scale(double scale)

Description copied from interface: Tuple3D

Sets the value of this tuple to the scalar multiplication of the scale factor with this.

Specified by:

scale in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

scale - the scalar value

set

public void set(Tuple3D<?> tuple)

Description copied from interface: Tuple3D

Sets the value of this tuple to the value of tuple t1.

Specified by:

set in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

tuple - the tuple to be copied

set

public void set(int x,
                int y,
                int z)

Description copied from interface: Tuple3D

Sets the value of this tuple to the specified x and y and z coordinates.

Specified by:

set in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

x - the x coordinate

y - the y coordinate

z - the z coordinate

set

public void set(double x,
                double y,
                double z)

Description copied from interface: Tuple3D

Sets the value of this tuple to the specified x and y and z coordinates.

Specified by:

set in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

x - the x coordinate

y - the y coordinate

z - the z coordinate

set

public void set(int[] tuple)

Description copied from interface: Tuple3D

Sets the value of this tuple from the 3 values specified in the array.

Specified by:

set in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

tuple - the array of length 2 containing xyz in order

set

public void set(double[] tuple)

Description copied from interface: Tuple3D

Sets the value of this tuple from the 2 values specified in the array.

Specified by:

set in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

tuple - the array of length 2 containing xy in order

getX

@Pure
public double getX()

Description copied from interface: Tuple3D

Get the x coordinate.

Specified by:

getX in interface Tuple3D<RT extends Tuple3d<? super RT>>

Returns:

the x coordinate.

ix

@Pure
public int ix()

Description copied from interface: Tuple3D

Get the x coordinate.

Specified by:

ix in interface Tuple3D<RT extends Tuple3d<? super RT>>

Returns:

the x coordinate.

setX

public void setX(int x)

Description copied from interface: Tuple3D

Set the x coordinate.

Specified by:

setX in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

x - value to x coordinate.

setX

public void setX(double x)

Description copied from interface: Tuple3D

Set the x coordinate.

Specified by:

setX in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

x - value to x coordinate.

getY

@Pure
public double getY()

Description copied from interface: Tuple3D

Get the y coordinate.

Specified by:

getY in interface Tuple3D<RT extends Tuple3d<? super RT>>

Returns:

the y coordinate.

iy

@Pure
public int iy()

Description copied from interface: Tuple3D

Get the y coordinate.

Specified by:

iy in interface Tuple3D<RT extends Tuple3d<? super RT>>

Returns:

the y coordinate.

setY

public void setY(int y)

Description copied from interface: Tuple3D

Set the y coordinate.

Specified by:

setY in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

y - value to y coordinate.

setY

public void setY(double y)

Description copied from interface: Tuple3D

Set the y coordinate.

Specified by:

setY in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

y - value to y coordinate.

getZ

@Pure
public double getZ()

Description copied from interface: Tuple3D

Get the z coordinate.

Specified by:

getZ in interface Tuple3D<RT extends Tuple3d<? super RT>>

Returns:

the z coordinate.

iz

@Pure
public int iz()

Description copied from interface: Tuple3D

Get the z coordinate.

Specified by:

iz in interface Tuple3D<RT extends Tuple3d<? super RT>>

Returns:

the z coordinate.

setZ

public void setZ(int z)

Description copied from interface: Tuple3D

Set the z coordinate.

Specified by:

setZ in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

z - value to z coordinate.

setZ

public void setZ(double z)

Description copied from interface: Tuple3D

Set the z coordinate.

Specified by:

setZ in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

z - value to z coordinate.

sub

public void sub(int x,
                int y,
                int z)

Description copied from interface: Tuple3D

Sets the value of this tuple to the difference of itself and x, y and z.

Specified by:

sub in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

x - x coordinate to substract.

y - y coordinate to substract.

z - y coordinate to substract.

sub

public void sub(double x,
                double y,
                double z)

Description copied from interface: Tuple3D

Sets the value of this tuple to the difference of itself and x, y and z.

Specified by:

sub in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

x - x coordinate to substract.

y - y coordinate to substract.

z - y coordinate to substract.

subX

public void subX(int x)

Description copied from interface: Tuple3D

Sets the x value of this tuple to the difference of itself and x.

Specified by:

subX in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

x - x coordinate to substract.

subX

public void subX(double x)

Description copied from interface: Tuple3D

Sets the x value of this tuple to the difference of itself and x.

Specified by:

subX in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

x - x coordinate to substract.

subY

public void subY(int y)

Description copied from interface: Tuple3D

Sets the y value of this tuple to the difference of itself and y.

Specified by:

subY in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

y - y coordinate to substract.

subY

public void subY(double y)

Description copied from interface: Tuple3D

Sets the y value of this tuple to the difference of itself and y.

Specified by:

subY in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

y - y coordinate to substract.

subZ

public void subZ(int z)

Description copied from interface: Tuple3D

Sets the z value of this tuple to the difference of itself and z.

Specified by:

subZ in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

z - y coordinate to substract.

subZ

public void subZ(double z)

Description copied from interface: Tuple3D

Sets the z value of this tuple to the difference of itself and z.

Specified by:

subZ in interface Tuple3D<RT extends Tuple3d<? super RT>>

Parameters:

z - y coordinate to substract.

equals

@Pure
public boolean equals(Object t1)

Description copied from interface: Tuple3D

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

Specified by:

equals in interface Tuple3D<RT extends Tuple3d<? super RT>>

Overrides:

equals in class Object

Parameters:

t1 - the object with which the comparison is made

Returns:

true or false

hashCode

@Pure
public int hashCode()

Description copied from interface: Tuple3D

Returns a hash code value based on the data values in this object. Two different Tuple2f objects with identical data values (i.e., Tuple2f.equals 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 Tuple3D<RT extends Tuple3d<? 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.