Module org.arakhne.afc.core.mathgeom

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

Class OrientedPoint2d

java.lang.Object

org.arakhne.afc.math.geometry.d2.d.Tuple2d<Point2d>

org.arakhne.afc.math.geometry.d2.d.Point2d

org.arakhne.afc.math.geometry.d2.d.OrientedPoint2d

All Implemented Interfaces:

Serializable, Cloneable, OrientedPoint2D<Point2d,Vector2d>, Point2D<Point2d,Vector2d>, Tuple2D<Point2d>, JsonableObject

public class OrientedPoint2d
extends Point2d
implements OrientedPoint2D<Point2d,Vector2d>

2D oriented point with double precision floating-point numbers.

Version:

17.0 2020-01-04 14:41:43

Author:

Thomas PIOTROWSKI

See Also:

Serialized Form

Maven Group Id:

org.arakhne.afc.core

Maven Artifact Id:

mathgeom

Field Summary

Fields inherited from class org.arakhne.afc.math.geometry.d2.d.Tuple2d

x, y

Constructor Summary

Constructors

Constructor	Description
OrientedPoint2d()	Construct an empty oriented point.
OrientedPoint2d(double x, double y)	Construct an oriented point from the two given coordinates.
OrientedPoint2d(double x, double y, double tanX, double tanY)	Construct an oriented point from the two given coordinates.
OrientedPoint2d(Point2D<?,?> point, Vector2D<?,?> vector)	Construct an oriented point from a point and a tangent vector.
OrientedPoint2d(Tuple2D<?> tuple)	Constructor by copy.

Method Summary

Modifier and Type	Method	Description
Vector2d	getNormal()	Replies the normal vector at this point.
Vector2d	getTangent()	Replies the tangent vector at this point.
double	getTangentX()	Replies the X coordinate of the direction vector.
double	getTangentY()	Replies the Y coordinate of the direction vector.
int	hashCode()	Returns a hash code value based on the data values in this object.
int	itx()	Replies the X coordinate of the direction vector.
int	ity()	Replies the Y coordinate of the direction vector.
void	setTangentX(double tanX)	Sets a new value in the X direction of the point.
void	setTangentX(int tanX)	Sets a new value in the X direction of the point.
void	setTangentY(double tanY)	Sets a new value in the Y direction of the point.
void	setTangentY(int tanY)	Sets a new value in the Y direction of the point.

Methods inherited from class org.arakhne.afc.math.geometry.d2.d.Point2d

add, add, add, convert, getDistance, getDistanceL1, getDistanceLinf, getDistanceSquared, getGeomFactory, getIdistanceL1, getIdistanceLinf, scaleAdd, scaleAdd, scaleAdd, scaleAdd, scaleAdd, scaleAdd, sub, sub, toUnmodifiable

Methods inherited from class org.arakhne.afc.math.geometry.d2.d.Tuple2d

absolute, absolute, add, add, addX, addX, addY, addY, clone, equals, getX, getY, ix, iy, negate, negate, scale, scale, scale, scale, set, set, set, set, set, setX, setX, setY, setY, sub, sub, subX, subX, subY, subY, toJson, toString

Methods inherited from class java.lang.Object

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

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

toJson

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

equals, getNormalX, getNormalY, getPoint, inx, iny, set, set, setTangent, setTangent, setTangent

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

$amp$amp, $minus, $minus, $minus, $plus, $plus, add, add, add, getDistance, getDistanceL1, getDistanceLinf, getDistanceSquared, getGeomFactory, getIdistanceL1, getIdistanceLinf, operator_add, operator_and, operator_elvis, operator_equals, operator_minus, operator_minus, operator_minus, operator_notEquals, operator_plus, operator_plus, operator_remove, operator_upTo, operator_upTo, scaleAdd, scaleAdd, scaleAdd, scaleAdd, scaleAdd, scaleAdd, sub, sub, toUnmodifiable, turn, turn, turn, turnLeft, turnLeft, turnLeft, turnRight, turnRight, turnRight

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, clone, epsilonEquals, equals, equals, get, get, get, getX, getY, interpolate, interpolate, ix, iy, negate, negate, scale, scale, scale, scale, set, set, set, set, set, setX, setX, setY, setY, sub, sub, subX, subX, subY, subY

Constructor Detail

OrientedPoint2d

public OrientedPoint2d()

Construct an empty oriented point.

OrientedPoint2d

public OrientedPoint2d(Tuple2D<?> tuple)

Constructor by copy.

Parameters:

tuple - the tuple to copy.

OrientedPoint2d

public OrientedPoint2d(double x,
                       double y)

Construct an oriented point from the two given coordinates.

Parameters:

x - x coordinate of the point.

y - y coordinate of the point.

OrientedPoint2d

public OrientedPoint2d(Point2D<?,?> point,
                       Vector2D<?,?> vector)

Construct an oriented point from a point and a tangent vector.

Parameters:

point - the point.

vector - the tangent vector.

OrientedPoint2d

public OrientedPoint2d(double x,
                       double y,
                       double tanX,
                       double tanY)

Construct an oriented point from the two given coordinates.

Parameters:

x - x coordinate of the point.

y - y coordinate of the point.

tanX - x coordinate of the vector.

tanY - y coordinate of the vector.

Method Detail

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<Point2d>

Overrides:

hashCode in class Tuple2d<Point2d>

Returns:

the integer hash code value

setTangentX

public void setTangentX(int tanX)

Description copied from interface: OrientedPoint2D

Sets a new value in the X direction of the point.

Specified by:

setTangentX in interface OrientedPoint2D<Point2d,Vector2d>

Parameters:

tanX - the new value double x.

setTangentX

public void setTangentX(double tanX)

Description copied from interface: OrientedPoint2D

Sets a new value in the X direction of the point.

Specified by:

setTangentX in interface OrientedPoint2D<Point2d,Vector2d>

Parameters:

tanX - the new value double x.

setTangentY

public void setTangentY(int tanY)

Description copied from interface: OrientedPoint2D

Sets a new value in the Y direction of the point.

Specified by:

setTangentY in interface OrientedPoint2D<Point2d,Vector2d>

Parameters:

tanY - the new value double y.

setTangentY

public void setTangentY(double tanY)

Description copied from interface: OrientedPoint2D

Sets a new value in the Y direction of the point.

Specified by:

setTangentY in interface OrientedPoint2D<Point2d,Vector2d>

Parameters:

tanY - the new value double y.

getTangentX

public double getTangentX()

Description copied from interface: OrientedPoint2D

Replies the X coordinate of the direction vector. If this point is not part of a polyline, the direction vector is null.

Specified by:

getTangentX in interface OrientedPoint2D<Point2d,Vector2d>

Returns:

the x coordinate of the direction vector.

itx

public int itx()

Description copied from interface: OrientedPoint2D

Replies the X coordinate of the direction vector. If this point is not part of a polyline, the direction vector is null.

Specified by:

itx in interface OrientedPoint2D<Point2d,Vector2d>

Returns:

the x coordinate of the direction vector.

getTangentY

public double getTangentY()

Description copied from interface: OrientedPoint2D

Replies the Y coordinate of the direction vector. If this point is not part of a polyline, the direction vector is null.

Specified by:

getTangentY in interface OrientedPoint2D<Point2d,Vector2d>

Returns:

the y coordinate of the direction vector.

ity

public int ity()

Description copied from interface: OrientedPoint2D

Replies the Y coordinate of the direction vector. If this point is not part of a polyline, the direction vector is null.

Specified by:

ity in interface OrientedPoint2D<Point2d,Vector2d>

Returns:

the y coordinate of the direction vector.

getTangent

public Vector2d getTangent()

Description copied from interface: OrientedPoint2D

Replies the tangent vector at this point.

Specified by:

getTangent in interface OrientedPoint2D<Point2d,Vector2d>

Returns:

the tangent vector.

getNormal

public Vector2d getNormal()

Description copied from interface: OrientedPoint2D

Replies the normal vector at this point.

Specified by:

getNormal in interface OrientedPoint2D<Point2d,Vector2d>

Returns:

the normal vector.