Open Inventor Release 2024.1.1
 
Loading...
Searching...
No Matches
MiPlaneSliceExtractUnstructured Class Referenceabstract

MeshViz Plane slice extractor for unstructured volume meshes More...

#include <MeshVizXLM/extractors/MiPlaneSliceExtractUnstructured.h>

+ Inheritance diagram for MiPlaneSliceExtractUnstructured:

Public Member Functions

virtual ~MiPlaneSliceExtractUnstructured ()
 
virtual const MeXSurfaceMeshUnstructuredextractSlice (const MbVec3< double > &normal, double distance, const MiCellFilterI *cellFilter=NULL)=0
 Builds the topology and geometry of a plane slice intersecting the volume mesh.
 
virtual const MeXLineMeshUnstructuredextractLineSlice (const MbVec3< double > &normal, double distance, const MiCellFilterI *cellFilter=NULL)=0
 Builds the topology and geometry of a plane slice intersecting the volume mesh and returns them as a line mesh representing the edges of each cell.
 
virtual const MeXScalardSetIextractScalarSet (const MiScalardSetI &inputSet)=0
 Extracts a scalar set from the volume mesh.
 
virtual const MeXVec3dSetIextractVec3Set (const MiVec3dSetI &inputSet)=0
 Extracts a vector set from the volume mesh.
 
virtual const MeXSurfaceMeshUnstructuredgetExtract () const =0
 Returns the result of the extraction as a mesh.
 
virtual const MeXLineMeshUnstructuredgetLineExtract () const =0
 Returns the result of the extraction as a line mesh.
 
- Public Member Functions inherited from MiBaseExtractor
virtual ~MiBaseExtractor ()
 
virtual void setExtractorCallback (MiExtractorCallback *extractorCallback)=0
 Set the user defined extractor callback which will be called before each extraction, during each extraction and after each extraction.
 
virtual SoDEPRECATED void setExtractorCallback (MiExtractorCallback &extractorCallback)
 

Static Public Member Functions

static MiPlaneSliceExtractUnstructuredgetNewInstance (const MiVolumeMeshUnstructured &mesh, bool parallel=true, MiTessellator *tessellator=NULL)
 Factory method returning a new instance of a class implementing this interface.
 

Detailed Description

MeshViz Plane slice extractor for unstructured volume meshes

A plane slice is the intersection of a given plane with the mesh volume. The extracted plane slice is an unstructured surface.

Definition at line 44 of file MiPlaneSliceExtractUnstructured.h.

Constructor & Destructor Documentation

◆ ~MiPlaneSliceExtractUnstructured()

virtual MiPlaneSliceExtractUnstructured::~MiPlaneSliceExtractUnstructured ( )
inlinevirtual

Definition at line 47 of file MiPlaneSliceExtractUnstructured.h.

Member Function Documentation

◆ extractLineSlice()

virtual const MeXLineMeshUnstructured & MiPlaneSliceExtractUnstructured::extractLineSlice ( const MbVec3< double > &  normal,
double  distance,
const MiCellFilterI cellFilter = NULL 
)
pure virtual

Builds the topology and geometry of a plane slice intersecting the volume mesh and returns them as a line mesh representing the edges of each cell.

Returns
the extracted plane slice as an unstructured line mesh.
Parameters
normalVector normal to the plane slice
distancePosition of the plane relatively to the origin along the normal
cellFilterThe cell filter object.

◆ extractScalarSet()

virtual const MeXScalardSetI & MiPlaneSliceExtractUnstructured::extractScalarSet ( const MiScalardSetI inputSet)
pure virtual

Extracts a scalar set from the volume mesh.

The scalars are mapped onto the current extracted planeslice refering to either the line mesh or the surface mesh depending on whether extractSlice() or extractLineSlice() was last called.

Parameters
inputSetthe input scalar set defined on the volume mesh
Returns
the output scalar set defined on the latest extracted mesh

◆ extractSlice()

virtual const MeXSurfaceMeshUnstructured & MiPlaneSliceExtractUnstructured::extractSlice ( const MbVec3< double > &  normal,
double  distance,
const MiCellFilterI cellFilter = NULL 
)
pure virtual

Builds the topology and geometry of a plane slice intersecting the volume mesh.

Returns
the plane slice extracted as an unstructured surface mesh.
Parameters
normalVector normal to the plane slice
distancePosition of the plane relatively to the origin along the normal
cellFilterThe cell filter object.
Returns
An unstructured surface mesh representing the plane slice

◆ extractVec3Set()

virtual const MeXVec3dSetI & MiPlaneSliceExtractUnstructured::extractVec3Set ( const MiVec3dSetI inputSet)
pure virtual

Extracts a vector set from the volume mesh.

The vectors are mapped onto the current extracted planeslice refering to either the line mesh or the surface mesh depending on whether extractSlice() or extractLineSlice() was last called.

Parameters
inputSetthe input vector set defined on the volume mesh
Returns
the output vector set defined on the latest extracted mesh

◆ getExtract()

virtual const MeXSurfaceMeshUnstructured & MiPlaneSliceExtractUnstructured::getExtract ( ) const
pure virtual

Returns the result of the extraction as a mesh.

◆ getLineExtract()

virtual const MeXLineMeshUnstructured & MiPlaneSliceExtractUnstructured::getLineExtract ( ) const
pure virtual

Returns the result of the extraction as a line mesh.

◆ getNewInstance()

static MiPlaneSliceExtractUnstructured * MiPlaneSliceExtractUnstructured::getNewInstance ( const MiVolumeMeshUnstructured mesh,
bool  parallel = true,
MiTessellator tessellator = NULL 
)
static

Factory method returning a new instance of a class implementing this interface.

Parameters
meshThe input mesh
parallelWhen true, tries to create an extract module using a parallel algorithm to speed up the extraction.
tessellatorThe tessellator object used for tessellating non linear cells (quadratic,...).
Note
Only some of the extraction algorithms have a parallel implementation.

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