MoMeshCellShape Class Reference
[Representations]

Rendering node that displays a set of cells of a mesh More...

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

Inheritance diagram for MoMeshCellShape:

List of all members.

Classes
class	CellFilter
class	DisplayName
Public Member Functions
virtual SoType	getTypeId () const
	MoMeshCellShape ()
Static Public Member Functions
static SoType	getClassTypeId ()
Public Attributes
SoSFBool	inclusiveList
SoMFInt32	cellIndices
SoSFFloat	factor
SoSFBool	showCellName
SoSFBool	showNodeName
SoSFFloat	offset
SoSFBool	relativeOffset
Friends
class	MdLineCellExtract
const MiCellExtractUnstructured *	getUnstructuredExtractor ()
const MiCellExtractHexahedronIjk *	getHexahedronIjkExtractor ()
const MiCellExtractIjk *	getIjkExtractor ()
const MiCellExtractIj *	getIjExtractor ()
Deprecated
SoDEPRECATED const MiCellExtractHexahedronIjk *	getUnstructuredIjkExtractor ()
SoDEPRECATED const MiCellExtractIjk *	getRegularExtractor ()
SoDEPRECATED const MiCellExtractIj *	getSurfaceRegularExtractor ()

---

Detailed Description

Rendering node that displays a set of cells of a mesh

This node renders an unstructured surface mesh defined by a set of cells in the original mesh. The set of cells to be rendered is specified by a list of cell indices. The size of the rendered cells can be scaled up or down using the scaleFactor field and annotation of the cell and node names can optionally be displayed.

The cell name annotation is defined in the following way:

• If an MoStringSet node is inherited in the scene graph with the suitable type and PER_CELL binding, the cell name is defined by the string returned by MiStringSetI::get or MiStringSetIj::get or MiStringSetIjk::get. The suitable type depends on the mesh type handled by the inherited MoMesh instance. For instance if the MoMesh handles an unstructured mesh (see MiVolumeMeshUnstructured and MiSurfaceMeshUnstructured) a suitable string set as cell name is of type MiStringSetI. If the MoMesh handles an MiVolumeMeshHexahedronIjk, a suitable string set as cell name is of type MiStringSetIjk. If several MoStringSet are inherited with the suitable string set type and PER_CELL binding, the last one on the state list is used.

• If no suitable MoStringSet is inherited in the scene graph, the cell name is defined by the string corresponding to the serialization of its cell ids. For Ij or Ijk mesh type the ij or ijk ids are separated by commas.

The node name annotation is defined in the same way but the suitable binding is obviously PER_NODE.

The cells 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.

FILE FORMAT/DEFAULT

MeshCellShape {

colorScalarSetId	0
parallel	TRUE
inclusiveList	TRUE
cellIndices	0
scaleFactor	1.0
showCellName	FALSE
showNodeName	FALSE

}

SEE ALSO

MiCellExtractUnstructured, MiCellExtractHexahedronIjk, MiCellExtractIjk, MiCellExtractIj

See related examples:

TessellatedPolyhedralMesh, CellShape, CellShapeConnectedFromSkin, TutorialPicking2, TutorialPicking3, TutorialPicking4, TutorialPicking5, TutorialPicking6, TutorialPicking7, TutorialPicking8, TutorialPicking9

---

Constructor & Destructor Documentation

MoMeshCellShape::MoMeshCellShape

(

)

Constructor.

---

Member Function Documentation

static SoType MoMeshCellShape::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from MoMeshSurfaceRepresentation.

const MiCellExtractHexahedronIjk* MoMeshCellShape::getHexahedronIjkExtractor

(

)

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 traversed the scene graph. Use the method corresponding to the type of mesh stored in the scene graph.

const MiCellExtractIj* MoMeshCellShape::getIjExtractor

(

)

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 traversed the scene graph. Use the method corresponding to the type of mesh stored in the scene graph.

const MiCellExtractIjk* MoMeshCellShape::getIjkExtractor

(

)

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 traversed the scene graph. Use the method corresponding to the type of mesh stored in the scene graph.

SoDEPRECATED const MiCellExtractIjk* MoMeshCellShape::getRegularExtractor

(

)

Deprecated:

Deprecated since Open Inventor 8500
Use getIjkExtractor() instead.

SoDEPRECATED const MiCellExtractIj* MoMeshCellShape::getSurfaceRegularExtractor

(

)

Deprecated:

Deprecated since Open Inventor 8500
Use getIjExtractor() instead.

virtual SoType MoMeshCellShape::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from MoMeshSurfaceRepresentation.

const MiCellExtractUnstructured* MoMeshCellShape::getUnstructuredExtractor

(

)

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 traversed the scene graph. Use the method corresponding to the type of mesh stored in the scene graph.

SoDEPRECATED const MiCellExtractHexahedronIjk* MoMeshCellShape::getUnstructuredIjkExtractor

(

)

Deprecated:

Deprecated since Open Inventor 10000
Use getHexahedronIjkExtractor() instead.

---

Friends And Related Function Documentation

friend class MdLineCellExtract [friend]

---

Member Data Documentation

SoMFInt32 MoMeshCellShape::cellIndices

Field representing the list of cells given by their index in the mesh.

If the mesh is unstructured, each value of cellIndices represents one cell.
If the mesh is a structured surface mesh, each cell is defined by a pair of indices (cellIndices(i),cellIndices(i+1)).
If the mesh is a structured volume mesh, each cell is defined by three indices (cellIndices(i),cellIndices(i+1),cellIndices(i+2)).
So, depending on the type of mesh, one, two or three indices are necessary to define each cell.

Note:

If the index list is empty, no cells are displayed when inclusiveList is set to TRUE and all cells otherwise. Default is empty.

SoSFFloat MoMeshCellShape::factor

Field representing the factor to resize extracted cells.

A factor lower than one will shrink cells, whereas a factor greater than one will expand cells.
Default is 1.0, which will not resize cells.

SoSFBool MoMeshCellShape::inclusiveList

When set to TRUE, the cellIndices field will represent the list of cells to display and the list of cells to exclude otherwise.

Default is TRUE.

SoSFFloat MoMeshCellShape::offset

Field representing the distance to shift the display of node names away from the node coordinates.

A negative offset will display node names inside the cell, whereas a positive offset will display them outside the cell.

Note:

The offset is relative to the cell's size if the relativeOffset field is set to TRUE. Otherwise it represents an absolute distance. Default is 0.1, which will slightly shift node names outside the cell.

SoSFBool MoMeshCellShape::relativeOffset

When set to TRUE, the distance between the node and the name to display is relative to the size of the cell
.

Note:

For unstructured meshes, the offset field is then multiplied by the getRelativeSize() method from the cell interface. A default implementation of getRelativeSize() returns 1 which will leave the offset as an absolute distance. getRelativeSize() needs to be overloaded to activate this feature for unstructured mesh (see class MiCell). Default is FALSE.

SoSFBool MoMeshCellShape::showCellName

When set to TRUE, the cell's name is displayed near the cell.

Default is FALSE.
The documentation of the class MoMeshCellShape describes how the cell's name is defined.

SoSFBool MoMeshCellShape::showNodeName

When set to TRUE, the node's names are displayed near the cell.

Default is FALSE.
The documentation of the class MoMeshCellShape describes how the node's name is defined.

---

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

• MeshVizXLM/mapping/nodes/MoMeshCellShape.h