MoMeshStreamline Class Reference
[Representations]

Rendering node that displays streamlines of a vector field on a volume mesh. More...

#include <MeshVizXLM/mapping/nodes/MoMeshStreamline.h>

Inheritance diagram for MoMeshStreamline:

List of all members.

Public Types
enum	IntegrationDirection {   FORWARD,   BACKWARD }
Public Member Functions
virtual SoType	getTypeId () const
	MoMeshStreamline ()
Static Public Member Functions
static SoType	getClassTypeId ()
Public Attributes
SoSFInt32	vec3SetId
SoMFVec3f	startingPoints
SoSFDouble	maxLifeTime
SoSFDouble	maxLength
SoSFDouble	minSpeed
SoSFDouble	integrationStepLengthFactor
SoSFInt32	maxStepNumber
SoSFEnum	direction
const MiStreamlineExtractUnstructured *	getUnstructuredExtractor ()
const MiStreamlineExtractUnstructuredIjk *	getUnstructuredIjkExtractor ()
const MiStreamlineExtractIjk *	getIjkExtractor ()

---

Detailed Description

Rendering node that displays streamlines of a vector field on a volume mesh.

Displays a list of MiLineMeshCurvilinear meshes containing streamlines starting from a list of source points and probes the input mesh to compute the values at the streamline nodes (See the SEE ALSO Section for settings).
A streamline is a line that is everywhere tangent to a vector field. The vector field is specified by the vec3SetId field. This is an index into the list of vector sets existing in the traversal state (see the MoVec3Setxxx nodes).

Note: Streamlines are meaningless for unsteady flow, because time is not taken into account during the computation of the lines. Streamlines are integrated from a given set of vectors using a Runge/Kutta method of order 2 .

The lines can be colored using a scalar set defined in the colorScalarSetId inherited field. This is an index into the list of scalar sets existing in the traversal state (see the MoScalarSetxxx nodes). To disable coloring set this field to -1.

FILE FORMAT/DEFAULT

MeshStreamline {

colorScalarSetId	0
parallel	TRUE
vec3SetId	0
startingPoints	0,0,0
maxLifeTime	0
maxLength	0
minSpeed	0
integrationStepLengthFactor	0.3
maxStepNumber	0
direction	FORWARD

}

SEE ALSO

MiStreamlineExtractIjk, MiStreamlineExtractUnstructured, MiStreamlineExtractUnstructuredIjk, MiPointProbeIjk, MiPointProbeUnstructured, MiPointProbeUnstructuredIjk, MoLineDetail

See related examples:

Turbine

---

Member Enumeration Documentation

enum MoMeshStreamline::IntegrationDirection

Integration direction.

Enumerator:

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

---

Constructor & Destructor Documentation

MoMeshStreamline::MoMeshStreamline

(

)

Constructor.

---

Member Function Documentation

static SoType MoMeshStreamline::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from MoMeshRepresentation.

const MiStreamlineExtractIjk* MoMeshStreamline::getIjkExtractor

(

)

Get extractor for reuse outside this node.

Note:

The returned pointer may be null if a mesh has not been set in the scene graph or if no render action has been called before. Use the method corresponding to the type of mesh stored in the scene graph.

virtual SoType MoMeshStreamline::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from MoMeshRepresentation.

const MiStreamlineExtractUnstructured* MoMeshStreamline::getUnstructuredExtractor

(

)

Get extractor for reuse outside this node.

Note:

The returned pointer may be null if a mesh has not been set in the scene graph or if no render action has been called before. Use the method corresponding to the type of mesh stored in the scene graph.

const MiStreamlineExtractUnstructuredIjk* MoMeshStreamline::getUnstructuredIjkExtractor

(

)

Get extractor for reuse outside this node.

Note:

The returned pointer may be null if a mesh has not been set in the scene graph or if no render action has been called before. Use the method corresponding to the type of mesh stored in the scene graph.

---

Member Data Documentation

SoSFEnum MoMeshStreamline::direction

Sets the direction for the streamline integration.

Use enum IntegrationDirection. Default is FORWARD.

SoSFDouble MoMeshStreamline::integrationStepLengthFactor

Sets the step length factor for the streamline integration.

Default is 0.3.

SoSFDouble MoMeshStreamline::maxLength

Sets the maximum length of the streamline.

Default is 0, meaning infinite length.

SoSFDouble MoMeshStreamline::maxLifeTime

Sets the maximum life time of the streamline.

Default is 0, meaning infinite life time.

SoSFInt32 MoMeshStreamline::maxStepNumber

Sets the maximum step number during the streamline integration.

Default is 0, meaning infinite step number.

SoSFDouble MoMeshStreamline::minSpeed

Sets the minimum speed of the streamline.

Default is 0, meaning no speed constraint.

SoMFVec3f MoMeshStreamline::startingPoints

Starting points for the streamline computation.

Default is empty.

SoSFInt32 MoMeshStreamline::vec3SetId

Field representing the vector set node to be used to compute the streamlines.

During traversal of the scene graph, vector set nodes are accumulated in a list of vector sets. vec3Set is an index in this list. Default is 0 meaning to use the first set in the list.

Note:

This vector set must be defined per node to be valid.

---

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

• MeshVizXLM/mapping/nodes/MoMeshStreamline.h