TAPsPointMass.hpp

Go to the documentation of this file.

/******************************************************************************
TAPsPointMass.hpp

PointMass class is a class for a static point mass reside in 3D.

SUKITTI PUNAK   (09/16/2010)
UPDATE          (10/08/2010)
******************************************************************************/
#ifndef TAPs_POINT_MASS_HPP
#define TAPs_POINT_MASS_HPP

#include "../Core/TAPsCGMath.hpp"
#include "../DataStructure/TAPsSimulationFlags.hpp"

BEGIN_NAMESPACE_TAPs
//=============================================================================
// Forward Class Declarations
//=============================================================================
template <typename T>
class PointMass {
//=============================================================================
//-----------------------------------------------------------------------------
// Friend Function
friend std::ostream & operator<< ( std::ostream &output, PointMass<T> const &P )
{
    return output << P.StrInfo();
}
//-----------------------------------------------------------------------------

//=============================================================================
public:
    // Member Functions -------------------------------------------------------

    enum Type {
        TYPE_STATIC,                    
        TYPE_DYNAMIC,                   
        TYPE_DYNAMIC_WITH_ORIENTATION,  
    };

    PointMass ( bool bRandomValue = false );

    PointMass ( 
        T                   mass,
        T                   radius          = 1,
        Vector3<T> const &  vPosition       = ZeroVector,
        DS::SimulationFlags const & flags   = DS::SimulationFlags()
    );

    PointMass ( Vector3<T> const & location );

    PointMass ( T const location[3] );

    PointMass ( T locX, T locY, T locZ );

    PointMass ( PointMass<T> const & P );

    ~PointMass ();

    virtual std::string StrInfo () const;

    inline virtual void DefaultValues ();

    inline virtual void RandomValues ();

    //-------------------------------------------------------------------------
    // Assignment Operator
    PointMass<T> const & operator= ( PointMass<T> const & P );

    //-------------------------------------------------------------------------
    // Get/Set Functions

    // Type ---------------------------------------------------------
    Type GetType () const   { return m_Type; }

    // Physics Properties -------------------------------------------
    inline T const & GetMass () const;
    inline T &  GetMass ();
    inline void SetMass ( T t );
    inline T const & GetSize () const;
    inline T &  GetSize ();
    inline void SetSize ( T t );
    inline Vector3<T> const & GetPosition () const;
    inline Vector3<T> & GetPosition ();
    inline void         SetPosition ( Vector3<T> const & v3 );
    inline void         SetPosition ( T x, T y, T z );

    //---------------------------------------------------------------
    // Functions for non-members (which should be overided by subclasses)
    //---------------------------------------------------------------
    inline virtual Vector3<T> const & GetVelocity () const  { return CGMath<T>::TempVector3; PrtWarningWithFileNameAndLineNumber( "No Op or No Effect Function is called"); }
    inline virtual Vector3<T> & GetVelocity ()  { return CGMath<T>::TempVector3; PrtWarningWithFileNameAndLineNumber( "No Op or No Effect Function is called"); }
    inline virtual void SetVelocity ( Vector3<T> const & v3 ) {}
    inline virtual void SetVelocity ( T x, T y, T z ) {}

    inline virtual Vector3<T> const & GetAcceleration () const  { return CGMath<T>::TempVector3; PrtWarningWithFileNameAndLineNumber( "No Op or No Effect Function is called"); }
    inline virtual Vector3<T> & GetAcceleration ()  { return CGMath<T>::TempVector3; PrtWarningWithFileNameAndLineNumber( "No Op or No Effect Function is called"); }
    inline virtual void SetAcceleration ( Vector3<T> const & v3 ) {}
    inline virtual void SetAcceleration ( T x, T y, T z ) {}

    inline virtual Vector3<T> const & GetForce () const { return CGMath<T>::TempVector3; PrtWarningWithFileNameAndLineNumber( "No Op or No Effect Function is called"); }
    inline virtual Vector3<T> & GetForce () { return CGMath<T>::TempVector3; PrtWarningWithFileNameAndLineNumber( "No Op or No Effect Function is called"); }
    inline virtual void SetForce ( Vector3<T> const & v3 ) {}
    inline virtual void SetForce ( T x, T y, T z ) {}
    //---------------------------------------------------------------

    // Constraints --------------------------------------------------
    
    // Get simulation flags
    inline DS::SimulationFlags const &  GetFlags () const;
    // Get simulation flags
    inline DS::SimulationFlags &        GetFlags ();

    //-------------------------------------------------------------------------

    //-------------------------------------------------------------------------
    // Data Members -----------------------------------------------------------
//=============================================================================
protected:
    // Member Functions -------------------------------------------------------
    // Data Members -----------------------------------------------------------
    // Physics Properties -------------------------------------------
    T           m_tMass;            
    T           m_tSize;            
    Vector3<T>  m_v3Position;       
    // Constraints --------------------------------------------------
    DS::SimulationFlags m_SimFlags;     
    // Type ---------------------------------------------------------
    Type        m_Type;             
//=============================================================================
private:
    // Member Functions -------------------------------------------------------
    // Data Members -----------------------------------------------------------
//=============================================================================
#if defined(__gl_h_) || defined(__GL_H__)
public:
    virtual void Draw () const;
    virtual void Draw ( T scale ) const;
#endif
//=============================================================================
}; // END CLASS PointMass
//=============================================================================
END_NAMESPACE_TAPs
//-----------------------------------------------------------------------------
#include "TAPsPointMass.cpp"
//-----------------------------------------------------------------------------
#endif
//34567890123456789012345678901234567890123456789012345678901234567890123456789
//--+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----