TAPsSpringVertex.hpp

Go to the documentation of this file.

/******************************************************************************
TAPsSpringVertex.hpp

SpringVertex class is a class for a spring connecting between two ParticleVertex.

SUKITTI PUNAK   (11/08/2004)
UPDATE          (11/08/2004)
******************************************************************************/
#ifndef TAPs_SPRING_VERTEX_HPP
#define TAPs_SPRING_VERTEX_HPP

#include "TAPsParticleVertex.hpp"

BEGIN_NAMESPACE_TAPs
template <typename T>
class SpringVertex {
//=============================================================================
    //-------------------------------------------------------------------------
    // put it through ostream
    friend std::ostream &operator<< ( std::ostream &output, SpringVertex<T> const &S )
    {
        output  << "Spring<" << typeid(T).name() << "> ==> "
                << "\n  -------START--SPRING_VERTEX--INFO-------"
                << "\n  ParticleVertex #1: " << S.m_rcP1
                << "\n  ParticleVertex #2: " << S.m_rcP2
                << "\n  K Constant: " << S.m_tK
                << "\n  D Damping:  " << S.m_tD
                << "\n  L Length:   " << S.m_tL
                << "\n  Force:      " << S.GetForce()
                << "\n  Current Length: " << S.GetCurrentLength()
                << "\n  --------END--SPRING_VERTEX--INFO--------\n";
        return output;
    }
//-----------------------------------------------------------------------------
private:
    // Data Members     ========================================================
    ParticleVertex<T> & m_rcP1; // reference to connected ParticleVertex #1
    ParticleVertex<T> & m_rcP2; // reference to connected ParticleVertex #2
    T                   m_tK;   // tensile spring constant (K)
    T                   m_tD;   // damping factor (D)
    T                   m_tL;   // rest length of spring (L)
    //-------------------------------------------------------------------------
public:
    // Member Functions     ====================================================
    SpringVertex ( 
        ParticleVertex<T> &P1, 
        ParticleVertex<T> &P2, 
        T k, T d, T l );        // constructor
    SpringVertex ( 
        ParticleVertex<T> &P1, 
        ParticleVertex<T> &P2, 
        T k, T d );             // constructor
    ~SpringVertex ();           // destructor
    //-------------------------------------------------------------------------
    // Calculate and Return the (Internal) Force of a Spring
    Vector3<T> GetForce () const;
    //-------------------------------------------------------------------------
    // Get/Set Functions
    // REMARK: No const for Particle<T> & and const after the get fns
    //         so that the return ref can be modified.
    inline ParticleVertex<T> & GetParticleVertexOne ();
    inline ParticleVertex<T> & GetParticleVertexTwo ();
    inline T GetConstantK () const;
    inline T GetDampingD () const;
    inline T GetRestLengthL () const;
    inline T GetCurrentLength () const;
    //-------------------------------------------------------------------------
private:
    // Prohibited Functions ====================================================
    // Since a spring refers to two particles, therefore
    // Copy Constructor and Assignment Operator are prohibited.
    SpringVertex<T> const & operator= ( SpringVertex<T> const &S ); // assignment operator
    //-------------------------------------------------------------------------
}; // END CLASS Spring
//=============================================================================
END_NAMESPACE_TAPs
//-----------------------------------------------------------------------------
// Include definition if TAPs_USE_EXPORT is not defined
//#if !defined( TAPs_USE_EXPORT )
    #include "TAPsSpringVertex.cpp"
//#endif
//-----------------------------------------------------------------------------
#endif
//345678901234567890123456789012345678901234567890123456789012345678901234567890
//--+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8