Module org.arakhne.afc.core.mathgeom

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

Class PathElement3d.ClosePathElement3d

java.lang.Object

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

org.arakhne.afc.math.geometry.d3.d.PathElement3d.ClosePathElement3d

All Implemented Interfaces:

Serializable, Cloneable, PathElement3afp, PathElement3D

Enclosing class:

PathElement3d

static class PathElement3d.ClosePathElement3d
extends PathElement3d

An element of the path that represents a CLOSE.

Since:

13.0

Version:

17.0 2020-01-04 14:41:43

Author:

Stéphane GALLAND, Thomas PIOTROWSKI

Maven Group Id:

org.arakhne.afc.core

Maven Artifact Id:

mathgeom

Nested Class Summary

Nested classes/interfaces inherited from class org.arakhne.afc.math.geometry.d3.d.PathElement3d

PathElement3d.ClosePathElement3d, PathElement3d.CurvePathElement3d, PathElement3d.LinePathElement3d, PathElement3d.MovePathElement3d, PathElement3d.QuadPathElement3d

Field Summary

Fields inherited from class org.arakhne.afc.math.geometry.d3.d.PathElement3d

toX, toY, toZ, type

Constructor Summary

Constructors

Constructor	Description
ClosePathElement3d(double fromx, double fromy, double fromz, double tox, double toy, double toz)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
double	getCtrlX1()	Replies the x coordinate of the first control point.
double	getCtrlX2()	Replies the x coordinate of the second control point.
double	getCtrlY1()	Replies the y coordinate of the first control point.
double	getCtrlY2()	Replies the y coordinate of the second control point.
double	getCtrlZ1()	Replies the z coordinate of the first control point.
double	getCtrlZ2()	Replies the z coordinate of the second control point.
double	getFromX()	Replies the x coordinate of the starting point.
double	getFromY()	Replies the y coordinate of the starting point.
double	getFromZ()	Replies the z coordinate of the starting point.
int	hashCode()
boolean	isDrawable()	Replies if the element is not empty and is drawable.
boolean	isEmpty()	Replies if the element is empty, ie. the points are the same.
double[]	toArray()	Copy the coords into an array, except the source point.
void	toArray(double[] array)	Copy the coords into the given array, except the source point.
void	toArray(int[] array)	Copy the coords into the given array, except the source point.

Methods inherited from class org.arakhne.afc.math.geometry.d3.d.PathElement3d

getToX, getToY, getToZ, getType, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ClosePathElement3d

ClosePathElement3d(double fromx,
                   double fromy,
                   double fromz,
                   double tox,
                   double toy,
                   double toz)

Constructor.

Parameters:

fromx - x coordinate of the origin point.

fromy - y coordinate of the origin point.

fromz - z coordinate of the origin point.

tox - x coordinate of the target point.

toy - y coordinate of the target point.

toz - z coordinate of the target point.

Method Detail

equals

@Pure
public boolean equals(Object obj)

Specified by:

equals in class PathElement3d

hashCode

@Pure
public int hashCode()

Specified by:

hashCode in class PathElement3d

isEmpty

@Pure
public boolean isEmpty()

Description copied from interface: PathElement3D

Replies if the element is empty, ie. the points are the same.

Returns:

true if the points are the same; otherwise false.

isDrawable

@Pure
public boolean isDrawable()

Description copied from interface: PathElement3D

Replies if the element is not empty and is drawable.

Only the path elements that may produce pixels on the screen must reply true in this function.

Returns:

true if the path element is drawable; otherwise false.

toArray

public void toArray(int[] array)

Description copied from interface: PathElement3afp

Copy the coords into the given array, except the source point.

Parameters:

array - the output array.

toArray

public void toArray(double[] array)

Description copied from interface: PathElement3afp

Copy the coords into the given array, except the source point.

Parameters:

array - the output array.

toArray

@Pure
public double[] toArray()

Description copied from class: PathElement3d

Copy the coords into an array, except the source point.

Specified by:

toArray in class PathElement3d

Returns:

the array of the points, except the source point.

getFromX

public double getFromX()

Description copied from interface: PathElement3afp

Replies the x coordinate of the starting point.

Returns:

the x coordinate, or 0 if the type is PathElementType.MOVE_TO.

getFromY

public double getFromY()

Description copied from interface: PathElement3afp

Replies the y coordinate of the starting point.

Returns:

the y coordinate, or 0 if the type is PathElementType.MOVE_TO.

getFromZ

public double getFromZ()

Description copied from interface: PathElement3afp

Replies the z coordinate of the starting point.

Returns:

the z coordinate, or 0 if the type is PathElementType.MOVE_TO.

getCtrlX1

public double getCtrlX1()

Description copied from interface: PathElement3afp

Replies the x coordinate of the first control point.

Returns:

the x coordinate, or 0 if the type is PathElementType.MOVE_TO, PathElementType.LINE_TO, or PathElementType.CLOSE.

getCtrlY1

public double getCtrlY1()

Description copied from interface: PathElement3afp

Replies the y coordinate of the first control point.

Returns:

the y coordinate, or 0 if the type is PathElementType.MOVE_TO, PathElementType.LINE_TO, or PathElementType.CLOSE.

getCtrlZ1

public double getCtrlZ1()

Description copied from interface: PathElement3afp

Replies the z coordinate of the first control point.

Returns:

the z coordinate, or 0 if the type is PathElementType.MOVE_TO, PathElementType.LINE_TO, or PathElementType.CLOSE.

getCtrlX2

public double getCtrlX2()

Description copied from interface: PathElement3afp

Replies the x coordinate of the second control point.

Returns:

the x coordinate, or 0 if the type is PathElementType.MOVE_TO, PathElementType.LINE_TO, PathElementType.QUAD_TO, or PathElementType.CLOSE.

getCtrlY2

public double getCtrlY2()

Description copied from interface: PathElement3afp

Replies the y coordinate of the second control point.

Returns:

the y coordinate, or 0 if the type is PathElementType.MOVE_TO, PathElementType.LINE_TO, PathElementType.QUAD_TO, or PathElementType.CLOSE.

getCtrlZ2

public double getCtrlZ2()

Description copied from interface: PathElement3afp

Replies the z coordinate of the second control point.

Returns:

the z coordinate, or 0 if the type is PathElementType.MOVE_TO, PathElementType.LINE_TO, PathElementType.QUAD_TO, or PathElementType.CLOSE.