Animation of particles along streamlines on a mesh. More...

#include <MeshViz/3Ddata/PoStreamParticleMotion.h>

Inheritance diagram for PoStreamParticleMotion:

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.

Public Member Functions inherited from PoBaseStreamLine
	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 &parameterString)
	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 PoBaseStreamLine
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
SoSFInt32	pulseFrequency
	Number of frames to be visualized during an animation cycle.

SoSFFloat	shiftStart
	Duration from which the first position on the streamline is calculated.

SoSFFloat	timeStep
	Time step between 2 consecutive points of a streamline.

SoSFBool	isStartRandomized
	Set it to TRUE prevents each first position of the different streamlines to start simultaneously.

SoSFBool	isBlinking
	Stop the animation if isBlinking is FALSE.

SoSFInt32	viewFrame
	Visualized frame index (used only if isBlinking is FALSE).

SoSFFloat	blinkSpeed
	Number of animation's cycles per second.

Public Attributes inherited from PoBaseStreamLine
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.

Additional Inherited Members
Public Types inherited from PoBaseStreamLine
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)

Detailed Description

Animation of particles along streamlines on a mesh.

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,19

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

FILE FORMAT/DEFAULT

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

Definition at line 100 of file PoStreamParticleMotion.h.

Member Function Documentation

◆ getClassNodekitCatalog()

static const SoNodekitCatalog * PoStreamParticleMotion::getClassNodekitCatalog ( )

static

Returns the SoNodekitCatalog for this class.

◆ getClassTypeId()

static SoType PoStreamParticleMotion::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getNodekitCatalog()

virtual const SoNodekitCatalog * PoStreamParticleMotion::getNodekitCatalog ( ) const

virtual

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoBaseStreamLine.

Reimplemented in PoStreamLineMotion, PoStreamPointMotion, PoStreamSphereMotion, and PoStreamTadpoleMotion.

◆ getTypeId()

virtual SoType PoStreamParticleMotion::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from PoBaseStreamLine.

Reimplemented in PoStreamLineMotion, PoStreamPointMotion, PoStreamSphereMotion, and PoStreamTadpoleMotion.

Member Data Documentation

◆ blinkSpeed

SoSFFloat PoStreamParticleMotion::blinkSpeed

Number of animation's cycles per second.

3.0 by default.

Definition at line 150 of file PoStreamParticleMotion.h.

◆ isBlinking

SoSFBool PoStreamParticleMotion::isBlinking

Stop the animation if isBlinking is FALSE.

TRUE by default.

Definition at line 138 of file PoStreamParticleMotion.h.

◆ isStartRandomized

SoSFBool PoStreamParticleMotion::isStartRandomized

Set it to TRUE prevents each first position of the different streamlines to start simultaneously.

TRUE by default.

Definition at line 132 of file PoStreamParticleMotion.h.

◆ pulseFrequency

SoSFInt32 PoStreamParticleMotion::pulseFrequency

Number of frames to be visualized during an animation cycle.

5 by default.

Definition at line 113 of file PoStreamParticleMotion.h.

◆ shiftStart

SoSFFloat PoStreamParticleMotion::shiftStart

Duration from which the first position on the streamline is calculated.

0 by default.

Definition at line 119 of file PoStreamParticleMotion.h.

◆ timeStep

SoSFFloat PoStreamParticleMotion::timeStep

Time step between 2 consecutive points of a streamline.

1 by default.

Definition at line 125 of file PoStreamParticleMotion.h.

◆ viewFrame

SoSFInt32 PoStreamParticleMotion::viewFrame

Visualized frame index (used only if isBlinking is FALSE).