PoStreamParticleMotion Class |
Animation of particles along streamlines on a mesh.
Namespace: OIV.MeshViz.Data
The PoStreamParticleMotion type exposes the following members.
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 | |
---|---|---|
blinkSpeed | Number of animation's cycles per second. | |
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. | |
isBlinking | Stop the animation if isBlinking is false. | |
IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) | |
isStartRandomized | Set it to true prevents each first position of the different streamlines to start simultaneously. | |
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. | |
pulseFrequency | Number of frames to be visualized during an animation cycle. | |
shiftStart | Duration from which the first position on the streamline is calculated. | |
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. | |
timeStep | Time step between 2 consecutive points of a streamline. | |
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,...) | |
viewFrame | Visualized frame index (used only if isBlinking is false). |
Name | Description | |
---|---|---|
PostRebuild | (Inherited from PoBase.) | |
PreRebuild | (Inherited from PoBase.) |
This class realizes animation of particle along the list of streamlines starting from startPoints. First, it calculates the geometry of these streamlines according to the fields of the inherited class. Then it calculates a list of positions along the streamlines. Two consecutive positions on streamlines must be separated by a constant timeStep, in order to have an animation which respect the velocity. After that, blinking several frames does the animation. Each frame represents a selection of the calculated positions. This selection and the number of frame are defined by the value of pulseFrequency. For example, if pulseFrequency = 5, one position over 5 is kept in a frame. 5 frames are built, and the animation process will blink by cycling switch-on/switch-off one of these 5 frames. For a streamline made of 20 calculated positions, the 5 frames have the following position's indices:
Frame 0: 0,5,10,15 Frame 1: 1,6,11,16 Frame 2: 2,7,12,17 Frame 3: 3,8,13,18 Frame 4: 4,9,14,19The first position of each streamline can be shifted in time, after duration of shiftStart from the source point. If isStartRandomized is false, the first position's index of frame 0, is always 0. Otherwise, it has a random value between 0 and pulseFrequency-1. Setting isStartRandomized to true is interesting only when several startPoint are defined, because it prevents each first position of the different streamlines to start simultaneously.
Blinking from a frame to the next frame can be speeded up or speeded down by the blinkSpeed field. It defines the number of cycles per second. Setting isBlinking to false can stop the animation. In that case, the index of the visualized frame is viewFrame % pulseFrequency.
OIV.MeshViz.Data.PoStreamParticleMotion {
pulseFrequency | 5 |
shiftStart | 0.0 |
timeStep | 1.0 |
isStartRandomized | true |
isBlinking | true |
viewFrame | 0 |
blinkSpeed | 3.0 |
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 |