Spring< T > Class Template Reference

#include <TAPsSpring.hpp>

Collaboration diagram for Spring< T >:

[legend]

List of all members.

Public Member Functions
T	GetConstantK () const
T	GetCurrentLength () const
T	GetDampingD () const
Vector3< T >	GetForce () const
Particle< T > &	GetParticleOne ()
Particle< T > &	GetParticleTwo ()
T	GetRestLengthL () const
	Spring (Particle< T > &P1, Particle< T > &P2, T k, T d)
	Spring (Particle< T > &P1, Particle< T > &P2, T k, T d, T l)
	~Spring ()
Private Member Functions
Spring< T > const &	operator= (Spring< T > const &S)
Private Attributes
Particle< T > &	m_rcP1
Particle< T > &	m_rcP2
T	m_tD
T	m_tK
T	m_tL
Friends
class	Cloth< T >
class	DeformMesh< T >
std::ostream &	operator<< (std::ostream &output, Spring< T > const &S)

---

Detailed Description

template<typename T>
class Spring< T >

Definition at line 22 of file TAPsSpring.hpp.

---

Constructor & Destructor Documentation

template<typename T>

BEGIN_NAMESPACE_TAPs Spring< T >::Spring	(	Particle< T > &	P1,
		Particle< T > &	P2,
		T	k,
		T	d,
		T	l
	)			[inline]

Definition at line 22 of file TAPsSpring.cpp.

    : 
    m_rcP1( P1 ), 
    m_rcP2( P2 ), 
    m_tK( k ), 
    m_tD( d ), 
    m_tL( l )
{}

template<typename T>

Spring< T >::Spring	(	Particle< T > &	P1,
		Particle< T > &	P2,
		T	k,
		T	d
	)			[inline]

Definition at line 37 of file TAPsSpring.cpp.

    : 
    m_rcP1( P1 ), 
    m_rcP2( P2 ), 
    m_tK( k ), 
    m_tD( d )
{
    T x = P2.GetPosition().GetX() - P1.GetPosition().GetX();
    T y = P2.GetPosition().GetY() - P1.GetPosition().GetY();
    T z = P2.GetPosition().GetZ() - P1.GetPosition().GetZ();
    m_tL = sqrt( x*x + y*y + z*z );
}

template<typename T>

Spring< T >::~Spring

(

)

[inline]

Definition at line 55 of file TAPsSpring.cpp.

{}

---

Member Function Documentation

template<typename T>

T Spring< T >::GetConstantK

(

)

const [inline]

Definition at line 97 of file TAPsSpring.cpp.

{   return m_tK;    }

template<typename T>

T Spring< T >::GetCurrentLength

(

)

const [inline]

Definition at line 112 of file TAPsSpring.cpp.

{   return ( m_rcP1.GetPosition() - m_rcP2.GetPosition() ).Length();    }

template<typename T>

T Spring< T >::GetDampingD

(

)

const [inline]

Definition at line 102 of file TAPsSpring.cpp.

{   return m_tD;    }

template<typename T>

Vector3< T > Spring< T >::GetForce

(

)

const [inline]

Definition at line 62 of file TAPsSpring.cpp.

{
    // Local Variables ---------------------------------------------------------
    // spring current length vector
    Vector3<T> cL = ( m_rcP1.GetPosition() - m_rcP2.GetPosition() );
    // spring current length scalar
    T scl = cL.Length();
    // velocity difference of the two particles linked by the spring
    Vector3<T> V = ( m_rcP1.GetVelocity() - m_rcP2.GetVelocity() );

    // F1 = -{Ks(l - r) + Kd[(V1-V2)*L]/l}*L/l
    // F2 = -F1
    //   where Ks = spring stiffness, Kd = spring damping,
    //     V1 and V2 are velocity of particles linked by the spring
    //     r = spring rest length
    //     L = vector of difference of positions of particle#1 and #2
    //     l = magnitude of L
    return -( (m_tK * (scl - m_tL)) +  (m_tD * ((V*cL) / scl)) ) * (cL / scl);
}

template<typename T>

Particle< T > & Spring< T >::GetParticleOne

(

)

[inline]

Definition at line 87 of file TAPsSpring.cpp.

{   return m_rcP1;  }

template<typename T>

Particle< T > & Spring< T >::GetParticleTwo

(

)

[inline]

Definition at line 92 of file TAPsSpring.cpp.

{   return m_rcP2;  }

template<typename T>

T Spring< T >::GetRestLengthL

(

)

const [inline]

Definition at line 107 of file TAPsSpring.cpp.

{   return m_tL;    }

template<typename T>

Spring<T> const& Spring< T >::operator=

(

Spring< T > const &

S

)

[private]

---

Friends And Related Function Documentation

template<typename T>

friend class Cloth< T > [friend]

Definition at line 27 of file TAPsSpring.hpp.

template<typename T>

friend class DeformMesh< T > [friend]

Definition at line 26 of file TAPsSpring.hpp.

template<typename T>

std::ostream& operator<<	(	std::ostream &	output,
		Spring< T > const &	S
	)			[friend]

Definition at line 30 of file TAPsSpring.hpp.

    {
        output  << "Spring<" << typeid(T).name() << "> ==> "
                << "\n  -------START--SPRING--INFO-------"
                << "\n  Particle #1: " << S.m_rcP1
                << "\n  Particle #2: " << S.m_rcP2
                << "\n  K Constant:  " << S.m_tK
                << "\n  D Damping:   " << S.m_tD
                << "\n  L Length:    " << S.m_tL
                << "\n  Current Length: " << S.GetCurrentLength()
                << "\n  Force:       " << S.GetForce()
                << "\n  --------END--SPRING--INFO--------\n";
        return output;
    }

---

Member Data Documentation

template<typename T>

Particle<T>& Spring< T >::m_rcP1 [private]

Definition at line 47 of file TAPsSpring.hpp.

template<typename T>

Particle<T>& Spring< T >::m_rcP2 [private]

Definition at line 48 of file TAPsSpring.hpp.

template<typename T>

T Spring< T >::m_tD [private]

Definition at line 50 of file TAPsSpring.hpp.

template<typename T>

T Spring< T >::m_tK [private]

Definition at line 49 of file TAPsSpring.hpp.

template<typename T>

T Spring< T >::m_tL [private]

Definition at line 51 of file TAPsSpring.hpp.

---

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

• G:/spunak_xp/Works/TAPs/Include/TAPs/Physics/TAPsSpring.hpp
• G:/spunak_xp/Works/TAPs/Include/TAPs/Physics/TAPsSpring.cpp