PoBaseStreamLine Class |
Base class of all streamline representations on a mesh.
Namespace: OIV.MeshViz.Data
The PoBaseStreamLine type exposes the following members.
Name | Description | |
---|---|---|
PoBaseStreamLine | Constructor. |
Name | Description | |
---|---|---|
AffectsState | Returns true if a node has an effect on the state during traversal. | |
Callback | (Inherited from SoBaseKit.) | |
Copy | Calls Copy(false). (Inherited from SoNode.) | |
Copy(Boolean) | Creates and returns an exact copy of the node. | |
CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) | |
CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. | |
CreatePathToPart(String, Boolean) | Calls CreatePathToPart(partName, makeIfNeeded, (OIV.Inventor.SoPath ^)nullptr). (Inherited from SoBaseKit.) | |
CreatePathToPart(String, Boolean, SoPath) | Returns a path that begins at this nodekit and ends at partName. | |
Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) | |
Distribute | (Inherited from SoNode.) | |
DoAction | (Inherited from SoBaseKit.) | |
EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). | |
Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) | |
FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. | |
Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. | |
GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. | |
GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). | |
GetBoundingBox | (Inherited from SoBaseKit.) | |
GetClassNodekitCatalog | Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this class. | |
GetDataMapping | Returns the current OIV.MeshViz.Graph.PbDataMapping object. | |
GetDomain | Gets a reference to a OIV.MeshViz.Graph.PbDomain object used to define the data limits of the graphics to be generated. | |
GetEventIn | Returns a the eventIn with the given name. | |
GetEventOut | Returns the eventOut with the given name. | |
GetField | Returns a the field of this object whose name is fieldName. | |
GetFieldName | Returns the name of the given field in the fieldName argument. | |
GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. | |
GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) | |
GetIsovaluesList | Returns the current OIV.MeshViz.Graph.PbIsovaluesList object. | |
GetMatrix | (Inherited from SoBaseKit.) | |
GetMesh | Gets the current OIV.MeshViz.Data.PbMesh object. | |
GetModuleDataMapping | Returns the current OIV.MeshViz.Graph.PbDataMapping object for the association color-vectors module. | |
GetName | Returns the name of an instance. | |
GetNodekitCatalog | Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this instance of OIV.Inventor.Nodekits.SoBaseKit. | |
GetPart | Searches the nodekit catalog (and those of all nested nodekits) for the part named partName. | |
GetPartString | 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. | |
GetPrimitiveCount | (Inherited from SoBaseKit.) | |
GetRenderEngineMode | Returns the supported Render engine mode. | |
GetRenderUnitID | (Inherited from SoNode.) | |
GetStringName | (Inherited from SoBase.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetUpdateMethod | Gets update method. | |
GetViewportIsEnabled | (Inherited from SoBaseKit.) | |
GetViewportOrigin | (Inherited from SoBaseKit.) | |
GetViewportSize | (Inherited from SoBaseKit.) | |
GLRender | (Inherited from SoBaseKit.) | |
GLRenderBelowPath | (Inherited from SoNode.) | |
GLRenderInPath | (Inherited from SoNode.) | |
GLRenderOffPath | (Inherited from SoNode.) | |
GrabEventsCleanup | (Inherited from SoNode.) | |
GrabEventsSetup | (Inherited from SoNode.) | |
HandleEvent | (Inherited from SoBaseKit.) | |
HasDefaultValues | Returns true if all of the object's fields have their default values. | |
IsBoundingBoxIgnoring | Returns true if bounding box computation should be ignored during OIV.Inventor.Actions.SoGetBoundingBoxAction traversal. | |
IsBuilt | Indicates if the node kit has been built at least once. | |
IsModified | Return true, if the kit has been modified, else otherwise. | |
IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. | |
IsOverride | Returns the state of the override flag. | |
IsSynchronizable | Gets the ScaleViz synchronizable state of this object. | |
Pick | (Inherited from SoNode.) | |
RayPick | (Inherited from SoBaseKit.) | |
Rebuild | Forces the node kit to be rebuilt immediately. | |
Search | (Inherited from SoBaseKit.) | |
Set(String) | This function allows field values of parts (nodes) to be set in several different parts simultaneously. | |
Set(String, String) | This function allows field values of parts (nodes) to be set. | |
SetDataMapping | Sets a reference to a OIV.MeshViz.Graph.PbDataMapping object for the association color-value. | |
SetDomain | Sets a reference to a OIV.MeshViz.Graph.PbDomain object used to define the data limits of the graphics to be generated. | |
SetIsovaluesList | Sets a reference to a OIV.MeshViz.Graph.PbIsovaluesList object to define a list of isovalues. | |
SetMesh | Sets a reference to a OIV.MeshViz.Data.PbMesh object. | |
SetModuleDataMapping | Sets a reference to a OIV.MeshViz.Graph.PbDataMapping object for the association color-vectors module. | |
SetName | (Inherited from SoBase.) | |
SetOverride | Turns the override flag on or off. | |
SetPart | Inserts the given node (not a copy) as the new part specified by partName. | |
SetSynchronizable | Sets this to be a ScaleViz synchronizable object. | |
SetToDefaults | Sets all fields in this object to their default values. | |
SetUpdateMethod | Sets scene graph update method. | |
ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) | |
Touch | Marks an instance as modified, simulating a change to it. | |
TouchKit | Indicates the node kit is modified. | |
Write | (Inherited from SoBaseKit.) |
Name | Description | |
---|---|---|
boundingBoxIgnoring | Whether to ignore this node during bounding box traversal. | |
coloringType | Defines the type of method used to color each mesh element, mesh edge or mesh contour line of a representation. | |
colors | List of colors used by some derived class to color each streamline. | |
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. | |
integrationDirection | Direction of integration. | |
integrationMaxStepNumber | Computing the streamline is done while the number of integration step is less than integrationMaxStepNumber. | |
integrationStepLengthFactor | It is a factor of the size of a cell. | |
IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) | |
maxLength | The curvilinear distance between the start-point and the last point of a streamline must be less than maxLength. | |
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. | |
minSpeed | The streamline ends when it goes through a point where the velocity is less than minSpeed. | |
moduleDataMapping | Field used to do coloring according the module of the vectors. | |
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. | |
startPoints | Start points of the streamlines. | |
UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) | |
valuesIndex | Defines the index of the set of values for the coloring. | |
valuesIndexForCellFilter | Specifies the index of the set of values used to filter cells for this mesh representation. | |
vecsIndex | Defines the index of the set of vectors for all representations which need a vector at each mesh node (OIV.MeshViz.Data.PoBaseStreamLine, OIV.MeshViz.Data.PoMesh2DVec, OIV.MeshViz.Data.PoMesh3DVec,...) |
Name | Description | |
---|---|---|
PostRebuild | (Inherited from PoBase.) | |
PreRebuild | (Inherited from PoBase.) |
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 OIV.MeshViz.Data.PoMesh for more explanations about the current mesh. The index of vectors data set used to compute streamlines, is defined by the field OIV.MeshViz.Data.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 OIV.MeshViz.Data.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 OIV.MeshViz.Data.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 OIV.MeshViz.Data.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 OIV.MeshViz.Data.PoMesh.
If the field OIV.MeshViz.Data.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.
OIV.MeshViz.Data.PoBaseStreamLine {
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 |