Module org.arakhne.afc.core.mathgeom

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

Interface UnmodifiablePoint3D<RP extends Point3D<? super RP,? super RV>,RV extends Vector3D<? super RV,? super RP>>

Type Parameters:

RP - is the type of points that can be returned by this tuple.

RV - is the type of vectors that can be returned by this tuple.

All Superinterfaces:

Cloneable, JsonableObject, Point3D<RP,RV>, Serializable, Tuple3D<RP>, UnmodifiableTuple3D<RP>

All Known Implementing Classes:

ImmutablePoint3D

public interface UnmodifiablePoint3D<RP extends Point3D<? super RP,? super RV>,RV extends Vector3D<? super RV,? super RP>>
extends UnmodifiableTuple3D<RP>, Point3D<RP,RV>

Unmodifiable3D Point.

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	add(Point3D<?,?> point, Vector3D<?,?> vector)	Sets the value of this tuple to the sum of tuples t1 and t2.
default void	add(Vector3D<?,?> vector)	Sets the value of this tuple to the sum of itself and t1.
default void	add(Vector3D<?,?> point, Point3D<?,?> vector)	Sets the value of this tuple to the sum of tuples t1 and t2.
default void	operator_add(Vector3D<?,?> v)	Increment this point with the given vector: this += v
default void	operator_remove(Vector3D<?,?> v)	the v vector to this: this -= v
default void	scaleAdd(double scale, Point3D<?,?> point, Vector3D<?,?> vector)	Sets the value of this tuple to the scalar multiplication of tuple t1 plus tuple t2 (this = s*t1 + t2).
default void	scaleAdd(double scale, Vector3D<?,?> vector)	Sets the value of this tuple to the scalar multiplication of itself and then adds tuple t1 (this = s*this + t1).
default void	scaleAdd(double scale, Vector3D<?,?> vector, Point3D<?,?> point)	Sets the value of this tuple to the scalar multiplication of tuple t1 plus tuple t2 (this = s*t1 + t2).
default void	scaleAdd(int scale, Point3D<?,?> point, Vector3D<?,?> vector)	Sets the value of this tuple to the scalar multiplication of tuple t1 plus tuple t2 (this = s*t1 + t2).
default void	scaleAdd(int scale, Vector3D<?,?> vector)	Sets the value of this tuple to the scalar multiplication of itself and then adds tuple t1 (this = s*this + t1).
default void	scaleAdd(int scale, Vector3D<?,?> vector, Point3D<?,?> point)	Sets the value of this tuple to the scalar multiplication of tuple t1 plus tuple t2 (this = s*t1 + t2).
default void	sub(Point3D<?,?> point, Vector3D<?,?> vector)	Sets the value of this tuple to the difference of tuples t1 and t2 (this = t1 - t2).
default void	sub(Vector3D<?,?> vector)	Sets the value of this tuple to the difference of itself and t1 (this = this - t1).
default UnmodifiablePoint3D<RP,RV>	toUnmodifiable()	Replies an unmodifiable copy of this vector.

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

toJson

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

getDistance, getDistanceL1, getDistanceLinf, getDistanceSquared, getGeomFactory, getIdistanceL1, getIdistanceLinf, operator_and, operator_elvis, operator_equals, operator_minus, operator_minus, operator_notEquals, operator_plus, operator_upTo, operator_upTo

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

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

absolute, absolute, add, add, addX, addX, addY, addY, addZ, addZ, clamp, clamp, clamp, clamp, clampMax, clampMax, clampMax, clampMax, clampMin, clampMin, clampMin, clampMin, interpolate, interpolate, negate, negate, scale, scale, scale, scale, set, set, set, set, set, setX, setX, setY, setY, setZ, setZ, sub, sub, subX, subX, subY, subY, subZ, subZ

Method Detail

add

default void add(Point3D<?,?> point,
                 Vector3D<?,?> vector)

Description copied from interface: Point3D

Sets the value of this tuple to the sum of tuples t1 and t2.

Specified by:

add in interface Point3D<RP extends Point3D<? super RP,? super RV>,RV extends Vector3D<? super RV,? super RP>>

Parameters:

point - the first tuple

vector - the second tuple

add

default void add(Vector3D<?,?> point,
                 Point3D<?,?> vector)

Description copied from interface: Point3D

Sets the value of this tuple to the sum of tuples t1 and t2.

Specified by:

add in interface Point3D<RP extends Point3D<? super RP,? super RV>,RV extends Vector3D<? super RV,? super RP>>

Parameters:

point - the second tuple

vector - the first tuple

add

default void add(Vector3D<?,?> vector)

Description copied from interface: Point3D

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

Specified by:

add in interface Point3D<RP extends Point3D<? super RP,? super RV>,RV extends Vector3D<? super RV,? super RP>>

Parameters:

vector - the other tuple

scaleAdd

default void scaleAdd(int scale,
                      Vector3D<?,?> vector,
                      Point3D<?,?> point)

Description copied from interface: Point3D

Sets the value of this tuple to the scalar multiplication of tuple t1 plus tuple t2 (this = s*t1 + t2).

Specified by:

scaleAdd in interface Point3D<RP extends Point3D<? super RP,? super RV>,RV extends Vector3D<? super RV,? super RP>>

Parameters:

scale - the scalar value

vector - the tuple to be multipled

point - the tuple to be added

scaleAdd

default void scaleAdd(double scale,
                      Vector3D<?,?> vector,
                      Point3D<?,?> point)

Description copied from interface: Point3D

Sets the value of this tuple to the scalar multiplication of tuple t1 plus tuple t2 (this = s*t1 + t2).

Specified by:

scaleAdd in interface Point3D<RP extends Point3D<? super RP,? super RV>,RV extends Vector3D<? super RV,? super RP>>

Parameters:

scale - the scalar value

vector - the tuple to be multipled

point - the tuple to be added

scaleAdd

default void scaleAdd(int scale,
                      Point3D<?,?> point,
                      Vector3D<?,?> vector)

Description copied from interface: Point3D

Sets the value of this tuple to the scalar multiplication of tuple t1 plus tuple t2 (this = s*t1 + t2).

Specified by:

scaleAdd in interface Point3D<RP extends Point3D<? super RP,? super RV>,RV extends Vector3D<? super RV,? super RP>>

Parameters:

scale - the scalar value

point - the tuple to be multipled

vector - the tuple to be added

scaleAdd

default void scaleAdd(double scale,
                      Point3D<?,?> point,
                      Vector3D<?,?> vector)

Description copied from interface: Point3D

Sets the value of this tuple to the scalar multiplication of tuple t1 plus tuple t2 (this = s*t1 + t2).

Specified by:

scaleAdd in interface Point3D<RP extends Point3D<? super RP,? super RV>,RV extends Vector3D<? super RV,? super RP>>

Parameters:

scale - the scalar value

point - the tuple to be multipled

vector - the tuple to be added

scaleAdd

default void scaleAdd(int scale,
                      Vector3D<?,?> vector)

Description copied from interface: Point3D

Sets the value of this tuple to the scalar multiplication of itself and then adds tuple t1 (this = s*this + t1).

Specified by:

scaleAdd in interface Point3D<RP extends Point3D<? super RP,? super RV>,RV extends Vector3D<? super RV,? super RP>>

Parameters:

scale - the scalar value

vector - the tuple to be added

scaleAdd

default void scaleAdd(double scale,
                      Vector3D<?,?> vector)

Description copied from interface: Point3D

Sets the value of this tuple to the scalar multiplication of itself and then adds tuple t1 (this = s*this + t1).

Specified by:

scaleAdd in interface Point3D<RP extends Point3D<? super RP,? super RV>,RV extends Vector3D<? super RV,? super RP>>

Parameters:

scale - the scalar value

vector - the tuple to be added

sub

default void sub(Point3D<?,?> point,
                 Vector3D<?,?> vector)

Description copied from interface: Point3D

Sets the value of this tuple to the difference of tuples t1 and t2 (this = t1 - t2).

Specified by:

sub in interface Point3D<RP extends Point3D<? super RP,? super RV>,RV extends Vector3D<? super RV,? super RP>>

Parameters:

point - the first tuple

vector - the second tuple

sub

default void sub(Vector3D<?,?> vector)

Description copied from interface: Point3D

Sets the value of this tuple to the difference of itself and t1 (this = this - t1).

Specified by:

sub in interface Point3D<RP extends Point3D<? super RP,? super RV>,RV extends Vector3D<? super RV,? super RP>>

Parameters:

vector - the other tuple

toUnmodifiable

@Pure
default UnmodifiablePoint3D<RP,RV> toUnmodifiable()

Description copied from interface: Point3D

Replies an unmodifiable copy of this vector.

Specified by:

toUnmodifiable in interface Point3D<RP extends Point3D<? super RP,? super RV>,RV extends Vector3D<? super RV,? super RP>>

Returns:

an unmodifiable copy.

operator_add

default void operator_add(Vector3D<?,?> v)

Description copied from interface: Point3D

Increment this point with the given vector: this += v

This function is an implementation of the "-" operator for the languages that defined or based on the Xtext framework.

Specified by:

operator_add in interface Point3D<RP extends Point3D<? super RP,? super RV>,RV extends Vector3D<? super RV,? super RP>>

Parameters:

v - the vector to add

See Also:

Point3D.add(Vector3D)

operator_remove

default void operator_remove(Vector3D<?,?> v)

Description copied from interface: Point3D

the v vector to this: this -= v

This function is an implementation of the "-" operator for the languages that defined or based on the Xtext framework.

Specified by:

operator_remove in interface Point3D<RP extends Point3D<? super RP,? super RV>,RV extends Vector3D<? super RV,? super RP>>

Parameters:

v - the vector to substract.

See Also:

Point3D.sub(Vector3D)