Abstract3d (JavaSCAD 0.9.2.2 API)

java.lang.Object
- eu.printingin3d.javascad.coords.Abstract3d

Direct Known Subclasses:

Basic3dFunc, Normal3d
```
public abstract class Abstract3d
extends Object
```
The base class of all 3D related coordinate classes such as dimensions, angles or coordinates.

Author:

ivivan

Field Summary

Fields
Modifier and Type Field and Description

protected double x

protected double y

protected double z

Fields
Modifier and Type	Field and Description
`protected double`	`x`
`protected double`	`y`
`protected double`	`z`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Abstract3d(double x, double y, double z)

Constructors
Modifier	Constructor and Description
`protected`	`Abstract3d(double x, double y, double z)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`closeEquals(Abstract3d value1, Abstract3d value2)` Checks a much closer equal relation than the equals method does.
`double`	`dot(Abstract3d a)` Returns the dot product of this vector and the specified vector.
`boolean`	`equals(Object obj)`
`String`	`format(OutputFormat outputFormat)` Formats the coordinates using the given output format.
`double`	`getX()`
`double`	`getY()`
`double`	`getZ()`
`int`	`hashCode()`
`boolean`	`isIdent()` Checks if all three coordinates are one.
`boolean`	`isXZero()` Checks if the X coordinate is zero.
`boolean`	`isYZero()` Checks if the Y coordinate is zero.
`boolean`	`isZero()` Checks if all three coordinates are zero, which means it is equals to isXZero() && isYZero() && isZZero().
`boolean`	`isZZero()` Checks if the Z coordinate is zero.
`double`	`magnitude()` Returns the magnitude of this vector.
`void`	`toByteArray(ByteBuffer byteBuffer)` Returns the byte array representation of this object used by the binary STL export function.
`String`	`toString()`

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

- Field Detail
  - x
```
protected final double x
```
  - y
```
protected final double y
```
  - z
```
protected final double z
```
- Constructor Detail
  - Abstract3d
```
protected Abstract3d(double x,
                     double y,
                     double z)
```
- Method Detail
  - isXZero
```
public final boolean isXZero()
```
    Checks if the X coordinate is zero.
    
    Returns:
    
    return true if and only if the X coordinate is zero
  - isYZero
```
public final boolean isYZero()
```
    Checks if the Y coordinate is zero.
    
    Returns:
    
    return true if and only if the Y coordinate is zero
  - isZZero
```
public final boolean isZZero()
```
    Checks if the Z coordinate is zero.
    
    Returns:
    
    return true if and only if the Z coordinate is zero
  - isZero
```
public final boolean isZero()
```
    Checks if all three coordinates are zero, which means it is equals to isXZero() && isYZero() && isZZero().
    
    Returns:
    
    return true if and only if all three coordinates are zero
  - isIdent
```
public final boolean isIdent()
```
    Checks if all three coordinates are one.
    
    Returns:
    
    return true if and only if all three coordinates are one
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - format
```
public String format(OutputFormat outputFormat)
```
    Formats the coordinates using the given output format.
    
    Parameters:
    
    outputFormat - the output format to be used
    
    Returns:
    
    the string representation of this object
  - toByteArray
```
public void toByteArray(ByteBuffer byteBuffer)
```
    Returns the byte array representation of this object used by the binary STL export function. There will be 3x4 bytes to be written to the output buffer.
    
    Parameters:
    
    byteBuffer - the byte buffer where the coordinates will be written.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - closeEquals
```
public static boolean closeEquals(Abstract3d value1,
                                  Abstract3d value2)
```
    Checks a much closer equal relation than the equals method does. The difference could be much smaller this way.
    
    Parameters:
    
    value1 - the first value to be checked
    
    value2 - the second value to be checked
    
    Returns:
    
    true if and only if the two coordinate is very close to each other
  - getX
```
public double getX()
```
    Returns:
    
    the X coordinate
  - getY
```
public double getY()
```
    Returns:
    
    the Y coordinate
  - getZ
```
public double getZ()
```
    Returns:
    
    the Z coordinate
  - dot
```
public double dot(Abstract3d a)
```
    Returns the dot product of this vector and the specified vector.
    
    Parameters:
    
    a - the second vector
    
    Returns:
    
    the dot product of this vector and the specified vector
  - magnitude
```
public double magnitude()
```
    Returns the magnitude of this vector. Note: this vector is not modified.
    
    Returns:
    
    the magnitude of this vector

Class Abstract3d

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

x

y

z

Constructor Detail

Abstract3d

Method Detail

isXZero

isYZero

isZZero

isZero

isIdent

toString

format

toByteArray

hashCode

equals

closeEquals

getX

getY

getZ

dot

magnitude