Coord3d (Jzy3d API 1.0.0-SNAPSHOT API)

java.lang.Object
- org.jzy3d.maths.Coord3d

All Implemented Interfaces:

Serializable
```
public class Coord3d
extends Object
implements Serializable
```
A Coord3d stores a 3 dimensional coordinate for cartesian or polar mode, and provide few operators. Operators allow adding, substracting, multiplying and divising coordinate values, as well as computing the distance between two points, and converting polar and cartesian coordinates.

Author:

Martin Pernollet

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Coord3d`	`IDENTITY` The origin is a Coord3d having value 1 for each dimension.
`static Coord3d`	`INVALID` An invalid Coord2d has value NaN for each dimension.
`static Coord3d`	`ORIGIN` The origin is a Coord3d having value 0 for each dimension.
`float`	`x`
`float`	`y`
`float`	`z`

Constructor Summary

Constructors
Constructor and Description
`Coord3d()` Create a 3d coordinate with value 0 for each dimension.
`Coord3d(Coord2d c, float zi)`
`Coord3d(double xi, double yi, double zi)` Create a 3d coordinate.
`Coord3d(float[] c)`
`Coord3d(float xi, float yi, float zi)` Create a 3d coordinate.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Coord3d`	`add(Coord3d c2)` Add a Coord3d to the current one and return the result in a new Coord3d.
`Coord3d`	`add(float value)` Add a value to all components of the current Coord and return the result in a new Coord3d.
`Coord3d`	`add(float x, float y, float z)`
`Coord3d`	`addSelf(Coord3d c2)`
`Coord3d`	`addSelf(float value)`
`Coord3d`	`cartesian()` Converts the current Coord3d into cartesian coordinates and return the result in a new Coord3d.
`Coord3d`	`clone()` Return a duplicate of this 3d coordinate.
`Coord3d`	`cross(Coord3d v)`
`double`	`distance(Coord3d c)` Compute the distance between two coordinates.
`double`	`distanceSq(Coord3d c)`
`Coord3d`	`div(Coord3d c2)` Divise a Coord3d to the current one and return the result in a new Coord3d.
`Coord3d`	`div(float value)` Divise all components of the current Coord by the same value and return the result in a new Coord3d.
`void`	`divSelf(Coord3d c2)`
`float`	`dot(Coord3d v)`
`boolean`	`equals(Object obj)`
`Coord3d`	`getNormalizedTo(float len)`
`Coord2d`	`getXY()` Return the x and y component as a 2d coordinate.
`static Range`	`getZRange(List<Coord3d> coords)`
`int`	`hashCode()`
`Coord3d`	`interpolateTo(Coord3d v, float f)`
`static List<Coord3d>`	`list(int size)`
`float`	`magSquared()`
`Coord3d`	`mul(Coord3d c2)` Multiply a Coord3d to the current one and return the result in a new Coord3d.
`Coord3d`	`mul(float value)` Multiply all components of the current Coord and return the result in a new Coord3d.
`void`	`mulSelf(Coord3d c2)`
`Coord3d`	`negative()`
`Coord3d`	`normalizeTo(float len)`
`Coord3d`	`polar()` Converts the current Coord3d into polar coordinates and return the result in a new Coord3d.
`Coord3d`	`rotate(float angleDeg, Coord3d axis)` Applies a rotation represented by the AxisAngle notation using the Rodrigues' rotation formula.
`Coord3d`	`set(Coord3d c2)`
`Coord3d`	`set(float x, float y, float z)`
`Coord3d`	`sub(Coord3d c2)` Substract a Coord3d to the current one and return the result in a new Coord3d.
`Coord3d`	`sub(float value)` Substract a value to all components of the current Coord and return the result in a new Coord3d.
`Coord3d`	`subSelf(Coord3d c2)`
`Coord3d`	`subSelf(float value)`
`float[]`	`toArray()` Return an array representation of this coordinate.
`String`	`toString()` Return a string representation of this coordinate.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ORIGIN
```
public static final Coord3d ORIGIN
```
    The origin is a Coord3d having value 0 for each dimension.
  - IDENTITY
```
public static final Coord3d IDENTITY
```
    The origin is a Coord3d having value 1 for each dimension.
  - INVALID
```
public static final Coord3d INVALID
```
    An invalid Coord2d has value NaN for each dimension.
  - x
```
public float x
```
  - y
```
public float y
```
  - z
```
public float z
```
- Constructor Detail
  - Coord3d
```
public Coord3d()
```
    Create a 3d coordinate with value 0 for each dimension.
  - Coord3d
```
public Coord3d(float xi,
               float yi,
               float zi)
```
    Create a 3d coordinate. When using polar mode, x represents azimuth, y represents elevation, and z represents range.
  - Coord3d
```
public Coord3d(Coord2d c,
               float zi)
```
  - Coord3d
```
public Coord3d(float[] c)
```
  - Coord3d
```
public Coord3d(double xi,
               double yi,
               double zi)
```
    Create a 3d coordinate. When using polar mode, x is azimuth, y is elevation, and z is range.
- Method Detail
  - list
```
public static List<Coord3d> list(int size)
```
  - getZRange
```
public static Range getZRange(List<Coord3d> coords)
```
  - set
```
public Coord3d set(Coord3d c2)
```
  - set
```
public Coord3d set(float x,
                   float y,
                   float z)
```
  - clone
```
public Coord3d clone()
```
    Return a duplicate of this 3d coordinate.
    
    Overrides:
    
    clone in class Object
  - getXY
```
public Coord2d getXY()
```
    Return the x and y component as a 2d coordinate.
  - add
```
public Coord3d add(Coord3d c2)
```
    Add a Coord3d to the current one and return the result in a new Coord3d.
    
    Parameters:
    
    c2 -
    
    Returns:
    
    the result Coord3d
  - add
```
public Coord3d add(float x,
                   float y,
                   float z)
```
  - addSelf
```
public Coord3d addSelf(Coord3d c2)
```
  - add
```
public Coord3d add(float value)
```
    Add a value to all components of the current Coord and return the result in a new Coord3d.
    
    Parameters:
    
    value -
    
    Returns:
    
    the result Coord3d
  - addSelf
```
public Coord3d addSelf(float value)
```
  - sub
```
public Coord3d sub(Coord3d c2)
```
    Substract a Coord3d to the current one and return the result in a new Coord3d.
    
    Parameters:
    
    c2 -
    
    Returns:
    
    the result Coord3d
  - subSelf
```
public Coord3d subSelf(Coord3d c2)
```
  - sub
```
public Coord3d sub(float value)
```
    Substract a value to all components of the current Coord and return the result in a new Coord3d.
    
    Parameters:
    
    value -
    
    Returns:
    
    the result Coord3d
  - subSelf
```
public Coord3d subSelf(float value)
```
  - mul
```
public Coord3d mul(Coord3d c2)
```
    Multiply a Coord3d to the current one and return the result in a new Coord3d.
    
    Parameters:
    
    c2 -
    
    Returns:
    
    the result Coord3d
  - mulSelf
```
public void mulSelf(Coord3d c2)
```
  - mul
```
public Coord3d mul(float value)
```
    Multiply all components of the current Coord and return the result in a new Coord3d.
    
    Parameters:
    
    value -
    
    Returns:
    
    the result Coord3d
  - div
```
public Coord3d div(Coord3d c2)
```
    Divise a Coord3d to the current one and return the result in a new Coord3d.
    
    Parameters:
    
    c2 -
    
    Returns:
    
    the result Coord3d
  - divSelf
```
public void divSelf(Coord3d c2)
```
  - div
```
public Coord3d div(float value)
```
    Divise all components of the current Coord by the same value and return the result in a new Coord3d.
    
    Parameters:
    
    value -
    
    Returns:
    
    the result Coord3d
  - negative
```
public Coord3d negative()
```
  - cartesian
```
public Coord3d cartesian()
```
    Converts the current Coord3d into cartesian coordinates and return the result in a new Coord3d.
    
    Returns:
    
    the result Coord3d
  - polar
```
public Coord3d polar()
```
    Converts the current Coord3d into polar coordinates and return the result in a new Coord3d.
    
    Returns:
    
    the result Coord3d
  - distance
```
public double distance(Coord3d c)
```
    Compute the distance between two coordinates.
  - distanceSq
```
public double distanceSq(Coord3d c)
```
  - magSquared
```
public float magSquared()
```
  - getNormalizedTo
```
public Coord3d getNormalizedTo(float len)
```
  - normalizeTo
```
public Coord3d normalizeTo(float len)
```
  - dot
```
public final float dot(Coord3d v)
```
  - cross
```
public final Coord3d cross(Coord3d v)
```
  - rotate
```
public final Coord3d rotate(float angleDeg,
                            Coord3d axis)
```
    Applies a rotation represented by the AxisAngle notation using the Rodrigues' rotation formula.
    math implemented using http://en.wikipedia.org/wiki/Rodrigues%27_rotation_formula
    
    Parameters:
    
    angleDeg - angle of rotation about the given axis [deg]
    
    axis - unit vector describing an axis of rotation
    
    Returns:
    
    rotated copy of the original vector
  - interpolateTo
```
public final Coord3d interpolateTo(Coord3d v,
                                   float f)
```
  - toString
```
public String toString()
```
    Return a string representation of this coordinate.
    
    Overrides:
    
    toString in class Object
  - toArray
```
public float[] toArray()
```
    Return an array representation of this coordinate.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class Coord3d

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ORIGIN

IDENTITY

INVALID

x

y

z

Constructor Detail

Coord3d

Coord3d

Coord3d

Coord3d

Coord3d

Method Detail

list

getZRange

set

set

clone

getXY

add

add

addSelf

add

addSelf

sub

subSelf

sub

subSelf

mul

mulSelf

mul

div

divSelf

div

negative

cartesian

polar

distance

distanceSq

magSquared

getNormalizedTo

normalizeTo

dot

cross

rotate

interpolateTo

toString

toArray

hashCode

equals