MoMeshPointProbe Class Reference

Action node that probes cells of a mesh More...

#include <MeshVizXLM/mapping/nodes/MoMeshPointProbe.h>

Inheritance diagram for MoMeshPointProbe:

Classes
class	MoProbeCallback
	This class specifies the interface used by this node to notify the application when the position of the probe is updated. More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	MoMeshPointProbe ()
	Constructor.
void	setProbeCallback (MoProbeCallback &probeCallback)
	Set the user defined probe callback which will be called when the motion event occurs.
void	removeProbeCallback ()
	remove the user defined probe callback (see setProbeCallback()) which will disable the node.
const MiPointProbeUnstructured *	getPointProbeUnstructured ()
	Get probes for reuse outside this node.
const MiPointProbeHexahedronIjk *	getPointProbeHexahedronIjk ()
const MiPointProbeIjk *	getPointProbeIjk ()
const MiPointProbeIj *	getPointProbeIj ()
const MiPointProbeHexahedronIjk *	getPointProbeUnstructuredIjk ()
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 SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.
virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.
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.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from MoActionNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
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
SoSFVec3f	position
	Field representing the position of the probe.
SoMFInt32	scalarSetIds
	Field representing the scalar set nodes to use when probing at the current position.
SoMFInt32	vectorSetIds
	Field representing the vector set nodes to use when probing at the current position.

Detailed Description

Action node that probes cells of a mesh

This node retrieves information at a given position in a mesh and triggers a callback each time the position moves.

The callback is defined by calling the method setProbeCallback().

The information available in the callback are the cellId, the scalars and vectors interpolated at the probe location. The scalar and vector values are computed from the scalar sets and vector sets defined by the scalarSetIds and vectorSetIds fields. These are indices into the list of scalar sets and vector sets existing in the traversal state (see the MoScalarSetxxx and MoVec3Setxxx nodes).

Set these fields to -1 to disable interpolating these data sets.

Probing can be optimized by setting environment variables (see the MESHVIZ_OCTREE_ variables in SoPreferences).

Since Open Inventor version 8.5, using the probe tool should be limited to probing inside a volume. Probing a mesh representation (skin, slice, etc) should now be done using Open Inventor picking (see the getPickedPoint method in classes SoRayPickAction, SoEventCallback, etc) combined with the MoFaceDetail or MoLineDetail and their derived classes.

FILE FORMAT/DEFAULT

MoMeshPointProbe {

position	0,0,0
scalarSetIds	0
vectorSetIds	0

}

SEE ALSO

MiPointProbeUnstructured, MiPointProbeHexahedronIjk, MiPointProbeIjk, MiPointProbeIj.

Definition at line 88 of file MoMeshPointProbe.h.

Constructor & Destructor Documentation

MoMeshPointProbe()

MoMeshPointProbe::MoMeshPointProbe

(

)

Constructor.

Member Function Documentation

getClassTypeId()

static SoType MoMeshPointProbe::getClassTypeId ( )

static

Returns the type identifier for this class.

getPointProbeHexahedronIjk()

const MiPointProbeHexahedronIjk * MoMeshPointProbe::getPointProbeHexahedronIjk

(

)

getPointProbeIj()

const MiPointProbeIj * MoMeshPointProbe::getPointProbeIj

(

)

getPointProbeIjk()

const MiPointProbeIjk * MoMeshPointProbe::getPointProbeIjk

(

)

getPointProbeUnstructured()

const MiPointProbeUnstructured * MoMeshPointProbe::getPointProbeUnstructured

(

)

Get probes for reuse outside this node.

Note

The returned pointer may be null if a mesh has not been set in the scene graph or if no probing action has traversed the scene graph. Use the method corresponding to the type of mesh stored in the scene graph.

getPointProbeUnstructuredIjk()

const MiPointProbeHexahedronIjk * MoMeshPointProbe::getPointProbeUnstructuredIjk

(

)

getTypeId()

virtual SoType MoMeshPointProbe::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from MoActionNode.

removeProbeCallback()

void MoMeshPointProbe::removeProbeCallback

(

)

remove the user defined probe callback (see setProbeCallback()) which will disable the node.

setProbeCallback()

void MoMeshPointProbe::setProbeCallback

(

MoProbeCallback &

probeCallback

)

Set the user defined probe callback which will be called when the motion event occurs.

If no callback set, the node is not activated (see also removeProbeCallback()).

Member Data Documentation

position

SoSFVec3f MoMeshPointProbe::position

Field representing the position of the probe.

Definition at line 103 of file MoMeshPointProbe.h.

scalarSetIds

SoMFInt32 MoMeshPointProbe::scalarSetIds

Field representing the scalar set nodes to use when probing at the current position.

During traversal of the scene graph, scalar set nodes are accumulated in a list of scalar sets. scalarSetIds are indices into this list. Default value is 0 which means that only the first scalar set stored in the scene graph is used. Setting this value to -1 disables the probing on scalar sets.

Definition at line 112 of file MoMeshPointProbe.h.

vectorSetIds

SoMFInt32 MoMeshPointProbe::vectorSetIds

Field representing the vector set nodes to use when probing at the current position.

During traversal of the scene graph, vector set nodes are accumulated in a list of vector sets. vectorSetIds are indices into this list. Default value is 0 which means that only the first vector set stored in the scene graph is used. Setting this value to -1 disables the probing on vector sets.

Definition at line 121 of file MoMeshPointProbe.h.

---

The documentation for this class was generated from the following file:

• MeshVizXLM/mapping/nodes/MoMeshPointProbe.h