StreamGrid Class Reference

List of all members.

Public Member Functions
	StreamGrid (int x, int y, int sep, float test, float step, FlowGeometry geo, FlowChannel *chanX, FlowChannel *chanY, bool rk)
	Constructor.
	~StreamGrid ()
	Destructor.
void	calculateGrid (void)
	Calculates all streamlines.
std::vector< Streamline * >	getAllStreamlines (void)
	Fetches all streamlines saved in the grid.
void	addStreamline (const vec3 &seed)
	Add a streamline to the queue.
void	addStreamline (Streamline *line)
	Add a streamline to the queue.
bool	getStreamline (Streamline *line)
	Get next streamline in queue.
void	addSample (const vec3 &point)
	Adds a point to cell.
vec3	getVelocity (const vec3 &point)
	returns the velocity of a given point
void	clear (void)
	Clears the grid.
void	setDSep (int sep)
	Sets the separation distance and other things.
void	setDTest (float test)
	Sets the new test distance.
void	setStepSize (float step)
	Sets the new step size.
int	getDSep (void)
float	getDTest (void)
float	getStepSize (void)
void	setUseRungeKutta (bool rk)
bool	useRungeKutta (void)
int	getDimX (void)
int	getDimY (void)
FlowChannel *	getChannelX (void)
FlowChannel *	getChannelY (void)
int	getMaxX (void)
int	getMaxY (void)
bool	checkDistanceForStop (const vec3 &point)
	Checks distance for stopping line integration.
bool	checkDistanceForSeed (const vec3 &point)
	Checks distance for new seeds.
Friends
class	Streamline

---

Constructor & Destructor Documentation

StreamGrid::StreamGrid	(	int	x,
		int	y,
		int	sep,
		float	test,
		float	step,
		FlowGeometry	geo,
		FlowChannel *	chanX,
		FlowChannel *	chanY,
		bool	rk
	)

Constructor.

Parameters:

x	x dimension of grid
y	y dimension of grid
dSep	separator distance
rk	uses Runge-Kutta integration

---

Member Function Documentation

void StreamGrid::addSample

(

const vec3 &

point

)

Adds a point to cell.

Parameters:

point

point to add to cell

void StreamGrid::addStreamline

(

Streamline *

line

)

Add a streamline to the queue.

Parameters:

line	The streamline to add

void StreamGrid::addStreamline

(

const vec3 &

seed

)

Add a streamline to the queue.

Parameters:

seed	The seed for a new streamline

bool StreamGrid::checkDistanceForSeed

(

const vec3 &

point

)

Checks distance for new seeds.

Parameters:

point

point to check distance for

Returns:

true if valid, false if not

bool StreamGrid::checkDistanceForStop

(

const vec3 &

point

)

Checks distance for stopping line integration.

Parameters:

point

point to check distance for

Returns:

true if valid, false if not

std::vector< Streamline * > StreamGrid::getAllStreamlines

(

void

)

Fetches all streamlines saved in the grid.

Returns:

List of streamlines

bool StreamGrid::getStreamline

(

Streamline *

line

)

Get next streamline in queue.

Parameters:

line	streamline to get

Returns:

true if there is one, false if not

vec3 StreamGrid::getVelocity

(

const vec3 &

point

)

returns the velocity of a given point

Parameters:

point

point to get velocity at

Returns:

velocity velocity for point

void StreamGrid::setDSep

(

int

sep

)

Sets the separation distance and other things.

Parameters:

sep	new separation distance

void StreamGrid::setDTest

(

float

test

)

Sets the new test distance.

Parameters:

test	new test distance

void StreamGrid::setStepSize

(

float

step

)

Sets the new step size.

Parameters:

step	new step size

---

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

• src/renderer/streamgrid.h
• src/renderer/streamgrid.cpp