MiPlaneSliceExtractUnstructured Class Reference
[Slice]

Plane slice extractor for unstructured volume meshes More...

#include <MeshVizXLM/extractors/MiPlaneSliceExtractUnstructured.h>

Inheritance diagram for MiPlaneSliceExtractUnstructured:

List of all members.

Public Member Functions
virtual	~MiPlaneSliceExtractUnstructured ()
virtual const MeXSurfaceMeshUnstructured &	extractSlice (const MbVec3< double > &normal, double distance, const MiCellFilterI *cellFilter=NULL)=0
virtual const MeXLineMeshUnstructured &	extractLineSlice (const MbVec3< double > &normal, double distance, const MiCellFilterI *cellFilter=NULL)=0
virtual const MeXScalardSetI &	extractScalarSet (const MiScalardSetI &inputSet)=0
virtual const MeXVec3dSetI &	extractVec3Set (const MiVec3dSetI &inputSet)=0
virtual const MeXSurfaceMeshUnstructured &	getExtract () const =0
virtual const MeXLineMeshUnstructured &	getLineExtract () const =0
Static Public Member Functions
static MiPlaneSliceExtractUnstructured *	getNewInstance (const MiVolumeMeshUnstructured &mesh, bool parallel=true, MiTessellator *tessellator=NULL)

---

Detailed Description

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.

See related examples:

MultipleBenchmark, Bench_PlaneSlice, TutorialComputeSliceArea

---

Constructor & Destructor Documentation

virtual MiPlaneSliceExtractUnstructured::~MiPlaneSliceExtractUnstructured

(

)

[inline, virtual]

---

Member Function Documentation

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:

	normal	Vector normal to the plane slice
	distance	Position of the plane relatively to the origin along the normal
	cellFilter	The cell filter object.

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:

inputSet

the input scalar set defined on the volume mesh

Returns:

the output scalar set defined on the latest extracted mesh

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:

	normal	Vector normal to the plane slice
	distance	Position of the plane relatively to the origin along the normal
	cellFilter	The cell filter object.

Returns:

An unstructured surface mesh representing the plane slice

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:

inputSet

the input vector set defined on the volume mesh

Returns:

the output vector set defined on the latest extracted mesh

virtual const MeXSurfaceMeshUnstructured& MiPlaneSliceExtractUnstructured::getExtract

(

)

const [pure virtual]

Returns the result of the extraction as a mesh.

virtual const MeXLineMeshUnstructured& MiPlaneSliceExtractUnstructured::getLineExtract

(

)

const [pure virtual]

Returns the result of the extraction as a line mesh.

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:

	mesh	The input mesh
	parallel	When true, tries to create an extract module using a parallel algorithm to speed up the extraction.
	tessellator	The 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:

• MeshVizXLM/extractors/MiPlaneSliceExtractUnstructured.h