Streamline Class Reference

#include <Streamline.h>

List of all members.

Public Member Functions

 Streamline (void)
 ~Streamline (void)
void addSamplePoint (SamplePoint *p)
void sort ()
int getId ()
int getSize ()
SamplePoint getAt (int index)
SamplePoint operator[] (int index)
bool hasNext ()
SamplePoint getNext ()
void reset ()
void calculateVectors ()
SamplePointIter getIter ()
SamplePointIter begin ()
SamplePointIter end ()

Private Member Functions

int compare (const void *a, const void *b)

Private Attributes

int m_Id
list< SamplePoint * > m_samplePoints
list< SamplePoint * >::iterator m_pointsIter


Detailed Description

This class is a container for the storage of streamlines.
A streamline consists of several sample points and an Id.


Constructor & Destructor Documentation

Streamline::Streamline ( void   ) 

constructor

Streamline::~Streamline ( void   ) 

destructor


Member Function Documentation

void Streamline::addSamplePoint ( SamplePoint p  ) 

Function to add a new SamplePoint to the Streamline.

Parameters:
p new SamplePoint

void Streamline::sort (  ) 

Function to sort a streamline depending on its renderId.

int Streamline::getId (  ) 

Function that returns the ID of the streamline.

Returns:
Id of the stramline

int Streamline::getSize (  ) 

Function that returns the size of a streamline.

Returns:
the size (amount of sample points)

SamplePoint Streamline::getAt ( int  index  ) 

Function that returns a SamplePoint on a specific position on the streamline.

Parameters:
index number of the sample point

SamplePoint Streamline::operator[] ( int  index  ) 

Function that returns a SamplePoint on a specific position on the streamline.

Parameters:
index number of the sample point

bool Streamline::hasNext (  ) 

Returns true if there is any other SamplePoint after the current one.

Returns:
true if there is another SamplePoint

SamplePoint Streamline::getNext (  ) 

Returns the next SamplePoint in the Streamline.

Returns:
the next SamplePoint

void Streamline::reset (  ) 

Function to reset the iterator through the streamline.

void Streamline::calculateVectors (  ) 

Function to calculate the tangent, normal, tapering coeff, etc of one sample point.

SamplePointIter Streamline::getIter (  ) 

Returns the iterator for the list of SamplePoints in one streamline.

Returns:
the iterator through the streamline

SamplePointIter Streamline::begin (  ) 

Returns the first SamplePoint in the Streamline.

Returns:
first SamplePoint

SamplePointIter Streamline::end (  ) 

This function points after the last SamplePoint of the Streamline.

Returns:
one after the last samplepoint

int Streamline::compare ( const void *  a,
const void *  b 
) [private]

Function to compare one SamplePoint with another one.

Parameters:
*a the first SamplePoint
*b the second SamplePoint


Member Data Documentation

int Streamline::m_Id [private]

list<SamplePoint*> Streamline::m_samplePoints [private]

the id of the streamline

list<SamplePoint*>::iterator Streamline::m_pointsIter [private]

the list of SamplePoints of the streamline


The documentation for this class was generated from the following file:
Generated on Wed Jan 17 03:48:40 2007 for Flowvis-parma_wallaby by  doxygen 1.5.1-p1