Position Class Reference

The Base Class Position from which all other position objects inherrit from. More...

#include <position.h>

Inheritance diagram for Position:

List of all members.

Public Member Functions
	Position ()
	The default constructor.
virtual	~Position ()
	the default destructor
virtual void	calculatePosition ()=0
	a virtua; function to calulate the true position of the object
virtual void	updateRelations ()=0
	the virtual function is used to update the positions relations
int	getX ()
	this function returns the x value stored in the object
int	getY ()
	this function returns the y value stored in the object
int	getZ ()
	this function returns the z value stored in the oject
virtual GLfloat	getTrueX ()=0
	a virtual function to calulate and return the true x coordinate value
virtual GLfloat	getTrueY ()=0
	a virtual function to calulate and return the true y coordinate value
virtual GLfloat	getTrueZ ()=0
	a virtual function to calulate and return the true z coordinate value
int	getSizeX ()
	a function to return the geometric size of the object
int	getSizeY ()
	a function to return the geometric size of the object
int	getSizeZ ()
	a function to return the geometric size of the object
virtual int	getTrueSizeX ()=0
virtual int	getTrueSizeY ()=0
virtual int	getTrueSizeZ ()=0
int	getMinSizeX ()
int	getMinSizeY ()
int	getMinSizeZ ()
virtual int	getMinTrueSizeX ()=0
virtual int	getMinTrueSizeY ()=0
virtual int	getMinTrueSizeZ ()=0
int	getMaxSizeX ()
int	getMaxSizeY ()
int	getMaxSizeZ ()
virtual int	getMaxTrueSizeX ()=0
virtual int	getMaxTrueSizeY ()=0
virtual int	getMaxTrueSizeZ ()=0
Protected Attributes
GLfloat	location [3]
	this is the location or coordinates of the object
Position *	parentLoc
	This is a pointer to the parent position object of this position.
Position ***	relatives
	this is meant to be allocated into a 2 dimensional array of position pointers
int *	numRelatives
	this is meant to be allocated into an arrau of integers representing the sizes of the various dimentions of the relatives variable
int	size [3][3]
	This 2 dimentional array is meant to represent the min and max sizes of each dimention / current definition of min and max sucks and needs to be worked on.

---

Detailed Description

The Base Class Position from which all other position objects inherrit from.

This is the Base class for all of ther position objects. This object contains the x, y, and z coordinates of the object that is a part of. It also automatically calculates its position based on it's relation to other position objects

---

Constructor & Destructor Documentation

Position::Position (   )

The default constructor. the default constructor sets most things to 0

Position::~Position (   )  [virtual]

the default destructor the default destructor deletes most allocated things

---

Member Function Documentation

virtual void Position::calculatePosition (   )  [pure virtual]

a virtua; function to calulate the true position of the object this pure virtual function serves are a place holder for a;; child classes version of calulate position Returns: nothing Implemented in PositionDir, PositionDummy, PositionFile, and PositionTrans.

int Position::getMaxSizeX (   )

int Position::getMaxSizeY (   )

int Position::getMaxSizeZ (   )

virtual int Position::getMaxTrueSizeX (   )  [pure virtual]

Implemented in PositionDir, PositionDummy, PositionFile, and PositionTrans.

virtual int Position::getMaxTrueSizeY (   )  [pure virtual]

Implemented in PositionDir, PositionDummy, PositionFile, and PositionTrans.

virtual int Position::getMaxTrueSizeZ (   )  [pure virtual]

Implemented in PositionDir, PositionDummy, PositionFile, and PositionTrans.

int Position::getMinSizeX (   )

int Position::getMinSizeY (   )

int Position::getMinSizeZ (   )

virtual int Position::getMinTrueSizeX (   )  [pure virtual]

Implemented in PositionDir, PositionDummy, PositionFile, and PositionTrans.

virtual int Position::getMinTrueSizeY (   )  [pure virtual]

Implemented in PositionDir, PositionDummy, PositionFile, and PositionTrans.

virtual int Position::getMinTrueSizeZ (   )  [pure virtual]

Implemented in PositionDir, PositionDummy, PositionFile, and PositionTrans.

int Position::getSizeX (   )

a function to return the geometric size of the object this function returns the overall geometric size in the x direction Returns: an integer representing the size

int Position::getSizeY (   )

a function to return the geometric size of the object this function returns the overall geometric size in the y direction Returns: an integer representing the size

int Position::getSizeZ (   )

a function to return the geometric size of the object this function returns the overall geometric size in the z direction Returns: an integer representing the size

virtual int Position::getTrueSizeX (   )  [pure virtual]

Implemented in PositionDir, PositionDummy, PositionFile, and PositionTrans.

virtual int Position::getTrueSizeY (   )  [pure virtual]

Implemented in PositionDir, PositionDummy, PositionFile, and PositionTrans.

virtual int Position::getTrueSizeZ (   )  [pure virtual]

Implemented in PositionDir, PositionDummy, PositionFile, and PositionTrans.

virtual GLfloat Position::getTrueX (   )  [pure virtual]

a virtual function to calulate and return the true x coordinate value this virtual function allows for each decendant of the position class the ability to calulate their x coordinate in their own way Returns: a GLfloat value being the true x coordinate Implemented in PositionDir, PositionDummy, PositionFile, and PositionTrans.

virtual GLfloat Position::getTrueY (   )  [pure virtual]

a virtual function to calulate and return the true y coordinate value this virtual function allows for each decendant of the position class the ability to calulate their y coordinate in their own way Returns: a GLfloat value being the true y coordinate Implemented in PositionDir, PositionDummy, PositionFile, and PositionTrans.

virtual GLfloat Position::getTrueZ (   )  [pure virtual]

a virtual function to calulate and return the true z coordinate value this virtual function allows for each decendant of the position class the ability to calulate their z coordinate in their own way Returns: a GLfloat value being the true z coordinate Implemented in PositionDir, PositionDummy, PositionFile, and PositionTrans.

int Position::getX (   )

this function returns the x value stored in the object this function will return the actual value of the x coordinate / position value contained in the object Returns: the stored x value

int Position::getY (   )

this function returns the y value stored in the object this function will return the actual value of the y coordinate / position value contained in the object Returns: the stored y value

int Position::getZ (   )

this function returns the z value stored in the oject this function will return the actual value of the z coordinate / position value contained in the object Returns: the stored x value

virtual void Position::updateRelations (   )  [pure virtual]

the virtual function is used to update the positions relations This pure virtual function serves as a place holder for chold class versions for updating relations Returns: nothing Implemented in PositionDir, PositionDummy, PositionFile, and PositionTrans.

---

Member Data Documentation

GLfloat Position::location[3] [protected]

this is the location or coordinates of the object

int* Position::numRelatives [protected]

this is meant to be allocated into an arrau of integers representing the sizes of the various dimentions of the relatives variable

Position* Position::parentLoc [protected]

This is a pointer to the parent position object of this position. Reimplemented in PositionDir, and PositionFile.

Position*** Position::relatives [protected]

this is meant to be allocated into a 2 dimensional array of position pointers

int Position::size[3][3] [protected]

This 2 dimentional array is meant to represent the min and max sizes of each dimention / current definition of min and max sucks and needs to be worked on.

---

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

• position.h
• position.cpp

---