Rendering node that displays a logical slice of a structured volume mesh. More...

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

Inheritance diagram for MoMeshLogicalSlice:

Classes
class	SliceAxis

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

	MoMeshLogicalSlice ()
	Constructor.

const MiLogicalSliceExtractRegular *	getRegularExtractor ()
	Get extractor for reuse outside this node.

const MiLogicalSliceExtractRectilinear *	getRectilinearExtractor ()

const MiLogicalSliceExtractCurvilinear *	getCurvilinearExtractor ()

const MiLogicalSliceExtractHexahedronIjk *	getHexahedronIjkExtractor ()

Public Member Functions inherited from MoMeshRepresentation
virtual void	setExtractorCallback (MiExtractorCallback *extractorCallback)
	Set the extraction callback which will be called each time an extraction is performed.

virtual SoDEPRECATED void	setExtractorCallback (MiExtractorCallback &extractorCallback)

Public Member Functions inherited from MoMeshBaseRepresentation
virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.

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 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 MoMeshSurfaceRepresentation
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Static Public Member Functions inherited from MoMeshRepresentation
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Static Public Member Functions inherited from MoMeshBaseRepresentation
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
SoSFUInt32	sliceIndex
	Index of the slice to display.

SoSFEnum	sliceAxis
	The dimension along which the logical slice will be computed defined by the MiMesh::Dimension enum.

SoSFBool	upperVertex
	If FALSE (the default), displays the lower part of the cell, otherwise displays the upper part of the cell.

Public Attributes inherited from MoMeshRepresentation
SoSFInt32	colorScalarSetId
	Field representing the scalar set node to be used to map colors onto the representation.

SoSFBool	parallel
	If TRUE, the node tries to launch the extraction in parallel if this is supported by the associated extractor.

Deprecated

static SoDEPRECATED const MiMesh::Dimension	SLICE_I = MiMesh::DIMENSION_I
	Slice at I constant.

static SoDEPRECATED const MiMesh::Dimension	SLICE_J = MiMesh::DIMENSION_J
	Slice at J constant.

static SoDEPRECATED const MiMesh::Dimension	SLICE_K = MiMesh::DIMENSION_K
	Slice at K constant.

SoDEPRECATED const MiLogicalSliceExtractHexahedronIjk *	getUnstructuredIjkExtractor ()

Detailed Description

Rendering node that displays a logical slice of a structured volume mesh.

A logical slice is an unstructured surface mesh extracted from an IJK volume mesh along the upper or lower faces of a "row" of cells. It is defined by a slice axis, an index and a boolean flag.

The slice axis can be MiMesh::Dimension::I, MiMesh::Dimension::J or MiMesh::Dimension::K. The index represents a constant value for I, J or K (whichever is the slice axis). The boolean upperVertex specifies whether the slice is rendered using the lower or upper vertices (roughly the near or far faces) of the cells.

If N is the number of cells on the specified sliceAxis, then the valid range for sliceIndex is 0..N. As a convenience, when sliceIndex = N, the N-1 cells are used but upperVertex is automatically considered to be TRUE.

The slice can be colored using a scalar set defined in the colorScalarSetId inherited field. This is an index into the list of scalar sets existing in the traversal state (see the MoScalarSetxxx nodes). To disable coloring set this field to -1. Rendering can be modified using various property nodes (see the SEE ALSO section).

An MoMeshLogicalSlice is extracted along one face of each cell and so has no "thickness" along the slice axis. MoMeshInterpolatedLogicalSlice is similar, but instead of displaying the slice only on the face of the cells, it can interpolate a slice inside cells. MoMeshSlab is related, but extracts all visible faces from a row of cells with the same index in the given dimension I, J or K.

FILE FORMAT/DEFAULT

colorScalarSetId	0
parallel	TRUE
sliceIndex	0
sliceAxis	MiMesh::Dimension::I
upperVertex	FALSE

Constructor & Destructor Documentation

◆ MoMeshLogicalSlice()

MoMeshLogicalSlice::MoMeshLogicalSlice ( )

Constructor.

Member Function Documentation

◆ getClassTypeId()

static SoType MoMeshLogicalSlice::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getCurvilinearExtractor()

const MiLogicalSliceExtractCurvilinear * MoMeshLogicalSlice::getCurvilinearExtractor ( )

◆ getHexahedronIjkExtractor()

const MiLogicalSliceExtractHexahedronIjk * MoMeshLogicalSlice::getHexahedronIjkExtractor ( )

◆ getRectilinearExtractor()

const MiLogicalSliceExtractRectilinear * MoMeshLogicalSlice::getRectilinearExtractor ( )

◆ getRegularExtractor()

const MiLogicalSliceExtractRegular * MoMeshLogicalSlice::getRegularExtractor ( )

Get extractor 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 render action has been called before. Use the method corresponding to the type of mesh stored in the scene graph.

◆ getTypeId()

virtual SoType MoMeshLogicalSlice::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from MoMeshSurfaceRepresentation.

◆ getUnstructuredIjkExtractor()

SoDEPRECATED const MiLogicalSliceExtractHexahedronIjk * MoMeshLogicalSlice::getUnstructuredIjkExtractor ( )

Member Data Documentation

◆ SLICE_I

SoDEPRECATED const MiMesh::Dimension MoMeshLogicalSlice::SLICE_I = MiMesh::DIMENSION_I

static

Slice at I constant.

Definition at line 155 of file MoMeshLogicalSlice.h.

◆ SLICE_J

SoDEPRECATED const MiMesh::Dimension MoMeshLogicalSlice::SLICE_J = MiMesh::DIMENSION_J

static

Slice at J constant.

Definition at line 158 of file MoMeshLogicalSlice.h.

◆ SLICE_K

SoDEPRECATED const MiMesh::Dimension MoMeshLogicalSlice::SLICE_K = MiMesh::DIMENSION_K

static

Slice at K constant.

Definition at line 161 of file MoMeshLogicalSlice.h.

◆ sliceAxis

SoSFEnum MoMeshLogicalSlice::sliceAxis

The dimension along which the logical slice will be computed defined by the MiMesh::Dimension enum.

Default is MiMesh::Dimension::I.

Definition at line 110 of file MoMeshLogicalSlice.h.

◆ sliceIndex

SoSFUInt32 MoMeshLogicalSlice::sliceIndex

Index of the slice to display.

Default is 0.

Definition at line 104 of file MoMeshLogicalSlice.h.

◆ upperVertex

SoSFBool MoMeshLogicalSlice::upperVertex

If FALSE (the default), displays the lower part of the cell, otherwise displays the upper part of the cell.

Definition at line 115 of file MoMeshLogicalSlice.h.

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

MeshVizXLM/mapping/nodes/MoMeshLogicalSlice.h

Open Inventor Release 2023.2.3

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Deprecated

Detailed Description

FILE FORMAT/DEFAULT

SEE ALSO

Constructor & Destructor Documentation

◆ MoMeshLogicalSlice()

Member Function Documentation

◆ getClassTypeId()

◆ getCurvilinearExtractor()

◆ getHexahedronIjkExtractor()

◆ getRectilinearExtractor()

◆ getRegularExtractor()

◆ getTypeId()

◆ getUnstructuredIjkExtractor()

Member Data Documentation

◆ SLICE_I

◆ SLICE_J

◆ SLICE_K

◆ sliceAxis

◆ sliceIndex

◆ upperVertex