Module org.arakhne.afc.core.mathgeom

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

Interface UnmodifiableTuple3D<RT extends Tuple3D<? super RT>>

Type Parameters:

RT - is the type of data that can be returned by this tuple.

All Superinterfaces:

Cloneable, JsonableObject, Serializable, Tuple3D<RT>

All Known Subinterfaces:

UnmodifiablePoint3D<RP,RV>, UnmodifiableVector3D<RV,RP>

All Known Implementing Classes:

ImmutablePoint3D, ImmutableVector3D

public interface UnmodifiableTuple3D<RT extends Tuple3D<? super RT>>
extends Tuple3D<RT>

Unmodifiable 2D tuple.

Since:

13.0

Version:

17.0 2020-01-04 14:41:43

Author:

Thomas PIOTROWSKI, Stéphane GALLAND

Maven Group Id:

org.arakhne.afc.core

Maven Artifact Id:

mathgeom

Method Summary

Modifier and Type	Method	Description
default void	absolute()	Sets each component of this tuple to its absolute value.
default void	absolute(Tuple3D<?> tuple)	Sets each component of the tuple parameter to its absolute value and places the modified values into this tuple.
default void	add(double x, double y, double z)	Sets the value of this tuple to the sum of itself and x and y.
default void	add(int x, int y, int z)	Sets the value of this tuple to the sum of itself and x and y.
default void	addX(double x)	Sets the x value of this tuple to the sum of itself and x.
default void	addX(int x)	Sets the x value of this tuple to the sum of itself and x.
default void	addY(double y)	Sets the y value of this tuple to the sum of itself and y.
default void	addY(int y)	Sets the y value of this tuple to the sum of itself and y.
default void	addZ(double z)	Sets the z value of this tuple to the sum of itself and z.
default void	addZ(int z)	Sets the z value of this tuple to the sum of itself and z.
default void	clamp(double min, double max)	Clamps this tuple to the range [low, high].
default void	clamp(double min, double max, Tuple3D<?> tuple)	Clamps the tuple parameter to the range [low, high] and places the values into this tuple.
default void	clamp(int min, int max)	Clamps this tuple to the range [low, high].
default void	clamp(int min, int max, Tuple3D<?> tuple)	Clamps the tuple parameter to the range [low, high] and places the values into this tuple.
default void	clampMax(double max)	Clamps the maximum value of this tuple to the max parameter.
default void	clampMax(double max, Tuple3D<?> tuple)	Clamps the maximum value of the tuple parameter to the max parameter and places the values into this tuple.
default void	clampMax(int max)	Clamps the maximum value of this tuple to the max parameter.
default void	clampMax(int max, Tuple3D<?> tuple)	Clamps the maximum value of the tuple parameter to the max parameter and places the values into this tuple.
default void	clampMin(double min)	Clamps the minimum value of this tuple to the min parameter.
default void	clampMin(double min, Tuple3D<?> tuple)	Clamps the minimum value of the tuple parameter to the min parameter and places the values into this tuple.
default void	clampMin(int min)	Clamps the minimum value of this tuple to the min parameter.
default void	clampMin(int min, Tuple3D<?> tuple)	Clamps the minimum value of the tuple parameter to the min parameter and places the values into this tuple.
default void	interpolate(Tuple3D<?> tuple, double alpha)	Linearly interpolates between this tuple and tuple t1 and places the result into this tuple: this = (1-alpha)*this + alpha*t1.
default void	interpolate(Tuple3D<?> tuple1, Tuple3D<?> tuple2, double alpha)	Linearly interpolates between tuples t1 and t2 and places the result into this tuple: this = (1-alpha)*t1 + alpha*t2.
default void	negate()	Negates the value of this tuple in place.
default void	negate(Tuple3D<?> tuple)	Sets the value of this tuple to the negation of tuple t1.
default void	scale(double scale)	Sets the value of this tuple to the scalar multiplication of the scale factor with this.
default void	scale(double scale, Tuple3D<?> tuple)	Sets the value of this tuple to the scalar multiplication of tuple t1.
default void	scale(int scale)	Sets the value of this tuple to the scalar multiplication of the scale factor with this.
default void	scale(int scale, Tuple3D<?> tuple)	Sets the value of this tuple to the scalar multiplication of tuple t1.
default void	set(double[] tuple)	Sets the value of this tuple from the 2 values specified in the array.
default void	set(double x, double y, double z)	Sets the value of this tuple to the specified x and y and z coordinates.
default void	set(int[] tuple)	Sets the value of this tuple from the 3 values specified in the array.
default void	set(int x, int y, int z)	Sets the value of this tuple to the specified x and y and z coordinates.
default void	set(Tuple3D<?> tuple)	Sets the value of this tuple to the value of tuple t1.
default void	setX(double x)	Set the x coordinate.
default void	setX(int x)	Set the x coordinate.
default void	setY(double y)	Set the y coordinate.
default void	setY(int y)	Set the y coordinate.
default void	setZ(double z)	Set the z coordinate.
default void	setZ(int z)	Set the z coordinate.
default void	sub(double x, double y, double z)	Sets the value of this tuple to the difference of itself and x, y and z.
default void	sub(int x, int y, int z)	Sets the value of this tuple to the difference of itself and x, y and z.
default void	subX(double x)	Sets the x value of this tuple to the difference of itself and x.
default void	subX(int x)	Sets the x value of this tuple to the difference of itself and x.
default void	subY(double y)	Sets the y value of this tuple to the difference of itself and y.
default void	subY(int y)	Sets the y value of this tuple to the difference of itself and y.
default void	subZ(double z)	Sets the z value of this tuple to the difference of itself and z.
default void	subZ(int z)	Sets the z value of this tuple to the difference of itself and z.

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

toJson

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

clone, epsilonEquals, equals, equals, get, get, get, getX, getY, getZ, hashCode, ix, iy, iz

Method Detail

absolute

default 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

default 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

default 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

default 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

default 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

default 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

default 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

default 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

default 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

default 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.

clamp

default void clamp(int min,
                   int max)

Description copied from interface: Tuple3D

Clamps this tuple to the range [low, high].

Specified by:

clamp in interface Tuple3D<RT extends Tuple3D<? super RT>>

Parameters:

min - the lowest value in this tuple after clamping

max - the highest value in this tuple after clamping

clamp

default void clamp(double min,
                   double max)

Description copied from interface: Tuple3D

Clamps this tuple to the range [low, high].

Specified by:

clamp in interface Tuple3D<RT extends Tuple3D<? super RT>>

Parameters:

min - the lowest value in this tuple after clamping

max - the highest value in this tuple after clamping

clamp

default void clamp(int min,
                   int max,
                   Tuple3D<?> tuple)

Description copied from interface: Tuple3D

Clamps the tuple parameter to the range [low, high] and places the values into this tuple.

Specified by:

clamp in interface Tuple3D<RT extends Tuple3D<? super RT>>

Parameters:

min - the lowest value in the tuple after clamping

max - the highest value in the tuple after clamping

tuple - the source tuple, which will not be modified

clamp

default void clamp(double min,
                   double max,
                   Tuple3D<?> tuple)

Description copied from interface: Tuple3D

Clamps the tuple parameter to the range [low, high] and places the values into this tuple.

Specified by:

clamp in interface Tuple3D<RT extends Tuple3D<? super RT>>

Parameters:

min - the lowest value in the tuple after clamping

max - the highest value in the tuple after clamping

tuple - the source tuple, which will not be modified

clampMin

default void clampMin(int min)

Description copied from interface: Tuple3D

Clamps the minimum value of this tuple to the min parameter.

Specified by:

clampMin in interface Tuple3D<RT extends Tuple3D<? super RT>>

Parameters:

min - the lowest value in this tuple after clamping

clampMin

default void clampMin(double min)

Description copied from interface: Tuple3D

Clamps the minimum value of this tuple to the min parameter.

Specified by:

clampMin in interface Tuple3D<RT extends Tuple3D<? super RT>>

Parameters:

min - the lowest value in this tuple after clamping

clampMin

default void clampMin(int min,
                      Tuple3D<?> tuple)

Description copied from interface: Tuple3D

Clamps the minimum value of the tuple parameter to the min parameter and places the values into this tuple.

Specified by:

clampMin in interface Tuple3D<RT extends Tuple3D<? super RT>>

Parameters:

min - the lowest value in the tuple after clamping

tuple - the source tuple, which will not be modified

clampMin

default void clampMin(double min,
                      Tuple3D<?> tuple)

Description copied from interface: Tuple3D

Clamps the minimum value of the tuple parameter to the min parameter and places the values into this tuple.

Specified by:

clampMin in interface Tuple3D<RT extends Tuple3D<? super RT>>

Parameters:

min - the lowest value in the tuple after clamping

tuple - the source tuple, which will not be modified

clampMax

default void clampMax(int max)

Description copied from interface: Tuple3D

Clamps the maximum value of this tuple to the max parameter.

Specified by:

clampMax in interface Tuple3D<RT extends Tuple3D<? super RT>>

Parameters:

max - the highest value in the tuple after clamping

clampMax

default void clampMax(double max)

Description copied from interface: Tuple3D

Clamps the maximum value of this tuple to the max parameter.

Specified by:

clampMax in interface Tuple3D<RT extends Tuple3D<? super RT>>

Parameters:

max - the highest value in the tuple after clamping

clampMax

default void clampMax(int max,
                      Tuple3D<?> tuple)

Description copied from interface: Tuple3D

Clamps the maximum value of the tuple parameter to the max parameter and places the values into this tuple.

Specified by:

clampMax in interface Tuple3D<RT extends Tuple3D<? super RT>>

Parameters:

max - the highest value in the tuple after clamping

tuple - the source tuple, which will not be modified

clampMax

default void clampMax(double max,
                      Tuple3D<?> tuple)

Description copied from interface: Tuple3D

Clamps the maximum value of the tuple parameter to the max parameter and places the values into this tuple.

Specified by:

clampMax in interface Tuple3D<RT extends Tuple3D<? super RT>>

Parameters:

max - the highest value in the tuple after clamping

tuple - the source tuple, which will not be modified

negate

default 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

default 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

default 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

default 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

default 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

default 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

default 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

default 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

default 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

default 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

default 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

setX

default 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

default 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.

setY

default 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

default 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.

setZ

default 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

default 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

default 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

default 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

default 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

default 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

default 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

default 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

default 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

default 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.

interpolate

default void interpolate(Tuple3D<?> tuple1,
                         Tuple3D<?> tuple2,
                         double alpha)

Description copied from interface: Tuple3D

Linearly interpolates between tuples t1 and t2 and places the result into this tuple: this = (1-alpha)*t1 + alpha*t2.

Specified by:

interpolate in interface Tuple3D<RT extends Tuple3D<? super RT>>

Parameters:

tuple1 - the first tuple

tuple2 - the second tuple

alpha - the alpha interpolation parameter

interpolate

default void interpolate(Tuple3D<?> tuple,
                         double alpha)

Description copied from interface: Tuple3D

Linearly interpolates between this tuple and tuple t1 and places the result into this tuple: this = (1-alpha)*this + alpha*t1.

Specified by:

interpolate in interface Tuple3D<RT extends Tuple3D<? super RT>>

Parameters:

tuple - the first tuple

alpha - the alpha interpolation parameter