geomss.geom

Class LineSegTrans

java.lang.Object

geomss.geom.AbstractGeomElement<T>

geomss.geom.AbstractCurve<LineSegment>

geomss.geom.LineSegment

geomss.geom.LineSegTrans

All Implemented Interfaces:

Curve<LineSegment>, GeomElement<LineSegment>, GeomTransform<LineSegment>, ParametricGeometry<LineSegment>, PointGeometry<LineSegment>, Transformable<LineSegment>, j2me.io.Serializable, java.lang.Cloneable, java.lang.Comparable, javolution.lang.Reusable, javolution.xml.XMLSerializable

public final class LineSegTrans
extends LineSegment
implements GeomTransform<LineSegment>

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

Modified by: Joseph A. Huwaldt

Version:

November 27, 2015

Author:

Joseph A. Huwaldt, Date: January 15, 2012

Field Summary

Fields inherited from class geomss.geom.AbstractCurve

GTOL

Fields inherited from class geomss.geom.AbstractGeomElement

RESOURCES

Method Summary

Modifier and Type	Method and Description
LineSegTrans	copy() Returns a copy of this LineSegTrans instance allocated by the calling thread (possibly on the stack).
LineSegment	copyToReal() Return a copy of the child object transformed by this transformation.
boolean	equals(java.lang.Object obj) Compares this LineSegTrans against the specified object for strict equality.
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).
LineSegment	getChild() Returns the child object transformed by this transform element.
GeomVector<Length>	getDerivativeVector() Return the dimensional derivative vector for this line segment.
GeomPoint	getEnd() Return the end point of the line segment.
int	getPhyDimension() Returns the number of physical dimensions of the geometry element.
Point	getRealPoint(double s) Calculate a point on the curve for the given parametric distance along the curve, p(s).
java.util.List<Vector<Length>>	getSDerivatives(double s, int grade) Calculate all the derivatives from 0 to grade with respect to parametric distance on the curve for the given parametric distance along the curve, d^{grade}p(s)/d^{grade}s.
GeomPoint	getStart() Return the starting point of the line segment.
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.
LineSegTrans	getTransformed(GTransform transform) Returns transformed version of this element.
Unit<Length>	getUnit() Returns the unit in which this curve is stated.
GeomVector<Dimensionless>	getUnitVector() Get unit direction vector for the line segment.
int	hashCode() Returns the hash code for this parameter.
static LineSegTrans	newInstance(LineSegment child, GTransform transform) Returns a 3D LineSegTrans instance holding the specified LineSegment and GTransform.
static void	recycle(LineSegTrans instance) Recycles a LineSegTrans instance immediately (on the stack when executing in a StackContext).
LineSegTrans	reverse() Return a new curve that is identical to this one, but with the parameterization reversed.
void	setTransform(GTransform transform) Sets the transformation represented by this transformation element.
int	size() Returns the number of child-elements that make up this geometry element.
LineSegTrans	to(Unit<Length> unit) Returns the equivalent to this curve but stated in the specified unit.
LineSegTrans	toDimension(int newDim) Return the equivalent of this line segment converted to the specified number of physical dimensions.
NurbsCurve	toNurbs(Parameter<Length> tol) Return a transformed NURBS curve representation of this line segment.

Methods inherited from class geomss.geom.LineSegment

extractGrid, getArcLength, getCurvature, getLimitPoint, getNumberOfPoints, getPointAtArcLength, getTorsion, getVariationOfCurvature, gridToTolerance, intersect, intersect, isCircular, isLine, isPlanar, isValid, splitAt, toNurbs, toText

Methods inherited from class geomss.geom.AbstractCurve

getArcLength, getArcLength, getBinormal, getBinormal, getClosest, getClosest, getClosest, getClosest, getClosest, getClosest, getCurvature, getDerivatives, getEnclosedArea, getFarthest, getFarthest, getFarthest, getParDimension, getPoint, getPoint, getPrincipalNormal, getPrincipalNormal, getRealPoint, getSDerivative, getSDerivatives, getTangencyPoint, getTangent, getTangent, getTorsion, getVariationOfCurvature, intersect, intersect, intersect, isDegenerate, splitAt

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

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

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

newInstance

public static LineSegTrans newInstance(LineSegment child,
                                       GTransform transform)

Returns a 3D LineSegTrans instance holding the specified LineSegment and GTransform.

Parameters:

child - The LineSegment 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<LineSegment>

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

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

Parameters:

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

getChild

public LineSegment getChild()

Returns the child object transformed by this transform element.

Specified by:

getChild in interface GeomTransform<LineSegment>

Returns:

The child object transformed by this transform element.

copyToReal

public LineSegment copyToReal()

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

Specified by:

copyToReal in interface Curve<LineSegment>

Specified by:

copyToReal in interface GeomElement<LineSegment>

Specified by:

copyToReal in interface GeomTransform<LineSegment>

Returns:

A copy of the child object transformed by this transformation.

getStart

public GeomPoint getStart()

Return the starting point of the line segment.

Specified by:

getStart in class LineSegment

Returns:

The starting point of the line segment.

getEnd

public GeomPoint getEnd()

Return the end point of the line segment.

Specified by:

getEnd in class LineSegment

Returns:

The end point of the lien segment.

getDerivativeVector

public GeomVector<Length> getDerivativeVector()

Return the dimensional derivative vector for this line segment. The length of this vector is the length of the line segment, the origin is at the start point and the end of the vector is the line end.

Specified by:

getDerivativeVector in class LineSegment

Returns:

The dimensional derivative vector for this line segment.

getUnitVector

public GeomVector<Dimensionless> getUnitVector()

Get unit direction vector for the line segment.

Specified by:

getUnitVector in class LineSegment

Returns:

A unit vector indicating the direction of this line segment.

size

public int size()

Returns the number of child-elements that make up this geometry element. This implementation returns the size in the child curve.

Specified by:

size in interface GeomElement<LineSegment>

Overrides:

size in class LineSegment

Returns:

The number of points in this line segment (always returns 2).

getPhyDimension

public int getPhyDimension()

Returns the number of physical dimensions of the geometry element.

Specified by:

getPhyDimension in interface GeomElement<LineSegment>

Overrides:

getPhyDimension in class LineSegment

Returns:

The number of physical dimensions of this geometry element.

getRealPoint

public Point getRealPoint(double s)

Calculate a point on the curve for the given parametric distance along the curve, p(s).

Specified by:

getRealPoint in interface Curve<LineSegment>

Parameters:

s - parametric distance to calculate a point for (0.0 to 1.0 inclusive).

Returns:

the calculated point

getSDerivatives

public java.util.List<Vector<Length>> getSDerivatives(double s,
                                                      int grade)

Calculate all the derivatives from 0 to grade with respect to parametric distance on the curve for the given parametric distance along the curve, d^{grade}p(s)/d^{grade}s.

Example:
1st derivative (grade = 1), this returns [p(s), dp(s)/ds];
2nd derivative (grade = 2), this returns [p(s), dp(s)/ds, d^2p(s)/d^2s]; etc.

Specified by:

getSDerivatives in interface Curve<LineSegment>

Parameters:

s - Parametric distance to calculate derivatives for (0.0 to 1.0 inclusive).

grade - The maximum grade to calculate the derivatives for (1=1st derivative, 2=2nd derivative, etc)

Returns:

A list of derivatives up to the specified grade of the curve at the specified parametric position.

Throws:

java.lang.IllegalArgumentException - if the grade is < 0.

reverse

public LineSegTrans reverse()

Return a new curve that is identical to this one, but with the parameterization reversed.

Specified by:

reverse in interface Curve<LineSegment>

Returns:

A new curve that is identical to this one, but with the parameterization 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<LineSegment>

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

Returns:

The maximum bounding box coordinate for this geometry element.

Throws:

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

getTransformed

public LineSegTrans 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<LineSegment>

Overrides:

getTransformed in class LineSegment

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 Unit<Length> getUnit()

Returns the unit in which this curve is stated.

Specified by:

getUnit in interface GeomElement<LineSegment>

Overrides:

getUnit in class LineSegment

Returns:

The unit in which this curve is stated.

to

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

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

Specified by:

to in interface Curve<LineSegment>

Specified by:

to in interface GeomElement<LineSegment>

Specified by:

to in interface ParametricGeometry<LineSegment>

Specified by:

to in interface PointGeometry<LineSegment>

Specified by:

to in class LineSegment

Parameters:

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

Returns:

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

Throws:

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

toDimension

public LineSegTrans toDimension(int newDim)

Return the equivalent of this line segment 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 Curve<LineSegment>

Specified by:

toDimension in interface GeomElement<LineSegment>

Specified by:

toDimension in interface ParametricGeometry<LineSegment>

Parameters:

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

Returns:

The equivalent of this line segment converted to the new dimensions.

Throws:

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

toNurbs

public NurbsCurve toNurbs(Parameter<Length> tol)

Return a transformed NURBS curve representation of this line segment. An exact representation is returned and the tolerance parameter is ignored.

Specified by:

toNurbs in interface Curve<LineSegment>

Overrides:

toNurbs in class LineSegment

Parameters:

tol - Ignored. May pass null.

Returns:

A transformed NURBS curve that exactly represents this line segment.

copy

public LineSegTrans copy()

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

Specified by:

copy in interface Curve<LineSegment>

Specified by:

copy in interface GeomElement<LineSegment>

Specified by:

copy in interface ParametricGeometry<LineSegment>

Returns:

an identical and independent copy of this point.

equals

public boolean equals(java.lang.Object obj)

Compares this LineSegTrans against the specified object for strict equality.

Overrides:

equals in class AbstractGeomElement<LineSegment>

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

Returns:

the hash code value.

recycle

public static void recycle(LineSegTrans instance)

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

Parameters:

instance - The instance to recycle immediately.