AnimaL

Tutorial

Documentation

---

Documentation

• Overview
• Modules
• Namespace List
• Class Hierarchy
• Alphabetical List
• Compound List
• File List
• Namespace Members
• Compound Members
• File Members
• Examples

---

animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint Class Reference

#include <massSpringEngine.h>

Inheritance diagram for animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint:

List of all members.

---

Detailed Description

template<typename Inv_Masses, typename Velocities, typename SpringStiffness, typename IndexedSprings, typename Points, typename Real = float>
class animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint

Models a selected point among a vector of points, using a pointer to the engine and the index of the point.

A selected point is not allowed to move except using method moveTo(float,float,float).

Definition at line 82 of file massSpringEngine.h.

Public Member Functions
	ConstrainedPoint (MassSpringEngine *mse, int index)
	Construct given a point.
virtual void	getPoint (float &x, float &y, float &z) const
	Get point position to x,y,z.
virtual void	moveTo (float x, float y, float z) const
	Set point position to x,y,z.
virtual	~ConstrainedPoint ()
	Destructor.
virtual void	print () const
	print an item
virtual bool	operator== (const ConstrainedItem *) const
	Comparison operator. True iff both Items point to the same element.
Protected Attributes
MassSpringEngine *	_mse
int	_index
float	invmass

---

Constructor & Destructor Documentation

template<class Inv_Masses, class Velocities, class SpringStiffness, class IndexedSprings, class Points, class Real> animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::ConstrainedPoint (  MassSpringEngine *  mse, int  index )

Construct given a point. Definition at line 245 of file massSpringEngine.inl.

template<class Inv_Masses, class Velocities, class SpringStiffness, class IndexedSprings, class Points, class Real> animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::~ConstrainedPoint (   )  [virtual]

Destructor. Definition at line 309 of file massSpringEngine.inl. References animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::_index, animal::PhysicalSolver< t_Positions, t_Vector, t_InvMasses, t_Real >::_invMasses, animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::_mse, and animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::invmass.

---

Member Function Documentation

template<class Inv_Masses, class Velocities, class SpringStiffness, class IndexedSprings, class Points, class Real> void animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::getPoint (  float &  x, float &  y, float &  z )  const [virtual]

Get point position to x,y,z. Reimplemented from animal::ConstrainedItem. Definition at line 261 of file massSpringEngine.inl. References animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::_index, animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::_mse, and animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::_points.

template<class Inv_Masses, class Velocities, class SpringStiffness, class IndexedSprings, class Points, class Real> void animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::moveTo (  float  x, float  y, float  z )  const [virtual]

Set point position to x,y,z. Definition at line 276 of file massSpringEngine.inl. References animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::_index, animal::PhysicalSolver< t_Positions, t_Vector, t_InvMasses, t_Real >::_invMasses, animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::_mse, animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::_points, and animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::_velocities.

template<class Inv_Masses, class Velocities, class SpringStiffness, class IndexedSprings, class Points, class Real> bool animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::operator== (  const ConstrainedItem *   )  const [virtual]

Comparison operator. True iff both Items point to the same element. Implements animal::ConstrainedItem. Definition at line 322 of file massSpringEngine.inl. References animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::_index, and animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::_mse.

template<class Inv_Masses, class Velocities, class SpringStiffness, class IndexedSprings, class Points, class Real> void animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::print (   )  const [virtual]

print an item Reimplemented from animal::ConstrainedItem. Definition at line 296 of file massSpringEngine.inl.

---

Member Data Documentation

template<typename Inv_Masses, typename Velocities, typename SpringStiffness, typename IndexedSprings, typename Points, typename Real = float> int animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::_index [protected]

Definition at line 105 of file massSpringEngine.h. Referenced by animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::getPoint(), animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::moveTo(), animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::operator==(), and animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::~ConstrainedPoint().

template<typename Inv_Masses, typename Velocities, typename SpringStiffness, typename IndexedSprings, typename Points, typename Real = float> MassSpringEngine* animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::_mse [protected]

Definition at line 104 of file massSpringEngine.h. Referenced by animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::getPoint(), animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::moveTo(), animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::operator==(), and animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::~ConstrainedPoint().

template<typename Inv_Masses, typename Velocities, typename SpringStiffness, typename IndexedSprings, typename Points, typename Real = float> float animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::invmass [protected]

Definition at line 106 of file massSpringEngine.h. Referenced by animal::MassSpringEngine< Inv_Masses, Velocities, SpringStiffness, IndexedSprings, Points, Real >::ConstrainedPoint::~ConstrainedPoint().

---

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

• massSpringEngine.h
• massSpringEngine.inl

---