StreamLineContainer Class Reference

#import <StreamLineContainer.h>

List of all members.

Public Member Functions
(id)	- initWithDimX:dimY:dsep:maxSteps:dist:
(BOOL)	- checkDistanceFromPoint:distance:nearest:
(void)	- addSamplePoint:
(void)	- addStreamLine:
(void)	- clear
(int)	- getDSep
(float)	- getDTest
(void)	- changeDTestTo:
(void)	- changeDSepTo:
(StreamLine *)	- getNextStreamLine
(vector< StreamLine * >)	- getAllStreamLines
(int)	- getMaxSteps
(float)	- getDist
Protected Attributes
int	dSep
float	distance
float	dTest
int	maxSteps
float	maxDistanceCheck
int	cellsX
int	cellsY
int	dimX
int	dimY
vector< vector< vec3 > * >	cells
vector< StreamLine * >	streamLines

---

Member Function Documentation

- (void) addSamplePoint:

(vec3)

point

Adds a sample point

Parameters:

point

The point to add

- (void) addStreamLine:

(StreamLine *)

streamLine

Adds a stream lines to the grid

Parameters:

streamLine

The stream line to add

- (void) changeDSepTo:

(int)

_dSep

Changes the dSep value

Parameters:

_dSep

The dSep value

- (void) changeDTestTo:

(float)

_dTest

Changes the dTest value

Parameters:

_dTest

The dTest value

- (BOOL) checkDistanceFromPoint:		(vec3)	pos
distance:		(float)	_distance
nearest:		(float &)	nearest

Checks the distance from a given point

Parameters:

pos	The point to check
_distance	The distance to check
nearest	Stores the nearest value

Returns:

YES if successful

- (void) clear

Clears the container

- (vector< StreamLine * >) getAllStreamLines

Returns all stream lines

Returns:

All stream lines

- (float) getDist

Returns the distance value

Returns:

The distance value

- (int) getDSep

Returns the dSep value

Returns:

The dSep value

- (float) getDTest

Returns the dTest value

Returns:

The dTest value

- (int) getMaxSteps

Returns the maxSteps value

Returns:

The maxSteps value

- (StreamLine *) getNextStreamLine

Returns the next stream line to render

Parameters:

The	next stream line

- (id) initWithDimX:		(int)	_dimX
dimY:		(int)	_dimY
dsep:		(int)	_dSep
maxSteps:		(int)	_maxSteps
dist:		(float)	_dist

Initializes the container

Parameters:

_dimX	The x dimension of the flow data
_dimY	The y dimension of the flow data
_dSep	The dSep parameter evenly space the stream lines
_maxSteps	The maximum steps for the iteration of the stram lines
_dist	The distance between two stream lines

Returns:

The pointer of the object

---

Member Data Documentation

- (vector<vector<vec3>*>) cells [protected]

- (int) cellsX [protected]

- (int) cellsY [protected]

- (int) dimX [protected]

- (int) dimY [protected]

- (float) distance [protected]

- (int) dSep [protected]

- (float) dTest [protected]

- (float) maxDistanceCheck [protected]

- (int) maxSteps [protected]

- (vector<StreamLine*>) streamLines [protected]

---

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

• StreamLineContainer.h
• StreamLineContainer.mm