Base class for all streamline extractors. More...
#include <MeshVizXLM/extractors/MiStreamlineExtractBase.h>
Public Types | |
enum | IntegrationDirection { FORWARD , BACKWARD } |
Integration direction. More... | |
Public Member Functions | |
virtual | ~MiStreamlineExtractBase () |
virtual void | setMaxLifeTime (double maxLifeTime) |
Sets the maximum life time of the streamlines. | |
virtual void | setMaxLength (double maxLength) |
Sets the maximum length of the streamlines. | |
virtual void | setMinSpeed (double minSpeed) |
Sets the minimum speed of the streamlines. | |
virtual void | setIntegrationStepLengthFactor (double factor) |
Sets the step length factor for the streamlines integration. | |
virtual void | setIntegrationMaxStepNumber (int maxStepNumber) |
Sets the maximum step number during the streamlines integration. | |
virtual void | setIntegrationDirection (IntegrationDirection direction) |
Sets the direction for the streamlines integration. | |
Public Member Functions inherited from MiBaseExtractor | |
virtual | ~MiBaseExtractor () |
virtual void | setExtractorCallback (MiExtractorCallback *extractorCallback)=0 |
Set the user defined extractor callback which will be called before each extraction, during each extraction and after each extraction. | |
virtual SoDEPRECATED void | setExtractorCallback (MiExtractorCallback &extractorCallback) |
Base class for all streamline extractors.
The base streamline extract interface defines the commun optional parameters and the direction enum used to integrate streamlines
Definition at line 41 of file MiStreamlineExtractBase.h.
Integration direction.
Enumerator | |
---|---|
FORWARD | Integration is done in the direction of the vectors. |
BACKWARD | Integration is done in the opposite direction of the vectors. |
Definition at line 86 of file MiStreamlineExtractBase.h.
|
inlinevirtual |
Definition at line 45 of file MiStreamlineExtractBase.h.
|
inlinevirtual |
Sets the direction for the streamlines integration.
This method is not pure virtual so that no definition needed if not used
direction | direction for the streamlines integration. Default: FORWARD. |
Definition at line 97 of file MiStreamlineExtractBase.h.
|
inlinevirtual |
Sets the maximum step number during the streamlines integration.
This method is not pure virtual so that no definition needed if not used
maxStepNumber | maximum step number. Default: 0, i.e infinite step number. |
Definition at line 81 of file MiStreamlineExtractBase.h.
|
inlinevirtual |
Sets the step length factor for the streamlines integration.
This method is not pure virtual so that no definition needed if not used
factor | length factor for the streamlines integration. Defaul: 0.3. |
Definition at line 74 of file MiStreamlineExtractBase.h.
|
inlinevirtual |
Sets the maximum length of the streamlines.
This method is not pure virtual so that no definition needed if not used
maxLength | maximum length of the streamlines. Default: 0, i.e infinite length. |
Definition at line 60 of file MiStreamlineExtractBase.h.
|
inlinevirtual |
Sets the maximum life time of the streamlines.
This method is not pure virtual so that no definition is needed if not used
maxLifeTime | maximum life time of the streamlines. Default: 0, i.e infinite life time. |
Definition at line 53 of file MiStreamlineExtractBase.h.
|
inlinevirtual |
Sets the minimum speed of the streamlines.
This method is not pure virtual so that no definition needed if not used
minSpeed | minimum speed of the streamlines. Default: 0, i.e no speed constraint. |
Definition at line 67 of file MiStreamlineExtractBase.h.