SRM.Orientation Class Reference

The Orientation abstract contains a 3x3 matrix and a reference location. More...

List of all members.

Public Member Functions
BaseSRF	getSRF ()
	Returns the SRF this Orientation belongs to.
Coord3D	getRefCoord () throws SrmException
	Returns the reference coordinate values.
double[][]	getMatrix ()
	Returns the 3x3 orientation matrix.
void	getDirectionComp1 (Direction dir) throws SrmException
	Returns the 1st row of the Orientation matrix 3x3 in the form of a Direction object.
void	getDirectionComp2 (Direction dir) throws SrmException
	Returns the 2nd row of the Orientation matrix 3x3 in the form of a Direction object.
void	getDirectionComp3 (Direction dir) throws SrmException
	Returns the 3rd row of the Orientation matrix 3x3 in the form of a Direction object.
void	getDirectionComp (int n, Direction dir) throws SrmException
	Returns the Nth row of the Orientation matrix 3x3 in the form of a Direction object.
void	setDirectionComp (Direction dir1, Direction dir2, Direction dir3) throws SrmException
	Sets rows of the Orientation matrix 3x3 using the vectors from 3 Direction objects.
void	setDirectionComp (int n, Direction dir) throws SrmException
	Sets Nth rows of the Orientation matrix 3x3 using the vector from the Direction object.
void	setMatrix (double[][] mtx) throws SrmException
	Sets the 3x3 orientation matrix.
Orientation	makeClone () throws SrmException
	Returns the shallow copy of this object instance.
void	copyTo (Orientation ori) throws SrmException
	Copies the matrix component values of this orientation to the input orientation.
boolean	isEqual (Orientation ori)
	Returns TRUE if the Orientaqtion parameters are "Equal".
String	toString ()
	Returns the values of the 3x3 matrix as "[ val11, val12, .., val32, val33 ]".
Protected Member Functions
	Orientation (BaseSRF srf, Coord3D ref_coord, double mtx[][])
	Constructor, requires an SRF, 3 reference coordinate values, and 3 direction values.
Coord3D	getInternalRefCoord ()
	Returns the actual reference coordinate object associated with the Direction.

---

Detailed Description

The Orientation abstract contains a 3x3 matrix and a reference location.

Author:

David Shen

See also:

BaseSRF_3D

---

Member Function Documentation

void SRM.Orientation.copyTo (  Orientation  ori  )  throws SrmException

Copies the matrix component values of this orientation to the input orientation. Note: The reference coordinate of this and input orientation must be the same.

void SRM.Orientation.getDirectionComp (  int  n, Direction  dir )  throws SrmException

Returns the Nth row of the Orientation matrix 3x3 in the form of a Direction object. Note: N within [ 1, 2, 3 ] The Direction argument must be associated with the same reference coordinate

void SRM.Orientation.getDirectionComp1 (  Direction  dir  )  throws SrmException

Returns the 1st row of the Orientation matrix 3x3 in the form of a Direction object. Note: The Direction argument must be associated with the same reference coordinate

void SRM.Orientation.getDirectionComp2 (  Direction  dir  )  throws SrmException

Returns the 2nd row of the Orientation matrix 3x3 in the form of a Direction object. Note: The Direction argument must be associated with the same reference coordinate

void SRM.Orientation.getDirectionComp3 (  Direction  dir  )  throws SrmException

Returns the 3rd row of the Orientation matrix 3x3 in the form of a Direction object. Note: The Direction argument must be associated with the same reference coordinate

boolean SRM.Orientation.isEqual (  Orientation  ori  )

Returns TRUE if the Orientaqtion parameters are "Equal". Note: Two variables of type "double" are equal if their difference is within epsilon=0.000001

Orientation SRM.Orientation.makeClone (   )  throws SrmException

Returns the shallow copy of this object instance. Note: The cloned object will reference the same object as the original object.

void SRM.Orientation.setDirectionComp (  int  n, Direction  dir )  throws SrmException

Sets Nth rows of the Orientation matrix 3x3 using the vector from the Direction object. Note: The Direction argument must be associated with the same reference coordinate. N within [ 1, 2, 3 ]

void SRM.Orientation.setDirectionComp (  Direction  dir1, Direction  dir2, Direction  dir3 )  throws SrmException

Sets rows of the Orientation matrix 3x3 using the vectors from 3 Direction objects. Note: The Direction arguments must be associated with the same reference coordinate

---

The documentation for this class was generated from the following file:

• Orientation.java

---

Spatial Reference Model Java API	Version 4.1.4 - July 1, 2011
Copyright © 2011 SEDRIS™	Docs by Doxygen 1.3.2