Open Inventor Release 2024.1.2
 
Loading...
Searching...
No Matches
MoMeshSkin Class Reference

MeshViz Rendering node that displays the skin of a volume mesh. More...

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

+ Inheritance diagram for MoMeshSkin:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 MoMeshSkin ()
 Constructor.
 
const MiSkinExtractUnstructuredgetUnstructuredExtractor ()
 Get extractor for reuse outside this node.
 
const MiSkinExtractHexahedronIjkgetHexahedronIjkExtractor ()
 
const MiSkinExtractIjkgetIjkExtractor ()
 
Deprecated
SoDEPRECATED const MiSkinExtractHexahedronIjkgetUnstructuredIjkExtractor ()
 
- 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 SoNodecopy (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 SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (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 SoNodegetByName (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

SoMFUInt32 minCellRanges
 Minimum cell index values for extracting the mesh skin to display.
 
SoMFUInt32 maxCellRanges
 Maximum cell index values for extracting the mesh skin to display.
 
- 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.
 

Detailed Description

MeshViz Rendering node that displays the skin of a volume mesh.

The skin of a mesh is an unstructured surface mesh made up of all the faces that belong to only one cell.

The mesh 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 MoScalarSet node). To disable coloring set this field to -1.

Rendering can be modified using various property nodes (see the SEE ALSO section).

  • MoCellFilter specifies an optional cell filter to exclude cells from the skin.
  • MoDrawStyle controls the visibility of faces, edges and vertices in the rendering.
  • MoMaterial controls whether faces, edges and vertices are drawn with a single color or colored according to a scalar set. It also specifies the color for single color faces, edges and vertices.
  • MoColorMapping subclasses specify the mapping from scalar values to color and opacity.

The skin can be extracted for a subset of the mesh using the minCellRanges and/or maxCellRanges fields.

FILE FORMAT/DEFAULT

    MeshSkin {
    colorScalarSetId 0
    parallel TRUE
    minCellRanges empty
    maxCellRanges empty
    }

SEE ALSO

MoCellFilter, MoColorMapping, MoDrawStyle, MoMaterial, MoScalarSet,
MiSkinExtractIjk, MiSkinExtractUnstructured, MiSkinExtractHexahedronIjk, MoFaceDetail

Definition at line 80 of file MoMeshSkin.h.

Constructor & Destructor Documentation

◆ MoMeshSkin()

MoMeshSkin::MoMeshSkin ( )

Constructor.

Member Function Documentation

◆ getClassTypeId()

static SoType MoMeshSkin::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getHexahedronIjkExtractor()

const MiSkinExtractHexahedronIjk * MoMeshSkin::getHexahedronIjkExtractor ( )

◆ getIjkExtractor()

const MiSkinExtractIjk * MoMeshSkin::getIjkExtractor ( )

◆ getTypeId()

virtual SoType MoMeshSkin::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from MoMeshSurfaceRepresentation.

◆ getUnstructuredExtractor()

const MiSkinExtractUnstructured * MoMeshSkin::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 been called before.

◆ getUnstructuredIjkExtractor()

SoDEPRECATED const MiSkinExtractHexahedronIjk * MoMeshSkin::getUnstructuredIjkExtractor ( )

Member Data Documentation

◆ maxCellRanges

SoMFUInt32 MoMeshSkin::maxCellRanges

Maximum cell index values for extracting the mesh skin to display.

This field is empty by default.

  • If the field is empty, the skin extraction runs up to the last cell of the mesh.
  • If the mesh is unstructured, a single value specifies the index of the last cell index to use.
  • If the mesh is a structured volume mesh, three values specify the last I, J and K cell indices to use.
    (In this case, if less than three values are provided, the field is ignored.)

Definition at line 109 of file MoMeshSkin.h.

◆ minCellRanges

SoMFUInt32 MoMeshSkin::minCellRanges

Minimum cell index values for extracting the mesh skin to display.

This field is empty by default.

  • If the field is empty, the skin extraction starts from the first cell of the mesh.
  • If the mesh is unstructured, a single value specifies the index of the first cell index to use.
  • If the mesh is a structured volume mesh, three values specify the first I, J and K cell indices to use.
    (In this case, if less than three values are provided, the field is ignored.)

Definition at line 99 of file MoMeshSkin.h.


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