|
Open Inventor Release 2023.2.3
|
|
| |
|
Open Inventor Release 2023.2.3
|
|
|
| |
Base class of all streamline representations on a mesh.
More...
#include <MeshViz/3Ddata/PoBaseStreamLine.h>
Inheritance diagram for PoBaseStreamLine:Public Types | |
| enum | IntegrationDirection { FORWARD , BACKWARD } |
| Type of integration direction. More... | |
| Public Types inherited from PoMesh | |
| enum | ColoringType { COLOR_INHERITED , COLOR_AVERAGE , COLOR_MAPPING , COLOR_CONTOURING , COLOR_TEXTURE_CONTOURING } |
| Coloring type. More... | |
| Public Types inherited from PoBase | |
| enum | UpdateMethodType { UPDATE_METHOD_IMMEDIATE , UPDATE_METHOD_ON_ACTION } |
| Type of update method. More... | |
| enum | NodeWriteFormat { FOLD_NODE_WRITE_FORMAT , UNFOLD_NODE_WRITE_FORMAT } |
| Type of write format. More... | |
| enum | TextType { SO_TEXT3 , SO_ANNO_TEXT3 } |
| Type of Text. More... | |
| typedef void | PoRebuildCB(void *userData, PoBase *base) |
Public Member Functions | |
| virtual SoType | getTypeId () const |
| Returns the type identifier for this specific instance. | |
| virtual const SoNodekitCatalog * | getNodekitCatalog () const |
| Returns the SoNodekitCatalog for this instance. | |
| PoBaseStreamLine () | |
| Constructor. | |
| Public Member Functions inherited from PoMesh | |
| void | setMesh (PbMesh *mesh) |
| Sets a reference to a PbMesh object. | |
| void | setDataMapping (PbDataMapping *data_mapping) |
| Sets a reference to a PbDataMapping object for the association color-value. | |
| void | setModuleDataMapping (PbDataMapping *mod_data_mapping) |
| Sets a reference to a PbDataMapping object for the association color-vectors module. | |
| void | setIsovaluesList (PbIsovaluesList *isovalues_list) |
| Sets a reference to a PbIsovaluesList object to define a list of isovalues. | |
| const PbMesh * | getMesh () const |
| Gets the current PbMesh object. | |
| const PbDataMapping * | getDataMapping () const |
| Returns the current PbDataMapping object. | |
| const PbDataMapping * | getModuleDataMapping () const |
| Returns the current PbDataMapping object for the association color-vectors module. | |
| const PbIsovaluesList * | getIsovaluesList () const |
| Returns the current PbIsovaluesList object. | |
| Public Member Functions inherited from PoBase | |
| void | setUpdateMethod (UpdateMethodType type) |
| Sets scene graph update method. | |
| UpdateMethodType | getUpdateMethod () const |
| Gets update method. | |
| void | setDomain (PbDomain *dom) |
| Sets a reference to a PbDomain object used to define the data limits of the graphics to be generated. | |
| const PbDomain * | getDomain () const |
| Gets a reference to a PbDomain object used to define the data limits of the graphics to be generated. | |
| void | touchKit () |
| Indicates the node kit is modified. | |
| SbBool | isModified () const |
| Return TRUE, if the kit has been modified, else otherwise. | |
| SbBool | isBuilt () const |
| Indicates if the node kit has been built at least once. | |
| virtual void | rebuild () |
| Forces the node kit to be rebuilt immediately. | |
| void | addPreRebuildCallback (PoRebuildCB *cb, void *data) |
| Add a callback function to call when the node kit is rebuilt. | |
| void | addPostRebuildCallback (PoRebuildCB *cb, void *data) |
| Add a callback function to call when the node kit is rebuilt. | |
| void | removePreRebuildCallback (PoRebuildCB *cb, void *data=NULL) |
| Remove a callback function to call when the node kit is rebuilt. | |
| void | removePostRebuildCallback (PoRebuildCB *cb, void *data) |
| Remove a callback function to call when the node kit is rebuilt. | |
| virtual SoNode * | copy (SbBool copyConnections=FALSE) const |
| Copy method. | |
| virtual SbBool | affectsState () const |
| See SoNode::affectsState() for explanations. | |
| Public Member Functions inherited from SoBaseKit | |
| SoBaseKit () | |
| Constructor. | |
| virtual SoNode * | getPart (const SbName &partName, SbBool makeIfNeeded) |
| Searches the nodekit catalog (and those of all nested nodekits) for the part named partName. | |
| template<typename PartType > | |
| PartType * | getPart (const SbName &partName) |
| Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to TRUE. | |
| template<typename PartType > | |
| PartType * | checkPart (const SbName &partName) |
| Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to FALSE. | |
| SbString | getPartString (const SoBase *part) |
| Given a node or a path to a node, checks if the part exists in the nodekit, in a nested nodekit, or an element of a list part. | |
| virtual SoNodeKitPath * | createPathToPart (const SbName &partName, SbBool makeIfNeeded, const SoPath *pathToExtend=NULL) |
| Returns a path that begins at this nodekit and ends at partName. | |
| virtual SbBool | setPart (const SbName &partName, SoNode *newPart) |
| Inserts the given node (not a copy) as the new part specified by partName. | |
| SoNONUNICODE SbBool | set (char *nameValuePairListString) |
| This function allows field values of parts (nodes) to be set in several different parts simultaneously. | |
| SbBool | set (const SbString &nameValuePairListString) |
| This function allows field values of parts (nodes) to be set in several different parts simultaneously. | |
| SoNONUNICODE SbBool | set (const char *partNameString, const char *parameterString) |
| This function allows field values of parts (nodes) to be set. | |
| SbBool | set (const SbString &partNameString, const SbString ¶meterString) |
| This function allows field values of parts (nodes) to be set. | |
| 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 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 SoField * | getField (const SbName &fieldName) const |
| Returns a the field of this object whose name is fieldName. | |
| virtual SoField * | getEventIn (const SbName &fieldName) const |
| Returns a the eventIn with the given name. | |
| virtual SoField * | getEventOut (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. | |
| Public Member Functions inherited from SoGetView | |
| SoGetView () | |
| Default constructor. | |
| virtual | ~SoGetView () |
| virtual SbBool | getViewportIsEnabled () const |
| Returns TRUE if SoGetView functionalities are enabled, FALSE otherwise. | |
| virtual const SbVec2f | getViewportOrigin () const |
| Returns SbViewportRegion origin. | |
| virtual const SbVec2f | getViewportSize () const |
| Returns SbViewportRegion size. | |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
| Returns the type identifier for this class. | |
| static const SoNodekitCatalog * | getClassNodekitCatalog () |
| Returns the SoNodekitCatalog for this class. | |
| Static Public Member Functions inherited from PoMesh | |
| static SoType | getClassTypeId () |
| Returns the type identifier for this class. | |
| static const SoNodekitCatalog * | getClassNodekitCatalog () |
| Returns the SoNodekitCatalog for this class. | |
| Static Public Member Functions inherited from Po3DdataMaster | |
| static SoType | getClassTypeId () |
| Returns the type identifier for this class. | |
| static const SoNodekitCatalog * | getClassNodekitCatalog () |
| Returns the SoNodekitCatalog for this class. | |
| Static Public Member Functions inherited from PoBase | |
| static SoType | getClassTypeId () |
| Returns the type identifier for this class. | |
| static const SoNodekitCatalog * | getClassNodekitCatalog () |
| Returns the SoNodekitCatalog for this class. | |
| static void | setNodeWriteFormat (NodeWriteFormat format) |
| Sets the node write format. | |
| static NodeWriteFormat | getNodeWriteFormat () |
| Gets the node write format. | |
| static void | setTextType (TextType type) |
| Sets the type of text used. | |
| static TextType | getTextType () |
| Gets the type of text used. | |
| static void | setVRML2Mode (SbBool flag) |
| Set the VRML2 mode. | |
| static SbBool | isVRML2Mode () |
| Gets the VRML2 mode (TRUE = VRML2 mode, FALSE Inventor mode) | |
| Static Public Member Functions inherited from SoBaseKit | |
| static SoType | getClassTypeId () |
| Returns the type identifier for this class. | |
| static const SoNodekitCatalog * | getClassNodekitCatalog () |
| Returns the SoNodekitCatalog for the class SoBaseKit. | |
| static void | setSearchingChildren (SbBool newVal) |
| Sets if nodekit children are searched during SoSearchAction traversal. | |
| static SbBool | isSearchingChildren () |
| Returns TRUE if nodekit children are searched during SoSearchAction traversal. | |
| Static Public Member Functions inherited from SoNode | |
| static SoType | getClassTypeId () |
| Returns the type identifier for this class. | |
| static SoNode * | getByName (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 | |
| SoMFVec3f | startPoints |
| Start points of the streamlines. | |
| SoMFColor | colors |
| List of colors used by some derived class to color each streamline. | |
| SoSFFloat | maxLifetime |
| The difference between the time of the start-point and the time of the last point of a streamline must be less than maxLifetime. | |
| SoSFFloat | maxLength |
| The curvilinear distance between the start-point and the last point of a streamline must be less than maxLength. | |
| SoSFFloat | minSpeed |
| The streamline ends when it goes through a point where the velocity is less than minSpeed. | |
| SoSFFloat | integrationStepLengthFactor |
| It is a factor of the size of a cell. | |
| SoSFInt32 | integrationMaxStepNumber |
| Computing the streamline is done while the number of integration step is less than integrationMaxStepNumber. | |
| SoSFEnum | integrationDirection |
| Direction of integration. | |
| Public Attributes inherited from PoMesh | |
| SoSFInt32 | valuesIndex |
| Defines the index of the set of values for the coloring. | |
| SoSFInt32 | valuesIndexForCellFilter |
| Specifies the index of the set of values used to filter cells for this mesh representation. | |
| SoSFInt32 | vecsIndex |
| Defines the index of the set of vectors for all representations which need a vector at each mesh node (PoBaseStreamLine, PoMesh2DVec, PoMesh3DVec,...) | |
| SoSFEnum | coloringType |
| Defines the type of method used to color each mesh element, mesh edge or mesh contour line of a representation. | |
| SoSFNode | moduleDataMapping |
| Field used to do coloring according the module of the vectors. | |
| SoSFBool | smoothTextureContouring |
| If set to true and combined with COLOR_TEXTURE_CONTOURING coloring type, the texture used for coloring appears smoothed, since a linear interpolation is used instead of a nearest one. | |
| SoSFFloat | creaseAngle |
| Indicates the minimum angle (in radians) between two adjacent face normals required to form a sharp crease at the edge when default normals are computed and used. | |
| Public Attributes inherited from SoBaseKit | |
| SoSFBool | boundingBoxIgnoring |
| Whether to ignore this node during bounding box traversal. | |
Base class of all streamline representations on a mesh.
Class to calculate the geometry of streamlines starting from a list of source points. A streamline is a line that is everywhere tangent to the vectors field. Streamlines are meaningless for unsteady flow, because the time is not taken into account during the computation of the line. Streamlines are calculated by using a Runge/Kutta method of order 2.
The streamlines are calculated from a set of vectors in the current mesh. See PoMesh for more explanations about the current mesh. The index of vectors data set used to compute streamlines, is defined by the field PoMesh::vecsIndex. If this vectors data set does not exist in the current mesh, the representation is empty. The origin of each vector is a node of the mesh.
The derived classes respect the following rules to color the representation:
If PoMesh::coloringType = COLOR_INHERITED and if the field "colors" is empty, the representation uses only one inherited color, so each part of the representation have the same color.
If PoMesh::coloringType = COLOR_INHERITED and if the field colors is not empty, the representation uses each colors of field for each streamline. For example, the streamline starting from the i-th startPoints is colored by colors[inum_colors], where num_colors is the size of the field "colors".
If the field PoMesh::valuesIndex is not defined (i.e. < 0), and if coloringType != COLOR_INHERITED, the representations are colored by using the current data mapping applied to the velocity at each point of the streamlines. The definition of the "current data mapping" is explained in PoMesh.
If the field PoMesh::valuesIndex is defined, and if coloringType != COLOR_INHERITED, the representations are colored by using the current data mapping applied to the value at each point of the streamlines.
| startPoints | SbVec3f(0,0,0) |
| maxLifetime | 0 (i.e. infinite) |
| maxLength | 0 (i.e. infinite) |
| minSpeed | 0 (i.e. infinite) |
| integrationStepLengthFactor | 0.3 |
| integrationMaxStepNumber | 0 (i.e. infinite) |
| integrationDirection | FORWARD |
| colors | (SbColor(1,0,0) |
| coloringType | COLOR_INHERITED |
| valuesIndex | -1 |
| valuesIndexForCellFilter | -1 |
| vecsIndex | -1 |
| moduleDataMapping | NULL |
Definition at line 96 of file PoBaseStreamLine.h.
Type of integration direction.
| Enumerator | |
|---|---|
| FORWARD | Integration is done as the direction of the vectors. |
| BACKWARD | Integration is done as the inverse of the direction of the vectors. |
Definition at line 164 of file PoBaseStreamLine.h.
| PoBaseStreamLine::PoBaseStreamLine | ( | ) |
Constructor.
|
static |
Returns the SoNodekitCatalog for this class.
|
static |
Returns the type identifier for this class.
|
virtual |
Returns the SoNodekitCatalog for this instance.
Reimplemented from PoMesh.
Reimplemented in PoStreamLine, PoStreamLineMotion, PoStreamParticleMotion, PoStreamPointMotion, PoStreamSphereMotion, PoStreamSurface, and PoStreamTadpoleMotion.
|
virtual |
Returns the type identifier for this specific instance.
Reimplemented from PoMesh.
Reimplemented in PoStreamLine, PoStreamLineMotion, PoStreamParticleMotion, PoStreamPointMotion, PoStreamSphereMotion, PoStreamSurface, and PoStreamTadpoleMotion.
| SoMFColor PoBaseStreamLine::colors |
List of colors used by some derived class to color each streamline.
Empty field by default.
Definition at line 119 of file PoBaseStreamLine.h.
| SoSFEnum PoBaseStreamLine::integrationDirection |
| SoSFInt32 PoBaseStreamLine::integrationMaxStepNumber |
Computing the streamline is done while the number of integration step is less than integrationMaxStepNumber.
integrationMaxStepNumber <= 0 means infinite. 0 by default.
Definition at line 154 of file PoBaseStreamLine.h.
| SoSFFloat PoBaseStreamLine::integrationStepLengthFactor |
It is a factor of the size of a cell.
It represents the gap between two consecutive points of the calculated streamline. The gap depends of the cell's size. If S is the size of the current cell, the gap is S*integrationStepLengthFactor. The lower this step is, the more accurate the streamline is. Setting a value < 1, ensures that each cell which cross the streamline is taken into account. 0.3 by default.
Definition at line 147 of file PoBaseStreamLine.h.
| SoSFFloat PoBaseStreamLine::maxLength |
The curvilinear distance between the start-point and the last point of a streamline must be less than maxLength.
maxLength <= 0 means an infinite distance. 0 by default.
Definition at line 132 of file PoBaseStreamLine.h.
| SoSFFloat PoBaseStreamLine::maxLifetime |
The difference between the time of the start-point and the time of the last point of a streamline must be less than maxLifetime.
maxLifetime <= 0 means an infinite lifetime. 0 by default.
Definition at line 126 of file PoBaseStreamLine.h.
| SoSFFloat PoBaseStreamLine::minSpeed |
The streamline ends when it goes through a point where the velocity is less than minSpeed.
minSpeed <= 0 means an infinite speed. 0 by default.
Definition at line 138 of file PoBaseStreamLine.h.
| SoMFVec3f PoBaseStreamLine::startPoints |
Start points of the streamlines.
SbVec3f(0,0,0) by default.
Definition at line 113 of file PoBaseStreamLine.h.
1.9.8 