Package geomss.geom

Class TriangleTrans

java.lang.Object

geomss.geom.AbstractGeomElement<GeomTriangle>

geomss.geom.GeomTriangle

geomss.geom.TriangleTrans

All Implemented Interfaces:

GeomElement<GeomTriangle>, GeomTransform<GeomTriangle>, PointGeometry<GeomTriangle>, Transformable<GeomTriangle>, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, javolution.lang.Reusable, javolution.xml.XMLSerializable

public final class TriangleTrans
extends GeomTriangle
implements GeomTransform<GeomTriangle>

A GeomTransform object that refers to a Triangle object and masquerades as a Triangle object itself.

Modified by: Joseph A. Huwaldt

Version:

April 10, 2018

Author:

Joseph A. Huwaldt, Date: August 26, 2015

See Also:

Serialized Form

Field Summary

Fields inherited from class geomss.geom.AbstractGeomElement

RESOURCES

Method Summary

Modifier and Type	Method	Description
TriangleTrans	copy()	Returns a copy of this TriangleTrans instance allocated by the calling thread (possibly on the stack).
Triangle	copyToReal()	Return a copy of the child object transformed by this transformation.
boolean	equals(java.lang.Object obj)	Compares this TriangleTrans against the specified object for strict equality.
Parameter<javax.measure.quantity.Area>	getArea()	Return the surface area of one side of this triangle.
Point	getBoundsMax()	Return the coordinate point representing the maximum bounding box corner (e.g.: max X, max Y, max Z).
Point	getBoundsMin()	Return the coordinate point representing the minimum bounding box corner of this geometry element (e.g.: min X, min Y, min Z).
GeomTriangle	getChild()	Returns the child object transformed by this transform element.
VectorTrans<javax.measure.quantity.Dimensionless>	getNormal()	Return the surface unit normal vector for this triangle.
GeomPoint	getP1()	Return the first vertex in this triangle.
GeomPoint	getP2()	Return the second vertex in this triangle.
GeomPoint	getP3()	Return the third and last vertex in this triangle.
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.
TriangleTrans	getTransformed(GTransform transform)	Returns transformed version of this element.
javax.measure.unit.Unit<javax.measure.quantity.Length>	getUnit()	Returns the unit in which this triangle is stated.
int	hashCode()	Returns the hash code for this parameter.
static TriangleTrans	newInstance(GeomTriangle child, GTransform transform)	Returns a 3D TriangleTrans instance holding the specified GeomTriangle and GTransform.
static void	recycle(TriangleTrans instance)	Recycles a TriangleTrans instance immediately (on the stack when executing in a StackContext).
TriangleTrans	reverse()	Return a new triangle that is identical to this one, but with the order of the points (and the surface normal direction) reversed.
void	setTransform(GTransform transform)	Sets the transformation represented by this transformation element.
TriangleTrans	to(javax.measure.unit.Unit<javax.measure.quantity.Length> unit)	Returns the equivalent to this element but stated in the specified unit.
TriangleTrans	toDimension(int newDim)	Return a copy of this Triangle converted to the specified number of physical dimensions.

Methods inherited from class geomss.geom.GeomTriangle

getAll, getLimitPoint, getNumberOfPoints, getParDimension, getPoints, getPoints, isDegenerate, isValid, reset, size, toText

Methods inherited from class geomss.geom.AbstractGeomElement

addChangeListener, clone, compareTo, getAllUserData, getID, getName, getUserData, putAllUserData, putUserData, removeChangeListener, removeUserData, setName, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface geomss.geom.GeomElement

addChangeListener, getAllUserData, getID, getLimitPoint, getName, getParDimension, getUserData, isValid, putAllUserData, putUserData, removeChangeListener, removeUserData, setName, size, toText

Method Detail

newInstance

public static TriangleTrans newInstance(GeomTriangle child,
                                        GTransform transform)

Returns a 3D TriangleTrans instance holding the specified GeomTriangle and GTransform.

Parameters:

child - The GeomTriangle 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.

getTransform

public GTransform getTransform()

Returns the transformation represented by this transformation element.

Specified by:

getTransform in interface GeomTransform<GeomTriangle>

Returns:

The transformation from the child object represented by this 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<GeomTriangle>

Returns:

The total transformation represented by the entire chain of objects below this one.

setTransform

public void setTransform(GTransform transform)

Sets the transformation represented by this transformation element.

Specified by:

setTransform in interface GeomTransform<GeomTriangle>

Parameters:

transform - The transform to set this transform element to (may not be null).

getChild

public GeomTriangle getChild()

Returns the child object transformed by this transform element.

Specified by:

getChild in interface GeomTransform<GeomTriangle>

Returns:

The child object transformed by this transform element.

copyToReal

public Triangle copyToReal()

Return a copy of the child object transformed by this transformation.

Specified by:

copyToReal in interface GeomElement<GeomTriangle>

Specified by:

copyToReal in interface GeomTransform<GeomTriangle>

Returns:

A copy of the child object transformed by this transformation.

getP1

public GeomPoint getP1()

Return the first vertex in this triangle.

Specified by:

getP1 in class GeomTriangle

Returns:

The first vertex in this triangle.

getP2

public GeomPoint getP2()

Return the second vertex in this triangle.

Specified by:

getP2 in class GeomTriangle

Returns:

The second vertex in this triangle.

getP3

public GeomPoint getP3()

Return the third and last vertex in this triangle.

Specified by:

getP3 in class GeomTriangle

Returns:

The third and last vertex in this triangle.

getNormal

public VectorTrans<javax.measure.quantity.Dimensionless> getNormal()

Return the surface unit normal vector for this triangle. If the triangle is degenerate (zero area), then the normal vector will have zero length.

Specified by:

getNormal in class GeomTriangle

Returns:

The surface normal vector for this triangle.

getArea

public Parameter<javax.measure.quantity.Area> getArea()

Return the surface area of one side of this triangle. The returned area is always positive, but can be zero.

Specified by:

getArea in class GeomTriangle

Returns:

The surface area of one side of this triangle.

getPhyDimension

public int getPhyDimension()

Returns the number of physical dimensions of the geometry element.

Specified by:

getPhyDimension in interface GeomElement<GeomTriangle>

Overrides:

getPhyDimension in class GeomTriangle

Returns:

The number of physical dimensions of this geometry element.

reverse

public TriangleTrans reverse()

Return a new triangle that is identical to this one, but with the order of the points (and the surface normal direction) reversed.

Specified by:

reverse in class GeomTriangle

Returns:

A new Triangle that is identical to this one, but with the order of the points reversed.

getBoundsMin

public Point getBoundsMin()

Return the coordinate point representing the minimum bounding box corner of this geometry element (e.g.: min X, min Y, min Z).

Specified by:

getBoundsMin in interface GeomElement<GeomTriangle>

Returns:

The minimum bounding box coordinate for this geometry element.

Throws:

java.lang.IndexOutOfBoundsException - if this list contains no elements.

getBoundsMax

public Point getBoundsMax()

Return the coordinate point representing the maximum bounding box corner (e.g.: max X, max Y, max Z).

Specified by:

getBoundsMax in interface GeomElement<GeomTriangle>

Returns:

The maximum bounding box coordinate for this geometry element.

Throws:

java.lang.IndexOutOfBoundsException - if this list contains no elements.

getTransformed

public TriangleTrans getTransformed(GTransform transform)

Returns transformed version of this element. The returned object implements GeomTransform and contains this element as a child.

Specified by:

getTransformed in interface Transformable<GeomTriangle>

Parameters:

transform - The transformation to apply to this geometry. May not be null.

Returns:

A new line segment that is identical to this one with the specified transformation applied.

Throws:

DimensionException - if this point is not 3D.

getUnit

public javax.measure.unit.Unit<javax.measure.quantity.Length> getUnit()

Returns the unit in which this triangle is stated.

Specified by:

getUnit in interface GeomElement<GeomTriangle>

Overrides:

getUnit in class GeomTriangle

Returns:

The unit in which this GeomTriangle is stated.

to

public TriangleTrans to(javax.measure.unit.Unit<javax.measure.quantity.Length> unit)
                 throws javax.measure.converter.ConversionException

Returns the equivalent to this element but stated in the specified unit.

Specified by:

to in interface GeomElement<GeomTriangle>

Specified by:

to in interface PointGeometry<GeomTriangle>

Parameters:

unit - the length unit of the element to be returned. May not be null.

Returns:

an equivalent to this element but stated in the specified unit.

Throws:

javax.measure.converter.ConversionException - if the the input unit is not a length unit.

toDimension

public TriangleTrans toDimension(int newDim)

Return a copy of this Triangle converted to the specified number of physical dimensions. If the number of dimensions is greater than this element, then zeros are added to the additional dimensions. If the number of dimensions is less than this element, then the extra dimensions are simply dropped (truncated). If the new dimensions are the same as the dimension of this element, then this element is simply returned.

Specified by:

toDimension in interface GeomElement<GeomTriangle>

Parameters:

newDim - The dimension of the Triangle to return.

Returns:

This Triangle converted to the new dimensions.

Throws:

java.lang.IllegalArgumentException - if the new dimension is anything other than 3.

copy

public TriangleTrans copy()

Returns a copy of this TriangleTrans instance allocated by the calling thread (possibly on the stack).

Specified by:

copy in interface GeomElement<GeomTriangle>

Returns:

an identical and independent copy of this point.

equals

public boolean equals(java.lang.Object obj)

Compares this TriangleTrans against the specified object for strict equality.

Overrides:

equals in class AbstractGeomElement<GeomTriangle>

Parameters:

obj - the object to compare with.

Returns:

true if this transform is identical to that transform; false otherwise.

hashCode

public int hashCode()

Returns the hash code for this parameter.

Overrides:

hashCode in class AbstractGeomElement<GeomTriangle>

Returns:

the hash code value.

recycle

public static void recycle(TriangleTrans instance)

Recycles a TriangleTrans instance immediately (on the stack when executing in a StackContext).

Parameters:

instance - The instance to recycle immediately.