wt.epm.structure
Class Transform

java.lang.Object
  extended bywt.epm.structure.Transform
All Implemented Interfaces:
Externalizable, NetFactor, ObjectMappable, Serializable

public class Transform
extends Object
implements ObjectMappable, Externalizable

Transform does not support any mathematical operations. Instead, it provides methods to convert back and forth to Matrix4d. Matrix4d is class is in the Java3D vecmath package that supports all kinds of mathematical operations. Interfacing is done through the standard Matrix4d methods such as getRotationScale and get ( forTranslation vector). This implies that any Matrix4d sent or gotten must be constructed in the proper format. The format is row-major, thus the translation vector is stored in the third column of the matrix. The units of the translation vector must be meters.

Use the newTransform static factory method(s), not the Transform constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.



Supported API: true

Extendable: false

See Also:
Serialized Form

Field Summary
private static String CLASSNAME
           
static long EXTERNALIZATION_VERSION_UID
           
protected static long OLD_FORMAT_VERSION_UID
           
private static String RESOURCE
           
private  double[] rotation1
           
private  double[] rotation2
           
private  double[] rotation3
           
(package private) static long serialVersionUID
           
private  double[] translation
           
 
Constructor Summary
Transform()
           
 
Method Summary
private static boolean arraysIsEqual(double[] a, double[] b)
           
 boolean equals(Object another)
           
 ClassInfo getClassInfo()
          Returns the ClassInfo object for this class.
 String getConceptualClassname()
          Deprecated.  
protected  void initialize(javax.vecmath.Matrix4d transform)
          Supports initialization, following construction of an instance.
protected  void initialize(Transform transform)
          Supports initialization, following construction of an instance.
static Transform newTransform(javax.vecmath.Matrix4d transform)
          Given a Java 3D matrix, creates a new Transform.
static Transform newTransform(Transform transform)
          Creates a copy of the given Transform.
 void readExternal(ObjectInput input)
          Reads the non-transient fields of this class from an external source.
 void readExternal(PersistentRetrieveIfc input)
          Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private  boolean readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source, which is not the current version.
protected  boolean readVersion(Transform thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setTransform(javax.vecmath.Matrix4d transform)
          Sets the Transform to the given Java3D matrix.
 javax.vecmath.Matrix4d toMatrix4d()
          Returns a Java 3D matrix for this Transform.
 String toString()
          Returns the conceptual (modeled) name for the class.
 void writeExternal(ObjectOutput output)
          Writes the non-transient fields of this class to an external source.
 void writeExternal(PersistentStoreIfc output)
          Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

rotation1

private double[] rotation1

rotation2

private double[] rotation2

rotation3

private double[] rotation3

translation

private double[] translation

serialVersionUID

static final long serialVersionUID
See Also:
Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID
See Also:
Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID
See Also:
Constant Field Values
Constructor Detail

Transform

public Transform()
Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException
Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:
writeExternal in interface Externalizable
Parameters:
output -
Throws:
IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException
Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:
readExternal in interface Externalizable
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

protected boolean readVersion(Transform thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException
Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:
thisObject -
input -
readSerialVersionUID -
passThrough -
superDone -
Returns:
boolean
Throws:
IOException
ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException
Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:
input -
readSerialVersionUID -
passThrough -
superDone -
Returns:
boolean
Throws:
IOException
ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException
Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:
writeExternal in interface ObjectMappable
Parameters:
output -
Throws:
SQLException
DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException
Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:
readExternal in interface ObjectMappable
Parameters:
input -
Throws:
SQLException
DatastoreException

getConceptualClassname

public String getConceptualClassname()
Deprecated.  

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:
getConceptualClassname in interface NetFactor
Returns:
String

toString

public String toString()
Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:
String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException
Returns the ClassInfo object for this class.

Supported API: false

Specified by:
getClassInfo in interface NetFactor
Returns:
ClassInfo
Throws:
WTIntrospectionException

newTransform

public static Transform newTransform(javax.vecmath.Matrix4d transform)
                              throws WTException
Given a Java 3D matrix, creates a new Transform.

Supported API: true

Parameters:
transform -
Returns:
Transform
Throws:
WTException

initialize

protected void initialize(javax.vecmath.Matrix4d transform)
                   throws WTException
Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:
transform -
Throws:
WTException

newTransform

public static Transform newTransform(Transform transform)
                              throws WTException
Creates a copy of the given Transform.

Supported API: true

Parameters:
transform -
Returns:
Transform
Throws:
WTException

initialize

protected void initialize(Transform transform)
                   throws WTException
Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:
transform -
Throws:
WTException

toMatrix4d

public javax.vecmath.Matrix4d toMatrix4d()
Returns a Java 3D matrix for this Transform.

Supported API: true

Returns:
Matrix4d

setTransform

public void setTransform(javax.vecmath.Matrix4d transform)
Sets the Transform to the given Java3D matrix.

Supported API: true

Parameters:
transform -

arraysIsEqual

private static boolean arraysIsEqual(double[] a,
                                     double[] b)

equals

public boolean equals(Object another)