Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
om::physics::constraints::ConstraintType Class Reference

A class that represents the type of a Constraint object. More...

#include <omPhysicsConstraintType.h>

Public Member Functions

 ConstraintType (const Type &newType)
 Create a ConstraintType object with the specified internal type. More...
 
 ConstraintType (const Char *string)
 Create a ConstraintType object with the specified string type. More...
 
 ConstraintType (const UTF8String &newTypeString)
 Create a ConstraintType object with the specified string type. More...
 
Bool operator== (const ConstraintType &other) const
 Return whether or not this shape type is equal to another. More...
 
Bool operator!= (const ConstraintType &other) const
 Return whether or not this shape type is not equal to another. More...
 
ConstraintTypeID getID () const
 Return an integer identifying this shape type. More...
 
Hash getHashCode () const
 Return a hash code for this shape type. More...
 
 operator const UTF8String & () const
 Get a string representing the implementation-defined name of this type. More...
 
const UTF8String & toString () const
 Get a string representing the implementation-defined name of this type. More...
 
const UTF8String & getName () const
 Get a string representing the implementation-defined name of this type. More...
 
template<>
const ConstraintTypeof ()
 Specialize the constraint type template for this type. More...
 
template<>
const ConstraintTypeof ()
 Specialize the constraint type template for this type. More...
 

Static Public Member Functions

template<typename T >
static const ConstraintTypeof ()
 Return a ConstraintType object for the specified type template parameter. More...
 

Public Attributes

Hash hashCode
 A hash code for this shape type. More...
 
UTF8String type
 A string object representing the internal type for this ConstraintType. More...
 

Detailed Description

A class that represents the type of a Constraint object.

Constructor & Destructor Documentation

om::physics::constraints::ConstraintType::ConstraintType ( const Type newType)
inline

Create a ConstraintType object with the specified internal type.

om::physics::constraints::ConstraintType::ConstraintType ( const Char string)
inline

Create a ConstraintType object with the specified string type.

om::physics::constraints::ConstraintType::ConstraintType ( const UTF8String &  newTypeString)
inline

Create a ConstraintType object with the specified string type.

Member Function Documentation

template<typename T >
static const ConstraintType& om::physics::constraints::ConstraintType::of ( )
inlinestatic

Return a ConstraintType object for the specified type template parameter.

Bool om::physics::constraints::ConstraintType::operator== ( const ConstraintType other) const
inline

Return whether or not this shape type is equal to another.

Bool om::physics::constraints::ConstraintType::operator!= ( const ConstraintType other) const
inline

Return whether or not this shape type is not equal to another.

ConstraintTypeID om::physics::constraints::ConstraintType::getID ( ) const
inline

Return an integer identifying this shape type.

This ID is a 32-bit integer that is generated by hashing the string generated for a type template parameter. While the posibility of ID collisions is very low, duplicates are nonetheless a possibility.

Hash om::physics::constraints::ConstraintType::getHashCode ( ) const
inline

Return a hash code for this shape type.

om::physics::constraints::ConstraintType::operator const UTF8String & ( ) const
inline

Get a string representing the implementation-defined name of this type.

const UTF8String& om::physics::constraints::ConstraintType::toString ( ) const
inline

Get a string representing the implementation-defined name of this type.

const UTF8String& om::physics::constraints::ConstraintType::getName ( ) const
inline

Get a string representing the implementation-defined name of this type.

template<>
const ConstraintType& om::physics::constraints::ConstraintType::of ( )
inline

Specialize the constraint type template for this type.

template<>
const ConstraintType& om::physics::constraints::ConstraintType::of ( )
inline

Specialize the constraint type template for this type.

Member Data Documentation

Hash om::physics::constraints::ConstraintType::hashCode

A hash code for this shape type.

UTF8String om::physics::constraints::ConstraintType::type

A string object representing the internal type for this ConstraintType.


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