Open Inventor Release 2024.1.0
 
Loading...
Searching...
No Matches
MoMeshPointProbe::MoProbeCallback Class Reference

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

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

Public Member Functions

virtual void motionCallback (size_t cellId, const MeXScalardSetI &scalars, const MeXVec3dSetI &vectors)
 Callback that is triggered each time the field MoMeshPointProbe::position changes on a unstructured mesh.
 
virtual void motionCallback (size_t cellIdI, size_t cellIdJ, const MeXScalardSetI &scalars, const MeXVec3dSetI &vectors)
 Callback that is triggered each time the field MoMeshPointProbe::position changes on a structured IJ mesh.
 
virtual void motionCallback (size_t cellIdI, size_t cellIdJ, size_t cellIdK, const MeXScalardSetI &scalars, const MeXVec3dSetI &vectors)
 Callback that is triggered each time the field MoMeshPointProbe::position changes on a structured IJK mesh.
 
virtual ~MoProbeCallback ()
 

Detailed Description

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

A derived class must implement at least one of the event method motionCallback depending on the type of mesh.

Definition at line 129 of file MoMeshPointProbe.h.

Constructor & Destructor Documentation

◆ ~MoProbeCallback()

virtual MoMeshPointProbe::MoProbeCallback::~MoProbeCallback ( )
inlinevirtual

Definition at line 181 of file MoMeshPointProbe.h.

Member Function Documentation

◆ motionCallback() [1/3]

virtual void MoMeshPointProbe::MoProbeCallback::motionCallback ( size_t  cellId,
const MeXScalardSetI scalars,
const MeXVec3dSetI vectors 
)
inlinevirtual

Callback that is triggered each time the field MoMeshPointProbe::position changes on a unstructured mesh.

Parameters
[in]cellIdis the index of the cell in which the probe is located.
[in]scalarsis a set of probed scalar values from the selected scalar sets at the current position. The number of scalar values corresponds to the number of indices in scalarSetIds. The ith value in scalars is associated with the ith index in scalarSetIds.
[in]vectorsis a set of probed vectors from the selected vector sets at the current position. The number of vectors corresponds to the number of indices in vectorSetIds. The ith element in vectors is associated with the ith index in vectorSetIds.
Note
when the probe is outside the mesh, cellId equals -1 and the scalars and vectors parameters are empty.

Definition at line 145 of file MoMeshPointProbe.h.

◆ motionCallback() [2/3]

virtual void MoMeshPointProbe::MoProbeCallback::motionCallback ( size_t  cellIdI,
size_t  cellIdJ,
const MeXScalardSetI scalars,
const MeXVec3dSetI vectors 
)
inlinevirtual

Callback that is triggered each time the field MoMeshPointProbe::position changes on a structured IJ mesh.

Parameters
[in]cellIdIis the index I of the cell in which the probe is located.
[in]cellIdJis the index J of the cell in which the probe is located.
[in]scalarsis a set of probed scalar values from the selected scalar sets at the current position. The number of scalar values corresponds to the number of indices in scalarSetIds. The ith value in scalars is associated with the ith index in scalarSetIds.
[in]vectorsis a set of probed vectors from the selected vector sets at the current position. The number of vectors corresponds to the number of indices in vectorSetIds. The ith element in vectors is associated with the ith index in vectorSetIds.
Note
when the probe is outside the mesh, cellIdI and cellIdJ equal -1 and the scalars and vectors parameters are empty.

Definition at line 161 of file MoMeshPointProbe.h.

◆ motionCallback() [3/3]

virtual void MoMeshPointProbe::MoProbeCallback::motionCallback ( size_t  cellIdI,
size_t  cellIdJ,
size_t  cellIdK,
const MeXScalardSetI scalars,
const MeXVec3dSetI vectors 
)
inlinevirtual

Callback that is triggered each time the field MoMeshPointProbe::position changes on a structured IJK mesh.

Parameters
[in]cellIdIis the index I of the cell in which the probe is located.
[in]cellIdJis the index J of the cell in which the probe is located.
[in]cellIdKis the index K of the cell in which the probe is located.
[in]scalarsis a set of probed scalar values from the selected scalar sets at the current position. The number of scalar values corresponds to the number of indices in scalarSetIds. The ith value in scalars is associated with the ith index in scalarSetIds.
[in]vectorsis a set of probed vectors from the selected vector sets at the current position. The number of vectors corresponds to the number of indices in vectorSetIds. The ith element in vectors is associated with the ith index in vectorSetIds.
Note
when the probe is outside the mesh, cellIdI, cellIdJ and cellIdK equal -1 and the scalars and vectors parameters are empty.

Definition at line 178 of file MoMeshPointProbe.h.


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