Frame Class Reference

Class representing a named coordinate transform.

Collaboration diagram for Frame:

List of all members.

Public Types
enum	Axis {   X = (new Vector3d( 1, 0, 0)), Y = (new Vector3d( 0, 1, 0)), Z = (new Vector3d( 0, 0, 1)), NEG_X = (new Vector3d(-1, 0, 0)),   NEG_Y = (new Vector3d( 0, -1, 0)), NEX_Z = (new Vector3d( 0, 0, -1)) }
Public Member Functions
	Frame (String name)
	Create a named Frame with an identity transform.
	Frame (String name, Matrix4d transform)
	Create a named Frame and set to the given transform.
	Frame (Frame toCopy)
	Create a copy of an existing frame.
Frame	set (Frame toCopy)
	Assignment.
void	setName (String name)
	Accessor.
String	getName ()
	Accessor.
void	setTransform (Matrix4d transform)
	copies transform into local Matrix4d store
Matrix4d	getTransform ()
	returns a reference to the Matrix4d owned by this frame
Matrix4d	getTransform (Matrix4d retVal)
	Sets retVal to Frame transform and returns it.
boolean	matches (Frame frame)
	Frames comparison.
Protected Attributes
final Matrix4d	m_xfm = new Matrix4d()
String	m_name = null

---

Member Enumeration Documentation

enum Axis

Enumerator:

X
Y
Z
NEG_X
NEG_Y
NEX_Z

---

Constructor & Destructor Documentation

Frame

(

String

name

)

Parameters:

name	Name of the Frame

Frame	(	String	name,
		Matrix4d	transform
	)

Parameters:

name	Name of the Frame
transform	Initial transform

Frame

(

Frame

toCopy

)

Parameters:

toCopy

Source Frame to copy

Here is the call graph for this function:

---

Member Function Documentation

String getName

(

)

Returns:

Name of the Frame

Matrix4d getTransform

(

)

Matrix4d getTransform

(

Matrix4d

retVal

)

Returns:

retVal

boolean matches

(

Frame

frame

)

Returns:

true if name and transform are equivalent

Here is the call graph for this function:

Frame set

(

Frame

toCopy

)

Parameters:

toCopy

Frame to construct a new Frame from

Returns:

this New Frame, copy of the source Frame

void setName

(

String

name

)

Parameters:

name	New name for the Frame

void setTransform

(

Matrix4d

transform

)

Parameters:

transform

New transform matrix. Note that if transform is null, then the Frame transform is set to the identity matrix, following the behavior of the constructor.

---

Member Data Documentation

String m_name = null [protected]

final Matrix4d m_xfm = new Matrix4d() [protected]

---

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

• Frame.java