GeomPointTrans

java.lang.Object
- geomss.geom.AbstractGeomElement<GeomPoint>
- - geomss.geom.GeomPoint
  - - geomss.geom.GeomPointTrans

All Implemented Interfaces:

GeomElement<GeomPoint>, GeomTransform<GeomPoint>, PointGeometry<GeomPoint>, Transformable<GeomPoint>, j2me.io.Serializable, java.lang.Cloneable, java.lang.Comparable, javolution.lang.Reusable, javolution.xml.XMLSerializable
```
public final class GeomPointTrans
extends GeomPoint
implements GeomTransform<GeomPoint>
```
A GeomTransform element that refers to a GeomPoint object and masquerades as a GeomPoint object itself.
Modified by: Joseph A. Huwaldt

Version:

October 14, 2017

Author:

Joseph A. Huwaldt, Date: April 30, 2009

Field Summary
- Fields inherited from class geomss.geom.GeomPoint
  W, X, Y, Z
- Fields inherited from class geomss.geom.AbstractGeomElement
  RESOURCES

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GeomPointTrans`	`copy()` Returns a copy of this GeomPointTrans instance `allocated` by the calling thread (possibly on the stack).
`Point`	`copyToReal()` Return a copy of the child object transformed by this transformation.
`boolean`	`equals(java.lang.Object obj)` Compares this GeomPointTrans against the specified object for strict equality (same values and same units).
`GeomPoint`	`getChild()` Returns the child object transformed by this transform element.
`int`	`getPhyDimension()` Returns the number of physical dimensions of the geometry element.
`GTransform`	`getTotalTransform()` Returns the total transformation represented by an entire chain of GeomTransform objects below this one.
`GTransform`	`getTransform()` Returns the transformation represented by this transformation element.
`Unit<Length>`	`getUnit()` Returns the unit in which the `values` in this point are stated in.
`double`	`getValue(int i)` Returns the value of the Parameter in this point as a `double`, stated in this point's `unit`.
`double`	`getValue(int i, Unit<Length> unit)` Returns the value of a coordinate in this point as a `double`, stated in the specified unit.
`int`	`hashCode()` Returns the hash code for this parameter.
`Point`	`immutable()` Return an immutable version of this point.
`boolean`	`isValid()` Return `true` if this point contains valid and finite numerical components.
`static void`	`main(java.lang.String[] args)` Tests the methods in this class.
`Point`	`minus(GeomPoint that)` Returns the difference between this point and the one specified.
`Point`	`minus(Parameter<Length> that)` Subtracts the specified parameter from each component of this point.
`static GeomPointTrans`	`newInstance(GeomPoint child, GTransform transform)` Returns a 3D `GeomPointTrans` instance holding the specified `GeomPoint` and `GTransform`.
`double`	`normSqValue()` Returns the square of the Euclidean norm, magnitude, or length value of the vector from the origin to this point (the dot product of the origin-to-this-point vector and itself).
`Point`	`opposite()` Returns the negation of this point (all the values of each dimension negated).
`Point`	`plus(GeomPoint that)` Returns the sum of this point with the one specified.
`Point`	`plus(Parameter<Length> that)` Adds the specified parameter to each component of this point.
`static void`	`recycle(GeomPointTrans instance)` Recycles a `GeomPointTrans` instance immediately (on the stack when executing in a `StackContext`).
`void`	`setTransform(GTransform transform)` Sets the transformation represented by this transformation element.
`Point`	`times(double k)` Returns the product of this point with the specified coefficient.
`GeomPointTrans`	`to(Unit<Length> unit)` Returns the equivalent of this GeomPointTrans object that has a child point in the specified units.
`GeomPointTrans`	`toDimension(int newDim)` Return the equivalent of this point converted to the specified number of physical dimensions.
`Float64Vector`	`toFloat64Vector()` Returns the values stored in this transformed point, stated in this point's `unit`, as a Float64Vector.
`Vector3D<Length>`	`toVector3D()` Returns a Vector3D representation of this transformed point if possible.

Methods inherited from class geomss.geom.GeomPoint
distance, distanceSq, distanceSqValue, distanceValue, divide, divide, get, getBoundsMax, getBoundsMin, getLimitPoint, getNumberOfPoints, getParDimension, getTransformed, isApproxEqual, isApproxEqual, max, min, norm, normSq, normValue, size, times, toArray, toArray, toGeomVector, toParameterVector, toText

Methods inherited from class geomss.geom.AbstractGeomElement
addChangeListener, clone, compareTo, getAllUserData, getID, getName, getUserData, putAllUserData, putUserData, removeChangeListener, removeUserData, reset, setName, toString

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

Methods inherited from interface geomss.geom.Transformable
getTransformed

Methods inherited from interface geomss.geom.GeomElement
addChangeListener, getAllUserData, getBoundsMax, getBoundsMin, getID, getLimitPoint, getName, getParDimension, getUserData, putAllUserData, putUserData, removeChangeListener, removeUserData, setName, size, toText

Methods inherited from interface java.lang.Comparable
compareTo

- Method Detail
  - newInstance
```
public static GeomPointTrans newInstance(GeomPoint child,
                                         GTransform transform)
```
    Returns a 3D GeomPointTrans instance holding the specified GeomPoint and GTransform.
    
    Parameters:
    
    child - The point that is the child of this transform element (may not be null).
    
    transform - The transform held by this transform element (may not be null).
    
    Returns:
    
    the transform element having the specified values.
    
    Throws:
    
    DimensionException - if the input element is not 3D.
  - getTransform
```
public GTransform getTransform()
```
    Returns the transformation represented by this transformation element.
    
    Specified by:
    
    getTransform in interface GeomTransform<GeomPoint>
    
    Returns:
    
    The transformation represented by this transformation element.
  - getTotalTransform
```
public GTransform getTotalTransform()
```
    Returns the total transformation represented by an entire chain of GeomTransform objects below this one.
    
    Specified by:
    
    getTotalTransform in interface GeomTransform<GeomPoint>
    
    Returns:
    
    The total transformation represented by an entire chain of GeomTransform objects below this one.
  - setTransform
```
public void setTransform(GTransform transform)
```
    Sets the transformation represented by this transformation element.
    
    Specified by:
    
    setTransform in interface GeomTransform<GeomPoint>
    
    Parameters:
    
    transform - The transform to set this transform element to (may not be null).
  - getChild
```
public GeomPoint getChild()
```
    Returns the child object transformed by this transform element.
    
    Specified by:
    
    getChild in interface GeomTransform<GeomPoint>
    
    Returns:
    
    The child object transformed by this transform element.
  - copyToReal
```
public Point copyToReal()
```
    Return a copy of the child object transformed by this transformation.
    
    Specified by:
    
    copyToReal in interface GeomElement<GeomPoint>
    
    Specified by:
    
    copyToReal in interface GeomTransform<GeomPoint>
    
    Specified by:
    
    copyToReal in class GeomPoint
    
    Returns:
    
    A copy of the child object transformed by this transformation.
  - recycle
```
public static void recycle(GeomPointTrans instance)
```
    Recycles a GeomPointTrans instance immediately (on the stack when executing in a StackContext).
    
    Parameters:
    
    instance - The instance to be recycled.
  - immutable
```
public Point immutable()
```
    Return an immutable version of this point.
    
    Specified by:
    
    immutable in class GeomPoint
    
    Returns:
    
    An immutable version of this plane.
  - getPhyDimension
```
public int getPhyDimension()
```
    Returns the number of physical dimensions of the geometry element. This implementation always returns 3.
    
    Specified by:
    
    getPhyDimension in interface GeomElement<GeomPoint>
    
    Returns:
    
    The number of physical dimensions of this geometry element.
  - getValue
```
public double getValue(int i)
```
    Returns the value of the Parameter in this point as a double, stated in this point's unit.
    
    Specified by:
    
    getValue in class GeomPoint
    
    Parameters:
    
    i - the dimension index.
    
    Returns:
    
    the value of the Parameter at i.
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - (i < 0) || (i ≥ dimension())
  - getValue
```
public double getValue(int i,
                       Unit<Length> unit)
```
    Returns the value of a coordinate in this point as a double, stated in the specified unit.
    
    Specified by:
    
    getValue in class GeomPoint
    
    Parameters:
    
    i - the dimension index.
    
    unit - the unit to return the value in. May not be null.
    
    Returns:
    
    the value of the Parameter at i in the specified unit.
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - (i < 0) || (i ≥ dimension())
  - normSqValue
```
public double normSqValue()
```
    Returns the square of the Euclidean norm, magnitude, or length value of the vector from the origin to this point (the dot product of the origin-to-this-point vector and itself). This is slightly faster than calling normValue if the squared value is all that is needed.
    
    Specified by:
    
    normSqValue in class GeomPoint
    
    Returns:
    
    this.normSq().getValue().
    
    See Also:
    
    GeomPoint.normValue()
  - plus
```
public Point plus(GeomPoint that)
```
    Returns the sum of this point with the one specified. The unit of the output point will be the units of this point.
    
    Specified by:
    
    plus in class GeomPoint
    
    Parameters:
    
    that - the point to be added. May not be null.
    
    Returns:
    
    this + that.
    
    Throws:
    
    DimensionException - if point dimensions are different.
  - plus
```
public Point plus(Parameter<Length> that)
```
    Adds the specified parameter to each component of this point. The unit of the output point will be the units of this point.
    
    Specified by:
    
    plus in class GeomPoint
    
    Parameters:
    
    that - the parameter to be added to each component of this point. May not be null.
    
    Returns:
    
    this + that.
  - minus
```
public Point minus(GeomPoint that)
```
    Returns the difference between this point and the one specified. The unit of the output point will be the units of this point.
    
    Specified by:
    
    minus in class GeomPoint
    
    Parameters:
    
    that - the point to be subtracted from this point. May not be null.
    
    Returns:
    
    this - that.
    
    Throws:
    
    DimensionException - if point dimensions are different.
  - minus
```
public Point minus(Parameter<Length> that)
```
    Subtracts the specified parameter from each component of this point. The unit of the output point will be the units of this point.
    
    Specified by:
    
    minus in class GeomPoint
    
    Parameters:
    
    that - the parameter to be subtracted from each component of this point. May not be null.
    
    Returns:
    
    this - that.
  - opposite
```
public Point opposite()
```
    Returns the negation of this point (all the values of each dimension negated).
    
    Specified by:
    
    opposite in class GeomPoint
    
    Returns:
    
    -this
  - times
```
public Point times(double k)
```
    Returns the product of this point with the specified coefficient.
    
    Specified by:
    
    times in class GeomPoint
    
    Parameters:
    
    k - the coefficient multiplier.
    
    Returns:
    
    this · k
  - isValid
```
public boolean isValid()
```
    Return true if this point contains valid and finite numerical components. A value of false will be returned if any of the coordinate values are NaN or Inf.
    
    Specified by:
    
    isValid in interface GeomElement<GeomPoint>
    
    Overrides:
    
    isValid in class GeomPoint
    
    Returns:
    
    true if this geometry element contains valid and finite data.
  - copy
```
public GeomPointTrans copy()
```
    Returns a copy of this GeomPointTrans instance allocated by the calling thread (possibly on the stack).
    
    Specified by:
    
    copy in interface GeomElement<GeomPoint>
    
    Specified by:
    
    copy in class GeomPoint
    
    Returns:
    
    an identical and independent copy of this point.
  - getUnit
```
public Unit<Length> getUnit()
```
    Returns the unit in which the values in this point are stated in.
    
    Specified by:
    
    getUnit in interface GeomElement<GeomPoint>
    
    Returns:
    
    The unit in which the geometry in this element are stated.
  - to
```
public GeomPointTrans to(Unit<Length> unit)
                  throws ConversionException
```
    Returns the equivalent of this GeomPointTrans object that has a child point in the specified units.
    WARNING: If the unit changes, then the returned transform element DOES NOT refer back to the original point (the link with the original point is broken).
    
    Specified by:
    
    to in interface GeomElement<GeomPoint>
    
    Specified by:
    
    to in interface PointGeometry<GeomPoint>
    
    Parameters:
    
    unit - the length unit of the point to be returned. May not be null.
    
    Returns:
    
    an equivalent to this point but stated in the specified unit.
    
    Throws:
    
    ConversionException - if the the input unit is not a length unit.
  - toVector3D
```
public Vector3D<Length> toVector3D()
```
    Returns a Vector3D representation of this transformed point if possible.
    
    Overrides:
    
    toVector3D in class GeomPoint
    
    Returns:
    
    A Vector3D that is equivalent to this transformed point
    
    Throws:
    
    DimensionException - if this point has any number of dimensions other than 3.
  - toFloat64Vector
```
public Float64Vector toFloat64Vector()
```
    Returns the values stored in this transformed point, stated in this point's unit, as a Float64Vector.
    
    Specified by:
    
    toFloat64Vector in class GeomPoint
    
    Returns:
    
    A Float64Vector containing the values stored in this point in the current units.
  - toDimension
```
public GeomPointTrans toDimension(int newDim)
```
    Return the equivalent of this point converted to the specified number of physical dimensions. This implementation will throw an exception if the specified dimension is anything other than 3.
    
    Specified by:
    
    toDimension in interface GeomElement<GeomPoint>
    
    Parameters:
    
    newDim - The dimension of the point to return. MUST equal 3.
    
    Returns:
    
    The equivalent of this point converted to the new dimensions.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the new dimension is anything other than 3.
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Compares this GeomPointTrans against the specified object for strict equality (same values and same units).
    
    Overrides:
    
    equals in class AbstractGeomElement<GeomPoint>
    
    Parameters:
    
    obj - the object to compare with.
    
    Returns:
    
    true if this point is identical to that point; false otherwise.
  - hashCode
```
public int hashCode()
```
    Returns the hash code for this parameter.
    
    Overrides:
    
    hashCode in class AbstractGeomElement<GeomPoint>
    
    Returns:
    
    the hash code value.
  - main
```
public static void main(java.lang.String[] args)
```
    Tests the methods in this class.
    
    Parameters:
    
    args - Command-line arguments (not used).

Class GeomPointTrans

Field Summary

Fields inherited from class geomss.geom.GeomPoint

Fields inherited from class geomss.geom.AbstractGeomElement

Method Summary

Methods inherited from class geomss.geom.GeomPoint

Methods inherited from class geomss.geom.AbstractGeomElement

Methods inherited from class java.lang.Object

Methods inherited from interface geomss.geom.Transformable

Methods inherited from interface geomss.geom.GeomElement

Methods inherited from interface java.lang.Comparable

Method Detail

newInstance

getTransform

getTotalTransform

setTransform

getChild

copyToReal

recycle

immutable

getPhyDimension

getValue

getValue

normSqValue

plus

plus

minus

minus

opposite

times

isValid

copy

getUnit

to

toVector3D

toFloat64Vector

toDimension

equals

hashCode

main