Point3 (CML Euclid 2.9 API)

java.lang.Object
- org.xmlcml.euclid.Point3

All Implemented Interfaces:

EuclidConstants
```
public class Point3
extends Object
implements EuclidConstants
```
3-dimensional point class Point3 represents a 3-dimensional point. It is one of a set of primitives which can be combined to create and manipulate complex 3-dimensional objects. Points can be transformed with rotation matrices or rotation-translation matrices (Transform3), can be calculated from other primitives or can be used to generate other primitives. Default point is 0.0, 0.0, 0.0

Author:

Peter Murray-Rust, (C) P. Murray-Rust, 1996

See Also:

Vector3, Line3, Point3Vector, Plane3

Field Summary

Fields
Modifier and Type Field and Description

static double CRYSTALFRACTEPSILON
tolerance between crystal fractional coordinates.

protected double[] flarray
the coordinates of the point
- Fields inherited from interface org.xmlcml.euclid.EuclidConstants
  C_AMP, C_APOS, C_ATSIGN, C_BACKSLASH, C_BACKSPACE, C_CARET, C_COLON, C_COMMA, C_DEL, C_DOLLAR, C_EQUALS, C_FORMFEED, C_HASH, C_LANGLE, C_LBRAK, C_LCURLY, C_LSQUARE, C_MINUS, C_NBSP, C_NEWLINE, C_NL, C_PERCENT, C_PERIOD, C_PIPE, C_PLUS, C_POUND, C_QUERY, C_QUOT, C_RANGLE, C_RBRAK, C_RCURLY, C_RETURN, C_RSQUARE, C_SEMICOLON, C_SHRIEK, C_SLASH, C_SPACE, C_STAR, C_TAB, C_TILDE, C_UNDER, EPS, F_S, NONWHITEPUNC, NONWHITEPUNC0, NONWHITEPUNC0REGEX, ONE_THIRD, PUNC, S_AMP, S_APOS, S_ATSIGN, S_BACKSLASH, S_CARET, S_COLON, S_COMMA, S_DOLLAR, S_EMPTY, S_EQUALS, S_FORMFEED, S_HASH, S_LANGLE, S_LBRAK, S_LCURLY, S_LSQUARE, S_MINUS, S_NEWLINE, S_NL, S_PERCENT, S_PERIOD, S_PIPE, S_PLUS, S_POUND, S_QUERY, S_QUOT, S_RANGLE, S_RBRAK, S_RCURLY, S_RETURN, S_RSQUARE, S_SEMICOLON, S_SHRIEK, S_SLASH, S_SPACE, S_STAR, S_TAB, S_TILDE, S_UNDER, S_WHITEREGEX, TWO_THIRDS, U_S, WHITESPACE

Fields
Modifier and Type	Field and Description
`static double`	`CRYSTALFRACTEPSILON` tolerance between crystal fractional coordinates.
`protected double[]`	`flarray` the coordinates of the point

Constructor Summary

Constructors
Constructor and Description
`Point3()` constructor.
`Point3(double[] f)` constructor from a double[] (or a RealArray).
`Point3(double x, double y, double z)` formed from point components
`Point3(Point3 p)` copy constructor
`Point3(Vector3 v)` make a point from a vector creates the point at head of vector rooted at the origin

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Point3`	`calculateFromInternalCoordinates(Point3 p1, Point3 p2, Point3 p3, double length, Angle angle, Angle torsion)` add point using internal coordinates.
`void`	`clear()` sets the point to the origin
`double`	`distanceFromLine(Line3 l)` distance from line.
`double`	`distanceFromPlane(Plane3 pl)` distance from plane
`Point3`	`divideBy(double f)` scale point does NOT alter this
`void`	`divideEquals(double f)` scale point.
`double`	`elementAt(int n)` subscript operator.
`boolean`	`equals(Object that)` equals.
`boolean`	`equalsCrystallographically(Point3 p)` are two crystallographic points identical.
`static Angle`	`getAngle(Point3 p1, Point3 p2, Point3 p3)` get angle.
`double[]`	`getArray()` get components as double[]
`Point3`	`getClosestPointOnLine(Line3 l)` get closest point on line.
`double`	`getDistanceFromOrigin()` distance of point from origin.
`double`	`getDistanceFromPoint(Point3 p2)` distance of point from another point
`Point3`	`getMidPoint(Point3 p2)` mid-point of two points.
`double`	`getSquaredDistanceFromPoint(Point3 p2)` Gets the squared Distance between this point and another
`static Angle`	`getTorsion(Point3 p1, Point3 p2, Point3 p3, Point3 p4)` torsion angle.
`int`	`hashCode()` hash code.
`boolean`	`isEqualTo(Point3 p)` are two points identical.
`boolean`	`isEqualTo(Point3 p, double eps)` are two points identical.
`boolean`	`isInvariant(Transform3 t3, boolean translate)` is point invariant wrt symmetry operation.
`boolean`	`isOnLine(Line3 l)` is point on line.
`boolean`	`isOnPlane(Plane3 pl)` is point on plane.
`boolean`	`isOrigin()` is a point at Origin
`static void`	`main(String[] args)` main.
`Point3`	`multiplyBy(double f)` scale point.
`void`	`multiplyEquals(double f)` scale point.
`Vector3`	`normaliseCrystallographically()` normalise crystallographically.
`Point3`	`plus(Point3 p)` New point by adding points as vectors.
`Point3`	`plus(Vector3 v)` New point from point+vector does NOT alter this
`void`	`plusEquals(Point3 pt)` Move this Point3.
`void`	`plusEquals(Vector3 v)` point from point and vector.
`void`	`reflect()` create inverse point.
`void`	`setElementAt(int n, double d)` sets element.
`Vector3`	`subtract(Point3 p2)` vector between two points.
`Point3`	`subtract(Vector3 v)` New point from point minus vector.
`void`	`subtractEquals(Point3 pt)` Shift point from point.
`void`	`subtractEquals(Vector3 vec3)` Shift point from vector3.
`String`	`toString()` string representation.
`Point3`	`transform(Transform3 t)` get transformed point.
`void`	`transformEquals(Transform3 t)` get transformed point.

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

- Field Detail
  - CRYSTALFRACTEPSILON
```
public static final double CRYSTALFRACTEPSILON
```
    tolerance between crystal fractional coordinates. allows for 1/3 being represented as 0.3333 which will not fit normal equality
    
    See Also:
    
    Constant Field Values
  - flarray
```
protected double[] flarray
```
    the coordinates of the point
- Constructor Detail
  - Point3
```
public Point3()
```
    constructor.
  - Point3
```
public Point3(double x,
              double y,
              double z)
```
    formed from point components
    
    Parameters:
    
    x -
    
    y -
    
    z -
  - Point3
```
public Point3(Point3 p)
```
    copy constructor
    
    Parameters:
    
    p -
  - Point3
```
public Point3(double[] f)
       throws EuclidRuntimeException
```
    constructor from a double[] (or a RealArray).
    
    Parameters:
    
    f -
    
    Throws:
    
    EuclidRuntimeException
  - Point3
```
public Point3(Vector3 v)
```
    make a point from a vector creates the point at head of vector rooted at the origin
    
    Parameters:
    
    v -
- Method Detail
  - getArray
```
public double[] getArray()
```
    get components as double[]
    
    Returns:
    
    the array
  - clear
```
public void clear()
```
    sets the point to the origin
  - isEqualTo
```
public boolean isEqualTo(Point3 p)
```
    are two points identical. compares content of points with Real.isEqual()
    
    Parameters:
    
    p - point to compare
    
    Returns:
    
    equal if coordinates are equal within Real.epsilon
  - isEqualTo
```
public boolean isEqualTo(Point3 p,
                         double eps)
```
    are two points identical. compares x, y, z coordinates of points
    
    Parameters:
    
    p - point to compare
    
    eps - the tolerance
    
    Returns:
    
    equal if coordinates are equal within Real.epsilon
  - equalsCrystallographically
```
public boolean equalsCrystallographically(Point3 p)
```
    are two crystallographic points identical. shifts x, y, z by +-1.0 if necessary compares content of crystallographically normalised points with Real.isEqual()
    
    Parameters:
    
    p - point to compare
    
    Returns:
    
    equal if coordinates are equal within CRYSTALFRACTEPSILON
  - normaliseCrystallographically
```
public Vector3 normaliseCrystallographically()
```
    normalise crystallographically. shifts x, y, z so that values lie between 0.0 (inclusive) and 1.0 (exclusive) modifies this
    
    Returns:
    
    Vector3 corresponding to the translation vector to crystallographically normalise Point3
  - isInvariant
```
public boolean isInvariant(Transform3 t3,
                           boolean translate)
```
    is point invariant wrt symmetry operation. tolerance is decided by Real.isEqual()
    
    Parameters:
    
    t3 - the transformation
    
    translate - allow crystallographic translations (+-1)
    
    Returns:
    
    true if t3 transforms this onto itself
  - subtract
```
public Vector3 subtract(Point3 p2)
```
    vector between two points. result is vector FROM p2 TO this this -= p2 alters this
    
    Parameters:
    
    p2 - point to subtract
    
    Returns:
    
    vector
  - plus
```
public Point3 plus(Point3 p)
```
    New point by adding points as vectors. used for finding centroids, etc. does NOT alter this
    
    Parameters:
    
    p - to add
    
    Returns:
    
    NEW point
  - plusEquals
```
public void plusEquals(Point3 pt)
```
    Move this Point3. alters this
    
    Parameters:
    
    pt - point to shift by
  - plus
```
public Point3 plus(Vector3 v)
```
    New point from point+vector does NOT alter this
    
    Parameters:
    
    v - to add
    
    Returns:
    
    NEW point
  - plusEquals
```
public void plusEquals(Vector3 v)
```
    point from point and vector. alter this
    
    Parameters:
    
    v - to add
  - subtract
```
public Point3 subtract(Vector3 v)
```
    New point from point minus vector. does NOT alter this
    
    Parameters:
    
    v - to subtract
    
    Returns:
    
    NEW point
  - subtractEquals
```
public void subtractEquals(Point3 pt)
```
    Shift point from point. does alter this
    
    Parameters:
    
    pt - the Point3 to subtract from this
  - subtractEquals
```
public void subtractEquals(Vector3 vec3)
```
    Shift point from vector3. does alter this
    
    Parameters:
    
    vec3 - the Vector3 to subtract from this
  - multiplyBy
```
public Point3 multiplyBy(double f)
```
    scale point. does NOT alter this
    
    Parameters:
    
    f - factor to multiply by
    
    Returns:
    
    NEW point
  - multiplyEquals
```
public void multiplyEquals(double f)
```
    scale point. alters this
    
    Parameters:
    
    f - factor to multiply by
  - reflect
```
public void reflect()
```
    create inverse point. alters this = -this
  - divideBy
```
public Point3 divideBy(double f)
```
    scale point does NOT alter this
    
    Parameters:
    
    f - factor to divide by
    
    Returns:
    
    NEW point
  - divideEquals
```
public void divideEquals(double f)
```
    scale point. alters this
    
    Parameters:
    
    f - factor to divide by
  - elementAt
```
public double elementAt(int n)
                 throws EuclidRuntimeException
```
    subscript operator.
    
    Parameters:
    
    n - the index
    
    Returns:
    
    the element
    
    Throws:
    
    EuclidRuntimeException
  - setElementAt
```
public void setElementAt(int n,
                         double d)
                  throws EuclidRuntimeException
```
    sets element.
    
    Parameters:
    
    n - the index
    
    d - the value
    
    Throws:
    
    EuclidRuntimeException
  - transform
```
public Point3 transform(Transform3 t)
```
    get transformed point. does NOT modify 'this'
    
    Parameters:
    
    t - the transform
    
    Returns:
    
    new point
  - transformEquals
```
public void transformEquals(Transform3 t)
```
    get transformed point. does modify 'this'
    
    Parameters:
    
    t - the transform
  - getDistanceFromOrigin
```
public double getDistanceFromOrigin()
```
    distance of point from origin.
    
    Returns:
    
    distance
  - getSquaredDistanceFromPoint
```
public double getSquaredDistanceFromPoint(Point3 p2)
```
    Gets the squared Distance between this point and another
    
    Parameters:
    
    p2 - the other point to get the distance from
    
    Returns:
    
    the squared distance
  - getDistanceFromPoint
```
public double getDistanceFromPoint(Point3 p2)
```
    distance of point from another point
    
    Parameters:
    
    p2 - the other point to get the distance from
    
    Returns:
    
    the distance
  - distanceFromPlane
```
public double distanceFromPlane(Plane3 pl)
```
    distance from plane
    
    Parameters:
    
    pl -
    
    Returns:
    
    distance
  - getClosestPointOnLine
```
public Point3 getClosestPointOnLine(Line3 l)
```
    get closest point on line.
    
    Parameters:
    
    l - the line
    
    Returns:
    
    the point where distance is shortest
  - isOnLine
```
public boolean isOnLine(Line3 l)
```
    is point on line.
    
    Parameters:
    
    l - the line
    
    Returns:
    
    true if within Real.isEqual() of line
  - isOnPlane
```
public boolean isOnPlane(Plane3 pl)
```
    is point on plane.
    
    Parameters:
    
    pl - the plane
    
    Returns:
    
    true if within Real.isEqual() of plane
  - distanceFromLine
```
public double distanceFromLine(Line3 l)
```
    distance from line.
    
    Parameters:
    
    l - the line
    
    Returns:
    
    the distance
  - getMidPoint
```
public Point3 getMidPoint(Point3 p2)
```
    mid-point of two points.
    
    Parameters:
    
    p2 - the other point
    
    Returns:
    
    the midPoint
  - getAngle
```
public static Angle getAngle(Point3 p1,
                             Point3 p2,
                             Point3 p3)
```
    get angle. p1-p2-p3
    
    Parameters:
    
    p1 - the start point
    
    p2 - the vertex point
    
    p3 - the remote point
    
    Returns:
    
    angle null if coincient points
  - getTorsion
```
public static Angle getTorsion(Point3 p1,
                               Point3 p2,
                               Point3 p3,
                               Point3 p4)
```
    torsion angle. p1-p2-p3-p4
    
    Parameters:
    
    p1 -
    
    p2 -
    
    p3 -
    
    p4 -
    
    Returns:
    
    angle unsigned radians or null (null args, or colinearity)
  - calculateFromInternalCoordinates
```
public static Point3 calculateFromInternalCoordinates(Point3 p1,
                                                      Point3 p2,
                                                      Point3 p3,
                                                      double length,
                                                      Angle angle,
                                                      Angle torsion)
                                               throws EuclidRuntimeException
```
    add point using internal coordinates. used for z-matrix like building p1-p2-p3-newPoint
    
    Parameters:
    
    p1 - existing point
    
    p2 - existing point
    
    p3 - existing point
    
    length - p3-p4
    
    angle - p2-p3-p4
    
    torsion - this-p2-p3-p4
    
    Returns:
    
    new point; null if two points are coincident or three points are colinear
    
    Throws:
    
    EuclidRuntimeException - two points are coincident or 3 colinear
  - isOrigin
```
public boolean isOrigin()
```
    is a point at Origin
    
    Returns:
    
    is this within Real.isEqual() of origin
  - toString
```
public String toString()
```
    string representation.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the string
  - equals
```
public boolean equals(Object that)
```
    equals.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    that -
    
    Returns:
    
    is equal
  - hashCode
```
public int hashCode()
```
    hash code.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    coe
  - main
```
public static void main(String[] args)
```
    main.
    
    Parameters:
    
    args -

Class Point3

Field Summary

Fields inherited from interface org.xmlcml.euclid.EuclidConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CRYSTALFRACTEPSILON

flarray

Constructor Detail

Point3

Point3

Point3

Point3

Point3

Method Detail

getArray

clear

isEqualTo

isEqualTo

equalsCrystallographically

normaliseCrystallographically

isInvariant

subtract

plus

plusEquals

plus

plusEquals

subtract

subtractEquals

subtractEquals

multiplyBy

multiplyEquals

reflect

divideBy

divideEquals

elementAt

setElementAt

transform

transformEquals

getDistanceFromOrigin

getSquaredDistanceFromPoint

getDistanceFromPoint

distanceFromPlane

getClosestPointOnLine

isOnLine

isOnPlane

distanceFromLine

getMidPoint

getAngle

getTorsion

calculateFromInternalCoordinates

isOrigin

toString

equals

hashCode

main