Open Inventor Release 2023.2.2
 
Loading...
Searching...
No Matches
MoMeshStreamline Class Reference

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

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

+ Inheritance diagram for MoMeshStreamline:

Public Types

enum  IntegrationDirection {
  FORWARD ,
  BACKWARD
}
 Integration direction. More...
 

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 MoMeshStreamline ()
 Constructor.
 
const MiStreamlineExtractUnstructuredgetUnstructuredExtractor ()
 Get extractor for reuse outside this node.
 
const MiStreamlineExtractHexahedronIjkgetHexahedronIjkExtractor ()
 
const MiStreamlineExtractIjkgetIjkExtractor ()
 
- Public Member Functions inherited from MoMeshRepresentation
virtual void setExtractorCallback (MiExtractorCallback *extractorCallback)
 Set the extraction callback which will be called each time an extraction is performed.
 
virtual SoDEPRECATED void setExtractorCallback (MiExtractorCallback &extractorCallback)
 
- Public Member Functions inherited from MoMeshBaseRepresentation
virtual SbBool affectsState () const
 Returns TRUE if a node has an effect on the state during traversal.
 
- Public Member Functions inherited from SoNode
virtual void setOverride (const SbBool state)
 Turns the override flag on or off.
 
virtual SbBool isOverride () const
 Returns the state of the override flag.
 
virtual SoNodecopy (SbBool copyConnections=FALSE) const
 Creates and returns an exact copy of the node.
 
virtual void touch ()
 Marks an instance as modified, simulating a change to it.
 
- Public Member Functions inherited from SoFieldContainer
void setToDefaults ()
 Sets all fields in this object to their default values.
 
SbBool hasDefaultValues () const
 Returns TRUE if all of the object's fields have their default values.
 
SbBool fieldsAreEqual (const SoFieldContainer *fc) const
 Returns TRUE if this object's fields are exactly equal to fc's fields.
 
void copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
 Copies the contents of fc's fields into this object's fields.
 
SoNONUNICODE SbBool set (const char *fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
SbBool set (const SbString &fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
void get (SbString &fieldDataString)
 Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
 
virtual int getFields (SoFieldList &list) const
 Appends references to all of this object's fields to resultList, and returns the number of fields appended.
 
virtual int getAllFields (SoFieldList &list) const
 Returns a list of fields, including the eventIn's and eventOut's.
 
virtual SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (const SbName &fieldName) const
 Returns the eventOut with the given name.
 
SbBool getFieldName (const SoField *field, SbName &fieldName) const
 Returns the name of the given field in the fieldName argument.
 
SbBool enableNotify (SbBool flag)
 Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
 
SbBool isNotifyEnabled () const
 Notification is the process of telling interested objects that this object has changed.
 
virtual void setUserData (void *data)
 Sets application data.
 
void * getUserData (void) const
 Gets user application data.
 
- Public Member Functions inherited from SoBase
virtual SbName getName () const
 Returns the name of an instance.
 
virtual void setName (const SbName &name)
 Sets the name of an instance.
 
void setSynchronizable (const bool b)
 Sets this to be a ScaleViz synchronizable object.
 
bool isSynchronizable () const
 Gets the ScaleViz synchronizable state of this object.
 
- Public Member Functions inherited from SoRefCounter
void ref () const
 Adds a reference to an instance.
 
void unref () const
 Removes a reference from an instance.
 
void unrefNoDelete () const
 unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
 
int getRefCount () const
 Returns current reference count.
 
void lock () const
 lock this instance.
 
void unlock () const
 unlock this instance.
 
- Public Member Functions inherited from SoTypedObject
SbBool isOfType (const SoType &type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type.
 
template<typename TypedObjectClass >
SbBool isOfType () const
 Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
 

Static Public Member Functions

static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from MoMeshRepresentation
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from MoMeshBaseRepresentation
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from MoActionNode
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoNode
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static SoNodegetByName (const SbName &name)
 A node's name can be set using SoBase::setName().
 
static int getByName (const SbName &name, SoNodeList &list)
 A node's name can be set using SoBase::setName().
 
- Static Public Member Functions inherited from SoFieldContainer
static SoType getClassTypeId ()
 Returns the type of this class.
 
- Static Public Member Functions inherited from SoBase
static SoType getClassTypeId ()
 Returns type identifier for this class.
 
- Static Public Member Functions inherited from SoTypedObject
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 

Public Attributes

SoSFInt32 vec3SetId
 Field representing the vector set node to be used to compute the streamlines.
 
SoMFVec3f startingPoints
 Starting points for the streamline computation.
 
SoSFDouble maxLifeTime
 Sets the maximum life time of the streamline.
 
SoSFDouble maxLength
 Sets the maximum length of the streamline.
 
SoSFDouble minSpeed
 Sets the minimum speed of the streamline.
 
SoSFDouble integrationStepLengthFactor
 Sets the step length factor for the streamline integration.
 
SoSFInt32 maxStepNumber
 Sets the maximum step number during the streamline integration.
 
SoSFEnum direction
 Sets the direction for the streamline integration.
 
- Public Attributes inherited from MoMeshRepresentation
SoSFInt32 colorScalarSetId
 Field representing the scalar set node to be used to map colors onto the representation.
 
SoSFBool parallel
 If TRUE, the node tries to launch the extraction in parallel if this is supported by the associated extractor.
 

Deprecated

template<typename _MdExtractorT >
class MdMeshMultiLinesRepresentation
 
SoDEPRECATED const MiStreamlineExtractHexahedronIjkgetUnstructuredIjkExtractor ()
 

Detailed Description

MeshViz 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, MiStreamlineExtractHexahedronIjk, MiPointProbeIjk, MiPointProbeUnstructured, MiPointProbeHexahedronIjk, MoLineDetail

Definition at line 96 of file MoMeshStreamline.h.

Member Enumeration Documentation

◆ 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.

Definition at line 153 of file MoMeshStreamline.h.

Constructor & Destructor Documentation

◆ MoMeshStreamline()

MoMeshStreamline::MoMeshStreamline ( )

Constructor.

Member Function Documentation

◆ getClassTypeId()

static SoType MoMeshStreamline::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getHexahedronIjkExtractor()

const MiStreamlineExtractHexahedronIjk * MoMeshStreamline::getHexahedronIjkExtractor ( )

◆ getIjkExtractor()

const MiStreamlineExtractIjk * MoMeshStreamline::getIjkExtractor ( )

◆ getTypeId()

virtual SoType MoMeshStreamline::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from MoMeshRepresentation.

◆ getUnstructuredExtractor()

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.

◆ getUnstructuredIjkExtractor()

SoDEPRECATED const MiStreamlineExtractHexahedronIjk * MoMeshStreamline::getUnstructuredIjkExtractor ( )

Friends And Related Symbol Documentation

◆ MdMeshMultiLinesRepresentation

template<typename _MdExtractorT >
friend class MdMeshMultiLinesRepresentation
friend

Definition at line 190 of file MoMeshStreamline.h.

Member Data Documentation

◆ direction

SoSFEnum MoMeshStreamline::direction

Sets the direction for the streamline integration.


Use enum IntegrationDirection. Default is FORWARD.

Definition at line 162 of file MoMeshStreamline.h.

◆ integrationStepLengthFactor

SoSFDouble MoMeshStreamline::integrationStepLengthFactor

Sets the step length factor for the streamline integration.


Default is 0.3.

Definition at line 142 of file MoMeshStreamline.h.

◆ maxLength

SoSFDouble MoMeshStreamline::maxLength

Sets the maximum length of the streamline.


Default is 0, meaning infinite length.

Definition at line 130 of file MoMeshStreamline.h.

◆ maxLifeTime

SoSFDouble MoMeshStreamline::maxLifeTime

Sets the maximum life time of the streamline.


Default is 0, meaning infinite life time.

Definition at line 124 of file MoMeshStreamline.h.

◆ maxStepNumber

SoSFInt32 MoMeshStreamline::maxStepNumber

Sets the maximum step number during the streamline integration.


Default is 0, meaning infinite step number.

Definition at line 148 of file MoMeshStreamline.h.

◆ minSpeed

SoSFDouble MoMeshStreamline::minSpeed

Sets the minimum speed of the streamline.


Default is 0, meaning no speed constraint.

Definition at line 136 of file MoMeshStreamline.h.

◆ startingPoints

SoMFVec3f MoMeshStreamline::startingPoints

Starting points for the streamline computation.


Default is empty.

Definition at line 118 of file MoMeshStreamline.h.

◆ vec3SetId

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.

Definition at line 113 of file MoMeshStreamline.h.


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