Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   Related Pages  

rdV3D Class Reference

A graphical body. More...

#include <rdV3D.h>

Inheritance diagram for rdV3D:

rdObject List of all members.

Public Member Functions

 rdV3D ()
 Default constructor.

 rdV3D (const double aVertex[3])
 Construct a vertex with a specified value.

 rdV3D (IDOM_Element *aElement)
 Construct a vertex from an XML Element.

virtual ~rdV3D ()
 Destructor.

void setVertex (const double aVertex[3])
 Set the XYZ coordinates of this vertex.

void getVertex (double rVertex[3]) const
 Get the XYZ coordinates of this vertex.

double getX () const
 Get the X coordinate of this vertex.

double getY () const
 Get the Y coordinate of this vertex.

double getZ () const
 Get the Z coordinate of this vertex.

void translate (double aX, double aY, double aZ)
 Translate a the vertex by a specified amount.

void rotate (int aXYZ, double aRadians)
 Rotate a point about the X, Y, or Z axis by a specified amount.

virtual void updateObject (bool aDeep=true)
 Update this object based on its XML node.

virtual void updateNode (bool aDeep=true)
 Update the XML node representing this object.

void updateData ()
 Update the member data of this object based on its XML node.


Private Member Functions

void setNull ()
 Set NULL values for all member variables.


Private Attributes

double _v3d [3]

Detailed Description

A graphical body.


Constructor & Destructor Documentation

rdV3D::rdV3D  ) 
 

Default constructor.

By default, the value of the vertex is {0.0,0.0,0.0};

rdV3D::rdV3D const double  aVertex[3]  ) 
 

Construct a vertex with a specified value.

Parameters:
aVertex Vertex to which to initialize this vertex.

rdV3D::rdV3D IDOM_Element *  aElement  ) 
 

Construct a vertex from an XML Element.

Parameters:
aElement XML element.


Member Function Documentation

void rdV3D::getVertex double  rVertex[3]  )  const
 

Get the XYZ coordinates of this vertex.

Parameters:
rVertex Array in which the coordinates are returned.

double rdV3D::getX  )  const
 

Get the X coordinate of this vertex.

Returns:
X coordinate.

double rdV3D::getY  )  const
 

Get the Y coordinate of this vertex.

Returns:
Y coordinate.

double rdV3D::getZ  )  const
 

Get the Z coordinate of this vertex.

Returns:
Z coordinate.

void rdV3D::rotate int  aXYZ,
double  aRadians
 

Rotate a point about the X, Y, or Z axis by a specified amount.

Parameters:
aXYZ Specify whether to rotate about the X (aXYZ=0), Y (aXYZ=1), or Z (aXYZ=2) axes. If aXYZ is not 0, 1, or 2, no rotation is performed.
aRadians Amount of rotation in radians.

void rdV3D::setVertex const double  aVertex[3]  ) 
 

Set the XYZ coordinates of this vertex.

Parameters:
aVertex Vertex.

void rdV3D::translate double  aX,
double  aY,
double  aZ
 

Translate a the vertex by a specified amount.

Parameters:
aX Amount to translate in the X direction.
aY Amount to translate in the Y direction.
aZ Amount to translate in the Z direction.

void rdV3D::updateData  ) 
 

Update the member data of this object based on its XML node.

Member objects (children) are not updated.

void rdV3D::updateNode bool  aDeep = true  )  [virtual]
 

Update the XML node representing this object.

Parameters:
aDeep If true, update the XML node of this object AND the XML nodes of all class members that are rdObjects (child nodes); if false, update only the XML node of this object without updating the XML nodes of its children.

Reimplemented from rdObject.

void rdV3D::updateObject bool  aDeep = true  )  [virtual]
 

Update this object based on its XML node.

Parameters:
aDeep If true, update this object and all its child objects (that is, member variables that are rdObject's); if false, update only the member variables that are not rdObject's.

Reimplemented from rdObject.


The documentation for this class was generated from the following files:
Generated on Wed Aug 20 02:17:13 2003 for Simulation Software by doxygen1.3