Click or drag to resize
PoBaseStreamLine Class

Base class of all streamline representations on a mesh.

Inheritance Hierarchy
SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.MiscSoBase
        OIV.Inventor.FieldsSoFieldContainer
          OIV.Inventor.NodesSoNode
            OIV.Inventor.NodekitsSoBaseKit
              OIV.MeshViz.GraphPoBase
                OIV.MeshViz.DataPo3DdataMaster
                  OIV.MeshViz.DataPoMesh
                    OIV.MeshViz.DataPoBaseStreamLine
                      OIV.MeshViz.DataPoStreamLine
                      OIV.MeshViz.DataPoStreamParticleMotion
                      OIV.MeshViz.DataPoStreamSurface

Namespace: OIV.MeshViz.Data
Assembly: OIV.MeshViz (in OIV.MeshViz.dll) Version: 10.12.3.0 (10.12.3.0)
Syntax
public class PoBaseStreamLine : PoMesh

The PoBaseStreamLine type exposes the following members.

Constructors
  NameDescription
Public methodPoBaseStreamLine

Constructor.

Top
Methods
  NameDescription
Public methodAffectsState

Returns true if a node has an effect on the state during traversal.

(Inherited from SoNode.)
Public methodCallback
(Inherited from SoBaseKit.)
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodCreatePathToPart(String, Boolean)
Calls CreatePathToPart(partName, makeIfNeeded, (OIV.Inventor.SoPath ^)nullptr).
(Inherited from SoBaseKit.)
Public methodCreatePathToPart(String, Boolean, SoPath)

Returns a path that begins at this nodekit and ends at partName.

(Inherited from SoBaseKit.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
(Inherited from SoBaseKit.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type).

(Inherited from SoNode.)
Public methodGetBoundingBox
(Inherited from SoBaseKit.)
Public methodStatic memberGetClassNodekitCatalog

Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this class.

Public methodGetDataMapping

Returns the current OIV.MeshViz.Graph.PbDataMapping object.

(Inherited from PoMesh.)
Public methodGetDomain

Gets a reference to a OIV.MeshViz.Graph.PbDomain object used to define the data limits of the graphics to be generated.

(Inherited from PoBase.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetIsovaluesList

Returns the current OIV.MeshViz.Graph.PbIsovaluesList object.

(Inherited from PoMesh.)
Public methodGetMatrix
(Inherited from SoBaseKit.)
Public methodGetMesh

Gets the current OIV.MeshViz.Data.PbMesh object.

(Inherited from PoMesh.)
Public methodGetModuleDataMapping

Returns the current OIV.MeshViz.Graph.PbDataMapping object for the association color-vectors module.

(Inherited from PoMesh.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetNodekitCatalog (Inherited from SoBaseKit.)
Public methodGetPart

Searches the nodekit catalog (and those of all nested nodekits) for the part named partName.

(Inherited from SoBaseKit.)
Public methodGetPartString

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.

(Inherited from SoBaseKit.)
Public methodGetPrimitiveCount
(Inherited from SoBaseKit.)
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUpdateMethod

Gets update method.

(Inherited from PoBase.)
Public methodGetViewportIsEnabled (Inherited from SoBaseKit.)
Public methodGetViewportOrigin (Inherited from SoBaseKit.)
Public methodGetViewportSize (Inherited from SoBaseKit.)
Public methodGLRender
(Inherited from SoBaseKit.)
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Inherited from SoBaseKit.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsBoundingBoxIgnoring

Returns true if bounding box computation should be ignored during OIV.Inventor.Actions.SoGetBoundingBoxAction traversal.

(Inherited from SoBaseKit.)
Public methodIsBuilt

Indicates if the node kit has been built at least once.

(Inherited from PoBase.)
Public methodIsModified

Return true, if the kit has been modified, else otherwise.

(Inherited from PoBase.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick
(Inherited from SoBaseKit.)
Public methodRebuild

Forces the node kit to be rebuilt immediately.

(Inherited from PoBase.)
Public methodSearch
(Inherited from SoBaseKit.)
Public methodSet(String)

This function allows field values of parts (nodes) to be set in several different parts simultaneously.

(Inherited from SoBaseKit.)
Public methodSet(String, String)

This function allows field values of parts (nodes) to be set.

(Inherited from SoBaseKit.)
Public methodSetDataMapping

Sets a reference to a OIV.MeshViz.Graph.PbDataMapping object for the association color-value.

(Inherited from PoMesh.)
Public methodSetDomain

Sets a reference to a OIV.MeshViz.Graph.PbDomain object used to define the data limits of the graphics to be generated.

(Inherited from PoBase.)
Public methodSetIsovaluesList

Sets a reference to a OIV.MeshViz.Graph.PbIsovaluesList object to define a list of isovalues.

(Inherited from PoMesh.)
Public methodSetMesh

Sets a reference to a OIV.MeshViz.Data.PbMesh object.

(Inherited from PoMesh.)
Public methodSetModuleDataMapping

Sets a reference to a OIV.MeshViz.Graph.PbDataMapping object for the association color-vectors module.

(Inherited from PoMesh.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetPart

Inserts the given node (not a copy) as the new part specified by partName.

(Inherited from SoBaseKit.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodSetUpdateMethod

Sets scene graph update method.

(Inherited from PoBase.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodTouchKit

Indicates the node kit is modified.

(Inherited from PoBase.)
Public methodWrite
(Inherited from SoBaseKit.)
Top
Properties
  NameDescription
Public propertyboundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

(Inherited from SoBaseKit.)
Public propertycoloringType

Defines the type of method used to color each mesh element, mesh edge or mesh contour line of a representation.

(Inherited from PoMesh.)
Public propertycolors

List of colors used by some derived class to color each streamline.

Public propertycreaseAngle

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.

(Inherited from PoMesh.)
Public propertyintegrationDirection

Direction of integration.

Public propertyintegrationMaxStepNumber

Computing the streamline is done while the number of integration step is less than integrationMaxStepNumber.

Public propertyintegrationStepLengthFactor

It is a factor of the size of a cell.

Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertymaxLength

The curvilinear distance between the start-point and the last point of a streamline must be less than maxLength.

Public propertymaxLifetime

The difference between the time of the start-point and the time of the last point of a streamline must be less than maxLifetime.

Public propertyminSpeed

The streamline ends when it goes through a point where the velocity is less than minSpeed.

Public propertymoduleDataMapping

Field used to do coloring according the module of the vectors.

(Inherited from PoMesh.)
Public propertysmoothTextureContouring

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.

(Inherited from PoMesh.)
Public propertystartPoints

Start points of the streamlines.

Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Public propertyvaluesIndex

Defines the index of the set of values for the coloring.

(Inherited from PoMesh.)
Public propertyvaluesIndexForCellFilter

Specifies the index of the set of values used to filter cells for this mesh representation.

(Inherited from PoMesh.)
Public propertyvecsIndex

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,...)

(Inherited from PoMesh.)
Top
Events
  NameDescription
Public eventPostRebuild
(Inherited from PoBase.)
Public eventPreRebuild
(Inherited from PoBase.)
Top
Remarks

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.

FILE FORMAT/DEFAULT

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
}

See Also