geomss.geom

Class GeomPlaneTrans

java.lang.Object

geomss.geom.AbstractGeomElement<GeomPlane>

geomss.geom.GeomPlane

geomss.geom.GeomPlaneTrans

All Implemented Interfaces:

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

public final class GeomPlaneTrans
extends GeomPlane
implements GeomTransform<GeomPlane>

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

Modified by: Joseph A. Huwaldt

Version:

September 13, 2016

Author:

Joseph A. Huwaldt, Date: June 14, 2009

Field Summary

Fields inherited from class geomss.geom.AbstractGeomElement

RESOURCES

Method Summary

Modifier and Type	Method and Description
GeomPlaneTrans	copy() Returns a copy of this GeomPlaneTrans instance allocated by the calling thread (possibly on the stack).
Plane	copyToReal() Return a copy of the child object transformed by this transformation.
boolean	equals(java.lang.Object obj) Compares this GeomPlaneTrans against the specified object for strict equality (same values and same units).
GeomPlane	getChild() Returns the child object transformed by this transform element.
Parameter<Length>	getConstant() Return the constant term of the plane equation (e.g.: "D" for a 3D plane: A*x + B*y + C*z = D).
GeomVector<Dimensionless>	getNormal() Return the normal vector for the plane.
int	getPhyDimension() Returns the number of physical dimensions of the geometry element.
GeomPointTrans	getRefPoint() Return the reference point for this plane.
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 geometry in this element are stated.
int	hashCode() Returns the hash code for this object.
Plane	immutable() Return an immutable version of this plane.
static GeomPlaneTrans	newInstance(GeomPlane child, GTransform transform) Returns a 3D GeomPlaneTrans instance holding the specified GeomPlane and GTransform.
static void	recycle(GeomPlaneTrans instance) Recycles a GeomPlaneTrans instance immediately (on the stack when executing in a StackContext).
void	setTransform(GTransform transform) Sets the transformation represented by this transformation element.
GeomPlane	to(Unit<Length> unit) Returns the equivalent to this element but stated in the specified unit.
GeomPlaneTrans	toDimension(int newDim) Return the equivalent of this plane converted to the specified number of physical dimensions.

Methods inherited from class geomss.geom.GeomPlane

changeRefPoint, getBoundsMax, getBoundsMin, getClosest, getLimitPoint, getParDimension, getTransformed, intersect, intersect, intersect, isValid, size, 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, isValid, putAllUserData, putUserData, removeChangeListener, removeUserData, setName, size, toText

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

newInstance

public static GeomPlaneTrans newInstance(GeomPlane child,
                                         GTransform transform)

Returns a 3D GeomPlaneTrans instance holding the specified GeomPlane and GTransform.

Parameters:

child - The plane 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<GeomPlane>

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<GeomPlane>

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<GeomPlane>

Parameters:

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

getChild

public GeomPlane getChild()

Returns the child object transformed by this transform element.

Specified by:

getChild in interface GeomTransform<GeomPlane>

Returns:

The child object transformed by this transform element.

copyToReal

public Plane copyToReal()

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

Specified by:

copyToReal in interface GeomElement<GeomPlane>

Specified by:

copyToReal in interface GeomTransform<GeomPlane>

Returns:

A copy of the child object transformed by this transformation.

immutable

public Plane immutable()

Return an immutable version of this plane.

Specified by:

immutable in class GeomPlane

Returns:

An immutable version of this plane.

recycle

public static void recycle(GeomPlaneTrans instance)

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

Parameters:

instance - The instance to be recycled.

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<GeomPlane>

Returns:

The number of physical dimensions of this geometry element.

getNormal

public GeomVector<Dimensionless> getNormal()

Return the normal vector for the plane. The normal vector is a unit vector that is perpendicular to the plane.

Specified by:

getNormal in class GeomPlane

Returns:

The normal vector for the plane.

getConstant

public Parameter<Length> getConstant()

Return the constant term of the plane equation (e.g.: "D" for a 3D plane: A*x + B*y + C*z = D).

Specified by:

getConstant in class GeomPlane

Returns:

The constant term of the plane equation for this plane.

getRefPoint

public GeomPointTrans getRefPoint()

Return the reference point for this plane. The reference point is an arbitrary point that is contained in the plane and is used as a reference when drawing the plane.

Specified by:

getRefPoint in class GeomPlane

Returns:

The reference point for this plane.

toDimension

public GeomPlaneTrans toDimension(int newDim)

Return the equivalent of this plane 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<GeomPlane>

Specified by:

toDimension in class GeomPlane

Parameters:

newDim - The dimension of the plane to return. MUST equal 3.

Returns:

The equivalent of this plane converted to the new dimensions.

Throws:

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

getUnit

public Unit<Length> getUnit()

Returns the unit in which the geometry in this element are stated.

Specified by:

getUnit in interface GeomElement<GeomPlane>

Returns:

The unit in which the geometry in this element are stated.

to

public GeomPlane to(Unit<Length> unit)
             throws ConversionException

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

WARNING: If the unit changes, then the returned transform element DOES NOT refer back to the original plane (the link with the original plane is broken).

Specified by:

to in interface GeomElement<GeomPlane>

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:

ConversionException - if the the input unit is not a length unit.

equals

public boolean equals(java.lang.Object obj)

Compares this GeomPlaneTrans against the specified object for strict equality (same values and same units).

Overrides:

equals in class AbstractGeomElement<GeomPlane>

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 object.

Overrides:

hashCode in class AbstractGeomElement<GeomPlane>

Returns:

the hash code value.

copy

public GeomPlaneTrans copy()

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

Specified by:

copy in interface GeomElement<GeomPlane>

Specified by:

copy in class GeomPlane

Returns:

an identical and independent copy of this object.