Module org.arakhne.afc.core.mathgeom

Package org.arakhne.afc.math.geometry.d1

Interface UnmodifiablePoint1D<RP extends Point1D<? super RP,? super RV,? super RS>,RV extends Vector1D<? super RV,? super RP,? super RS>,RS extends Segment1D<?,?>>

Type Parameters:

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

RV - is the type of vector that can be returned by this point.

RS - is the type of segment that can be returned by this point.

All Superinterfaces:

Cloneable, Comparable<Point1D<?,?,?>>, JsonableObject, Point1D<RP,RV,RS>, Serializable, Tuple2D<RP>, UnmodifiableTuple2D<RP>

All Known Implementing Classes:

ImmutablePoint1D

public interface UnmodifiablePoint1D<RP extends Point1D<? super RP,? super RV,? super RS>,RV extends Vector1D<? super RV,? super RP,? super RS>,RS extends Segment1D<?,?>>
extends UnmodifiableTuple2D<RP>, Point1D<RP,RV,RS>

Unmodifiable Point.

Since:

14.0

Version:

17.0 2020-01-04 14:41:43

Author:

Stéphane GALLAND

Maven Group Id:

org.arakhne.afc.core

Maven Artifact Id:

mathgeom

Method Summary

Modifier and Type	Method	Description
default void	add(double curvilineMove)	Add the given values to this point.
default double	clamp()	Clamp the curviline coordinate to the segment.
default void	set(Point1D<? extends RP,? extends RV,? extends RS> point)	Set this point from the given informations.
default void	set(RS segment, double curviline, double shift)	Set this point from the given informations.
default void	set(RS segment, Tuple2D<?> tuple)	Set this point from the given informations.
default void	setCurvilineCoordinate(double curviline)	Set the curviline coordinate.
default void	setLateralDistance(double shift)	Set the shift distance.
default void	setSegment(RS segment)	Set the segment.
default void	sub(double curvilineMove)	Substract the given values to this point.
default UnmodifiablePoint1D<RP,RV,RS>	toUnmodifiable()	Replies an unmodifiable copy of this point.

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

toJson

Methods inherited from interface org.arakhne.afc.math.geometry.d1.Point1D

$minus, $minus, $minus, $plus, $plus, compareTo, epsilonEquals, equals, equals, getCurvilineCoordinate, getDistance, getDistanceCurviline, getDistanceL1, getDistanceLinf, getDistanceShift, getDistanceSquared, getGeomFactory, getLateralDistance, getSegment, hashCode, isOnSameSegment, isOnSegment, operator_add, operator_elvis, operator_equals, operator_minus, operator_minus, operator_minus, operator_notEquals, operator_plus, operator_plus, operator_remove, operator_upTo

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

clone, epsilonEquals, equals, get, get, get, getX, getY, ix, iy

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

absolute, absolute, add, add, addX, addX, addY, addY, 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, sub, sub, subX, subX, subY, subY

Method Detail

clamp

default double clamp()

Description copied from interface: Point1D

Clamp the curviline coordinate to the segment.

Specified by:

clamp in interface Point1D<RP extends Point1D<? super RP,? super RV,? super RS>,RV extends Vector1D<? super RV,? super RP,? super RS>,RS extends Segment1D<?,?>>

Returns:

the amount that was removed from the coordinate. If the amount is negative it means that the coordinate was negative and clamped to zero. If the amount if positive it means that the coordinate was greater than the segment length and clamped to this length. If the amount is equal to zero it mean that the coordinate was not clamped.

add

default void add(double curvilineMove)

Description copied from interface: Point1D

Add the given values to this point.

Specified by:

add in interface Point1D<RP extends Point1D<? super RP,? super RV,? super RS>,RV extends Vector1D<? super RV,? super RP,? super RS>,RS extends Segment1D<?,?>>

Parameters:

curvilineMove - is the quantity to add to the curviline coordinate.

sub

default void sub(double curvilineMove)

Description copied from interface: Point1D

Substract the given values to this point.

Specified by:

sub in interface Point1D<RP extends Point1D<? super RP,? super RV,? super RS>,RV extends Vector1D<? super RV,? super RP,? super RS>,RS extends Segment1D<?,?>>

Parameters:

curvilineMove - is the quantity to substract to the curviline coordinate.

setCurvilineCoordinate

default void setCurvilineCoordinate(double curviline)

Description copied from interface: Point1D

Set the curviline coordinate.

Specified by:

setCurvilineCoordinate in interface Point1D<RP extends Point1D<? super RP,? super RV,? super RS>,RV extends Vector1D<? super RV,? super RP,? super RS>,RS extends Segment1D<?,?>>

Parameters:

curviline - is the curviline coordinate.

setLateralDistance

default void setLateralDistance(double shift)

Description copied from interface: Point1D

Set the shift distance.

Specified by:

setLateralDistance in interface Point1D<RP extends Point1D<? super RP,? super RV,? super RS>,RV extends Vector1D<? super RV,? super RP,? super RS>,RS extends Segment1D<?,?>>

Parameters:

shift - is the shift distance.

setSegment

default void setSegment(RS segment)

Description copied from interface: Point1D

Set the segment.

Specified by:

setSegment in interface Point1D<RP extends Point1D<? super RP,? super RV,? super RS>,RV extends Vector1D<? super RV,? super RP,? super RS>,RS extends Segment1D<?,?>>

Parameters:

segment - is the segment.

set

default void set(RS segment,
                 double curviline,
                 double shift)

Description copied from interface: Point1D

Set this point from the given informations.

Specified by:

set in interface Point1D<RP extends Point1D<? super RP,? super RV,? super RS>,RV extends Vector1D<? super RV,? super RP,? super RS>,RS extends Segment1D<?,?>>

Parameters:

segment - the segment

curviline - the curviline coordinate

shift - the jutting coordinate

set

default void set(RS segment,
                 Tuple2D<?> tuple)

Description copied from interface: Point1D

Set this point from the given informations.

Specified by:

set in interface Point1D<RP extends Point1D<? super RP,? super RV,? super RS>,RV extends Vector1D<? super RV,? super RP,? super RS>,RS extends Segment1D<?,?>>

Parameters:

segment - the segment

tuple - are the coordinates of the point.

set

default void set(Point1D<? extends RP,? extends RV,? extends RS> point)

Description copied from interface: Point1D

Set this point from the given informations.

Specified by:

set in interface Point1D<RP extends Point1D<? super RP,? super RV,? super RS>,RV extends Vector1D<? super RV,? super RP,? super RS>,RS extends Segment1D<?,?>>

Parameters:

point - are the coordinates of the point.

toUnmodifiable

default UnmodifiablePoint1D<RP,RV,RS> toUnmodifiable()

Description copied from interface: Point1D

Replies an unmodifiable copy of this point.

Specified by:

toUnmodifiable in interface Point1D<RP extends Point1D<? super RP,? super RV,? super RS>,RV extends Vector1D<? super RV,? super RP,? super RS>,RS extends Segment1D<?,?>>

Returns:

an unmodifiable copy.