Module org.arakhne.afc.core.mathgeom

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

Class PathElement3i.LinePathElement3i

java.lang.Object

org.arakhne.afc.math.geometry.d3.i.PathElement3i

org.arakhne.afc.math.geometry.d3.i.PathElement3i.LinePathElement3i

All Implemented Interfaces:

Serializable, Cloneable, PathElement3ai, PathElement3D

Enclosing class:

PathElement3i

static class PathElement3i.LinePathElement3i
extends PathElement3i

An element of the path that represents a LINE_TO.

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.i.PathElement3i

PathElement3i.ClosePathElement3i, PathElement3i.CurvePathElement3i, PathElement3i.LinePathElement3i, PathElement3i.MovePathElement3i, PathElement3i.QuadPathElement3i

Field Summary

Fields inherited from class org.arakhne.afc.math.geometry.d3.i.PathElement3i

toX, toY, toZ, type

Constructor Summary

Constructors

Constructor	Description
LinePathElement3i(int fromx, int fromy, int fromz, int tox, int toy, int toz)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	getCtrlX1()	Replies the x coordinate of the first control point.
int	getCtrlX2()	Replies the x coordinate of the second control point.
int	getCtrlY1()	Replies the y coordinate of the first control point.
int	getCtrlY2()	Replies the y coordinate of the second control point.
int	getCtrlZ1()	Replies the z coordinate of the first control point.
int	getCtrlZ2()	Replies the z coordinate of the second control point.
int	getFromX()	Replies the x coordinate of the starting point.
int	getFromY()	Replies the y coordinate of the starting point.
int	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.
int[]	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.i.PathElement3i

getToX, getToY, getToZ, getType, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

LinePathElement3i

LinePathElement3i(int fromx,
                  int fromy,
                  int fromz,
                  int tox,
                  int toy,
                  int 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 PathElement3i

hashCode

@Pure
public int hashCode()

Specified by:

hashCode in class PathElement3i

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: PathElement3ai

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: PathElement3ai

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

Parameters:

array - the output array.

toArray

@Pure
public int[] toArray()

Description copied from class: PathElement3i

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

Specified by:

toArray in class PathElement3i

Returns:

the array of the points, except the source point.

getFromX

public int getFromX()

Description copied from interface: PathElement3ai

Replies the x coordinate of the starting point.

Returns:

the x coordinate, or Double.NaN if the type is PathElementType.MOVE_TO.

getFromY

public int getFromY()

Description copied from interface: PathElement3ai

Replies the y coordinate of the starting point.

Returns:

the y coordinate, or Double.NaN if the type is PathElementType.MOVE_TO.

getFromZ

public int getFromZ()

Description copied from interface: PathElement3ai

Replies the z coordinate of the starting point.

Returns:

the z coordinate, or Double.NaN if the type is PathElementType.MOVE_TO.

getCtrlX1

public int getCtrlX1()

Description copied from interface: PathElement3ai

Replies the x coordinate of the first control point.

Returns:

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

getCtrlY1

public int getCtrlY1()

Description copied from interface: PathElement3ai

Replies the y coordinate of the first control point.

Returns:

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

getCtrlZ1

public int getCtrlZ1()

Description copied from interface: PathElement3ai

Replies the z coordinate of the first control point.

Returns:

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

getCtrlX2

public int getCtrlX2()

Description copied from interface: PathElement3ai

Replies the x coordinate of the second control point.

Returns:

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

getCtrlY2

public int getCtrlY2()

Description copied from interface: PathElement3ai

Replies the y coordinate of the second control point.

Returns:

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

getCtrlZ2

public int getCtrlZ2()

Description copied from interface: PathElement3ai

Replies the z coordinate of the second control point.

Returns:

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