MiStreamlineExtractBase Class Reference
[Streamline]

Base class for all streamline extractors. More...

#include <MeshVizXLM/extractors/MiStreamlineExtractBase.h>

Inheritance diagram for MiStreamlineExtractBase:

List of all members.

Public Types
enum	IntegrationDirection {   FORWARD,   BACKWARD }
Public Member Functions
virtual	~MiStreamlineExtractBase ()
virtual void	setMaxLifeTime (double maxLifeTime)
virtual void	setMaxLength (double maxLength)
virtual void	setMinSpeed (double minSpeed)
virtual void	setIntegrationStepLengthFactor (double factor)
virtual void	setIntegrationMaxStepNumber (int maxStepNumber)
virtual void	setIntegrationDirection (IntegrationDirection direction)

---

Detailed Description

Base class for all streamline extractors.

The base streamline extract interface defines the commun optional parameters and the direction enum used to integrate streamlines

---

Member Enumeration Documentation

enum MiStreamlineExtractBase::IntegrationDirection

Integration direction.

Enumerator:

FORWARD	Integration is done in the direction of the vectors.
BACKWARD	Integration is done in the opposite direction of the vectors.

---

Constructor & Destructor Documentation

virtual MiStreamlineExtractBase::~MiStreamlineExtractBase

(

)

[inline, virtual]

---

Member Function Documentation

virtual void MiStreamlineExtractBase::setIntegrationDirection

(

IntegrationDirection

direction

)

[inline, virtual]

Sets the direction for the streamlines integration.

This method is not pure virtual so that no definition needed if not used

Parameters:

direction

direction for the streamlines integration. Default: FORWARD.

virtual void MiStreamlineExtractBase::setIntegrationMaxStepNumber

(

int

maxStepNumber

)

[inline, virtual]

Sets the maximum step number during the streamlines integration.

This method is not pure virtual so that no definition needed if not used

Parameters:

maxStepNumber

maximum step number. Default: 0, i.e infinite step number.

virtual void MiStreamlineExtractBase::setIntegrationStepLengthFactor

(

double

factor

)

[inline, virtual]

Sets the step length factor for the streamlines integration.

This method is not pure virtual so that no definition needed if not used

Parameters:

factor

length factor for the streamlines integration. Defaul: 0.3.

virtual void MiStreamlineExtractBase::setMaxLength

(

double

maxLength

)

[inline, virtual]

Sets the maximum length of the streamlines.

This method is not pure virtual so that no definition needed if not used

Parameters:

maxLength

maximum length of the streamlines. Default: 0, i.e infinite length.

virtual void MiStreamlineExtractBase::setMaxLifeTime

(

double

maxLifeTime

)

[inline, virtual]

Sets the maximum life time of the streamlines.

This method is not pure virtual so that no definition is needed if not used

Parameters:

maxLifeTime

maximum life time of the streamlines. Default: 0, i.e infinite life time.

virtual void MiStreamlineExtractBase::setMinSpeed

(

double

minSpeed

)

[inline, virtual]

Sets the minimum speed of the streamlines.

This method is not pure virtual so that no definition needed if not used

Parameters:

minSpeed

minimum speed of the streamlines. Default: 0, i.e no speed constraint.

---

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

• MeshVizXLM/extractors/MiStreamlineExtractBase.h