PhysicsObjectID Class Reference

#include <PhysicsObjectID.h>

List of all members.

Public Member Functions
	PhysicsObjectID ()
	PhysicsObjectID (unsigned int classTypeID, unsigned int classInstanceID)
unsigned int	getTypeID ()
unsigned int	getInstanceID ()
PhysicsObjectID &	operator= (PhysicsObjectID id)
bool	operator== (PhysicsObjectID &id)
bool	operator< (PhysicsObjectID &id)
bool	operator> (PhysicsObjectID &id)
Protected Attributes
unsigned int	typeID
	identifier for the class type
unsigned int	instanceID
	class instance number of the object

---

Detailed Description

Identifier class used to identify PhysicsObjects in the Physics module. The PhysicsObjectID is an Identifier composed of an id for the type of the object and the instance of the object. The type will be used as an identifier for the class of which the object is an instance of. The instance part will be a unique class instance number which has to be managed by the user so that this id is really unique inside the class.

---

Constructor & Destructor Documentation

PhysicsObjectID::PhysicsObjectID

(

)

Empty Constructor. Is needed to allow uninitialized variables.

PhysicsObjectID::PhysicsObjectID	(	unsigned int	classTypeID,
		unsigned int	classInstanceID
	)

Constructor sets Identifier. The constructor has to be called with an identifier for the type of the PhysicsObject and the instance of the Object.

Parameters:

	typeID	identifier for the class type
	instanceID	unique class instance number

---

Member Function Documentation

unsigned int PhysicsObjectID::getInstanceID

(

)

Getter for the instance ID.

Returns:

instance of the PhysicsObject inside the class

unsigned int PhysicsObjectID::getTypeID

(

)

Getter for the class type identifier.

Returns:

class type of the PhysicsObject

bool PhysicsObjectID::operator<

(

PhysicsObjectID &

id

)

Less than operator. Returns if the current PhysicsObjectID is less than the passed PhysicsObjectID.

Parameters:

id

PhysicsObjectID to compare with

Returns:

true if the current PhysicsObjectID is lower, false otherwise

PhysicsObjectID & PhysicsObjectID::operator=

(

PhysicsObjectID

id

)

Assignment operator. Assigns the current PhysicsObjectID the values of the passed PhysicsObjectID.

Parameters:

id

PhysicsObjectID which should be used as template

Returns:

reference to the current PhysicsObjectID

bool PhysicsObjectID::operator==

(

PhysicsObjectID &

id

)

Equal to operator. Returns if the current PhysicsObjectID is equal to the passed PhysicsObjectID.

Parameters:

id

PhysicsObjectID to compare with

Returns:

true if the two PhysicsObjectIDs are the same, false otherwise

bool PhysicsObjectID::operator>

(

PhysicsObjectID &

id

)

Greater than operator. Returns if the curren PhysicsObjectID is greater than the passed PhysicsObjectID.

Parameters:

id

PhysicsObjectID to compare with

Returns:

true if the current PhysicsObjectID is higher, false otherwise

---

Member Data Documentation

unsigned int PhysicsObjectID::instanceID [protected]

class instance number of the object

unsigned int PhysicsObjectID::typeID [protected]

identifier for the class type

---

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

• src/inVRs/Modules/3DPhysics/PhysicsObjectID.h
• src/inVRs/Modules/3DPhysics/PhysicsObjectID.cpp