HEVertexPtrWithExtraInfo< T > Class Template Reference

#include <TAPsHEVertexPtrWithExtraInfo.hpp>

List of all members.

Public Member Functions
HEVertex< T > *	GetHEVertexPtr ()
HEVertex< T > const *	GetHEVertexPtr () const
	Assignment operator.
ParticleRef< T > &	GetHomeParticle ()
ParticleRef< T > const &	GetHomeParticle () const
	Get vertex ring list.
Vector3< T > &	GetHomePosition ()
Vector3< T > const &	GetHomePosition () const
	Get home position.
std::vector< int > &	GetListConnectedVertices ()
std::vector< int > const &	GetListConnectedVertices () const
	Get vertex ring list.
std::vector< int > &	GetListVertexFirstRing ()
std::vector< int > const &	GetListVertexFirstRing () const
	Get vertex ring list.
ParticleRef< T > *	GetParticleRef ()
ParticleRef< T > const *	GetParticleRef () const
	Get vertex ring list.
	HEVertexPtrWithExtraInfo (HEVertex< T > *heVertexPtr, ParticleRef< T > *particlePtr)
	Constructor.
void	SetHomePosition (Vector3< T > const &pos)
	Set home position.
virtual std::string	StrInfo () const
	Return this object info as a string.
	~HEVertexPtrWithExtraInfo ()
	Copy constructor.
Protected Attributes
ParticleRef< T >	m_HomeParticle
	home particle which links to home position
HEVertex< T > *	m_pHEVertex
	Pointer to HEVertex.
ParticleRef< T > *	m_pParticleRef
	Pointers to Particle.
Vector3< T >	m_vHomePos
	home (original) position
std::vector< int >	m_viListConnectedVertices
	List of connected vertices by, e.g., a spring.
std::vector< int >	m_viListVertexFirstRing
	First-ring neighbor vertices on mesh.
Private Member Functions
HEVertexPtrWithExtraInfo< T > const &	operator= (HEVertexPtrWithExtraInfo< T > const &S)
Friends
std::ostream &	operator<< (std::ostream &output, HEVertexPtrWithExtraInfo< T > const &obj)
	Output Operator <<.

---

Detailed Description

template<typename T>
class HEVertexPtrWithExtraInfo< T >

Definition at line 17 of file TAPsHEVertexPtrWithExtraInfo.hpp.

---

Constructor & Destructor Documentation

template<typename T>

BEGIN_NAMESPACE_TAPs HEVertexPtrWithExtraInfo< T >::HEVertexPtrWithExtraInfo	(	HEVertex< T > *	heVertexPtr,
		ParticleRef< T > *	particlePtr
	)			[inline]

Constructor.

Definition at line 20 of file TAPsHEVertexPtrWithExtraInfo.cpp.

    :   m_pHEVertex( heVertexPtr ),
        m_pParticleRef( particlePtr ),
        m_vHomePos( particlePtr->GetPosition() ),
        m_HomeParticle( m_vHomePos, true )
{}

template<typename T>

HEVertexPtrWithExtraInfo< T >::~HEVertexPtrWithExtraInfo

(

)

[inline]

Copy constructor.

Destructor.

Destructor

Definition at line 31 of file TAPsHEVertexPtrWithExtraInfo.cpp.

{}

---

Member Function Documentation

template<typename T>

HEVertex<T>* HEVertexPtrWithExtraInfo< T >::GetHEVertexPtr

(

)

[inline]

Definition at line 50 of file TAPsHEVertexPtrWithExtraInfo.hpp.

{ return m_pHEVertex; }

template<typename T>

HEVertex<T> const* HEVertexPtrWithExtraInfo< T >::GetHEVertexPtr

(

)

const [inline]

Assignment operator.

Get half-edge vertex pointer

Definition at line 49 of file TAPsHEVertexPtrWithExtraInfo.hpp.

{ return m_pHEVertex; }

template<typename T>

ParticleRef<T>& HEVertexPtrWithExtraInfo< T >::GetHomeParticle

(

)

[inline]

Definition at line 70 of file TAPsHEVertexPtrWithExtraInfo.hpp.

{ return m_HomeParticle; }

template<typename T>

ParticleRef<T> const& HEVertexPtrWithExtraInfo< T >::GetHomeParticle

(

)

const [inline]

Get vertex ring list.

Definition at line 69 of file TAPsHEVertexPtrWithExtraInfo.hpp.

{ return m_HomeParticle; }

template<typename T>

Vector3<T>& HEVertexPtrWithExtraInfo< T >::GetHomePosition

(

)

[inline]

Definition at line 74 of file TAPsHEVertexPtrWithExtraInfo.hpp.

{ return m_vHomePos; }

template<typename T>

Vector3<T> const& HEVertexPtrWithExtraInfo< T >::GetHomePosition

(

)

const [inline]

Get home position.

Definition at line 73 of file TAPsHEVertexPtrWithExtraInfo.hpp.

{ return m_vHomePos; }

template<typename T>

std::vector<int>& HEVertexPtrWithExtraInfo< T >::GetListConnectedVertices

(

)

[inline]

Definition at line 58 of file TAPsHEVertexPtrWithExtraInfo.hpp.

{ return m_viListConnectedVertices; }

template<typename T>

std::vector<int> const& HEVertexPtrWithExtraInfo< T >::GetListConnectedVertices

(

)

const [inline]

Get vertex ring list.

Definition at line 57 of file TAPsHEVertexPtrWithExtraInfo.hpp.

{ return m_viListConnectedVertices; }

template<typename T>

std::vector<int>& HEVertexPtrWithExtraInfo< T >::GetListVertexFirstRing

(

)

[inline]

Definition at line 54 of file TAPsHEVertexPtrWithExtraInfo.hpp.

{ return m_viListVertexFirstRing; }

template<typename T>

std::vector<int> const& HEVertexPtrWithExtraInfo< T >::GetListVertexFirstRing

(

)

const [inline]

Get vertex ring list.

Definition at line 53 of file TAPsHEVertexPtrWithExtraInfo.hpp.

{ return m_viListVertexFirstRing; }

template<typename T>

ParticleRef<T>* HEVertexPtrWithExtraInfo< T >::GetParticleRef

(

)

[inline]

Definition at line 66 of file TAPsHEVertexPtrWithExtraInfo.hpp.

{ return m_pParticleRef; }

template<typename T>

ParticleRef<T> const* HEVertexPtrWithExtraInfo< T >::GetParticleRef

(

)

const [inline]

Get vertex ring list.

Get vertex ring list

Definition at line 65 of file TAPsHEVertexPtrWithExtraInfo.hpp.

{ return m_pParticleRef; }

template<typename T>

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

(

HEVertexPtrWithExtraInfo< T > const &

S

)

[inline, private]

Definition at line 105 of file TAPsHEVertexPtrWithExtraInfo.hpp.

    {
        std::cerr << "HEVertexPtrWithExtraInfo<T> operator= must not be used!\n";
        exit( 1 );
    }

template<typename T>

void HEVertexPtrWithExtraInfo< T >::SetHomePosition

(

Vector3< T > const &

pos

)

[inline]

Set home position.

Definition at line 76 of file TAPsHEVertexPtrWithExtraInfo.hpp.

{ m_vHomePos = pos; }

template<typename T>

std::string HEVertexPtrWithExtraInfo< T >::StrInfo

(

)

const [inline, virtual]

Return this object info as a string.

Definition at line 37 of file TAPsHEVertexPtrWithExtraInfo.cpp.

{
    std::ostringstream ss;
    ss << "HEVertexPtrWithExtraInfo<" << typeid(T).name() << ">:";
    ss << "\n\tHome Position:   " << m_vHomePos;
    ss << "\n\tHomeParticle:    " << m_HomeParticle;
    ss << "\n\tPtr to HEVertex: " << m_pHEVertex;
    ss << "\n\t1st ring vertex list:";
    for ( int i = 0; i < static_cast<int>(m_viListVertexFirstRing.size()); ++i ) {
        ss << "  " << m_viListVertexFirstRing[i];
    }
    ss << "\n\tList of connected vertices:";
    for ( int i = 0; i < static_cast<int>(m_viListConnectedVertices.size()); ++i ) {
        ss << "  " << m_viListConnectedVertices[i];
    }
    ss << "\n\tPtr to Particle: " << m_pParticleRef;
    ss << "\n-------\n";

    return ss.str();
}

---

Friends And Related Function Documentation

template<typename T>

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

Output Operator <<.

Definition at line 21 of file TAPsHEVertexPtrWithExtraInfo.hpp.

    {
        output << obj.StrInfo();
        return output;
    }

---

Member Data Documentation

template<typename T>

ParticleRef<T> HEVertexPtrWithExtraInfo< T >::m_HomeParticle [protected]

home particle which links to home position

Definition at line 90 of file TAPsHEVertexPtrWithExtraInfo.hpp.

template<typename T>

HEVertex<T>* HEVertexPtrWithExtraInfo< T >::m_pHEVertex [protected]

Pointer to HEVertex.

Definition at line 92 of file TAPsHEVertexPtrWithExtraInfo.hpp.

template<typename T>

ParticleRef<T>* HEVertexPtrWithExtraInfo< T >::m_pParticleRef [protected]

Pointers to Particle.

Definition at line 96 of file TAPsHEVertexPtrWithExtraInfo.hpp.

template<typename T>

Vector3<T> HEVertexPtrWithExtraInfo< T >::m_vHomePos [protected]

home (original) position

Definition at line 89 of file TAPsHEVertexPtrWithExtraInfo.hpp.

template<typename T>

std::vector<int> HEVertexPtrWithExtraInfo< T >::m_viListConnectedVertices [protected]

List of connected vertices by, e.g., a spring.

Definition at line 94 of file TAPsHEVertexPtrWithExtraInfo.hpp.

template<typename T>

std::vector<int> HEVertexPtrWithExtraInfo< T >::m_viListVertexFirstRing [protected]

First-ring neighbor vertices on mesh.

Definition at line 93 of file TAPsHEVertexPtrWithExtraInfo.hpp.

---

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

• G:/spunak_xp/Works/TAPs/Include/TAPs/OpenGLModel/Support/TAPsHEVertexPtrWithExtraInfo.hpp
• G:/spunak_xp/Works/TAPs/Include/TAPs/OpenGLModel/Support/TAPsHEVertexPtrWithExtraInfo.cpp