Open Inventor Release 2024.1.0
 
Loading...
Searching...
No Matches
PoMeshLevelSurf Class Reference

MeshViz Representation of level surface of volume mesh. More...

#include <MeshViz/3Ddata/PoMeshLevelSurf.h>

+ Inheritance diagram for PoMeshLevelSurf:

Public Types

enum  SurfOrientation {
  ORIENTED_TO_MIN ,
  ORIENTED_TO_MAX
}
 Type of level surface orientation. More...
 
- Public Types inherited from PoMesh
enum  ColoringType {
  COLOR_INHERITED ,
  COLOR_AVERAGE ,
  COLOR_MAPPING ,
  COLOR_CONTOURING ,
  COLOR_TEXTURE_CONTOURING
}
 Coloring type. More...
 
- Public Types inherited from PoBase
enum  UpdateMethodType {
  UPDATE_METHOD_IMMEDIATE ,
  UPDATE_METHOD_ON_ACTION
}
 Type of update method. More...
 
enum  NodeWriteFormat {
  FOLD_NODE_WRITE_FORMAT ,
  UNFOLD_NODE_WRITE_FORMAT
}
 Type of write format. More...
 
enum  TextType {
  SO_TEXT3 ,
  SO_ANNO_TEXT3
}
 Type of Text. More...
 
typedef void PoRebuildCB(void *userData, PoBase *base)
 

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
virtual const SoNodekitCataloggetNodekitCatalog () const
 Returns the SoNodekitCatalog for this instance.
 
 PoMeshLevelSurf ()
 Constructor.
 
virtual void rebuild ()
 Forces node-kit rebuilding.
 
- Public Member Functions inherited from PoMesh3D
void setMesh (PbMesh3D *mesh)
 Defines the current volume mesh.
 
const PbMesh3DgetMesh () const
 Gets the current volume mesh.
 
- Public Member Functions inherited from PoMesh
void setMesh (PbMesh *mesh)
 Sets a reference to a PbMesh object.
 
void setDataMapping (PbDataMapping *data_mapping)
 Sets a reference to a PbDataMapping object for the association color-value.
 
void setModuleDataMapping (PbDataMapping *mod_data_mapping)
 Sets a reference to a PbDataMapping object for the association color-vectors module.
 
void setIsovaluesList (PbIsovaluesList *isovalues_list)
 Sets a reference to a PbIsovaluesList object to define a list of isovalues.
 
const PbMeshgetMesh () const
 Gets the current PbMesh object.
 
const PbDataMappinggetDataMapping () const
 Returns the current PbDataMapping object.
 
const PbDataMappinggetModuleDataMapping () const
 Returns the current PbDataMapping object for the association color-vectors module.
 
const PbIsovaluesListgetIsovaluesList () const
 Returns the current PbIsovaluesList object.
 
- Public Member Functions inherited from PoBase
void setUpdateMethod (UpdateMethodType type)
 Sets scene graph update method.
 
UpdateMethodType getUpdateMethod () const
 Gets update method.
 
void setDomain (PbDomain *dom)
 Sets a reference to a PbDomain object used to define the data limits of the graphics to be generated.
 
const PbDomaingetDomain () const
 Gets a reference to a PbDomain object used to define the data limits of the graphics to be generated.
 
void touchKit ()
 Indicates the node kit is modified.
 
SbBool isModified () const
 Return TRUE, if the kit has been modified, else otherwise.
 
SbBool isBuilt () const
 Indicates if the node kit has been built at least once.
 
void addPreRebuildCallback (PoRebuildCB *cb, void *data)
 Add a callback function to call when the node kit is rebuilt.
 
void addPostRebuildCallback (PoRebuildCB *cb, void *data)
 Add a callback function to call when the node kit is rebuilt.
 
void removePreRebuildCallback (PoRebuildCB *cb, void *data=NULL)
 Remove a callback function to call when the node kit is rebuilt.
 
void removePostRebuildCallback (PoRebuildCB *cb, void *data)
 Remove a callback function to call when the node kit is rebuilt.
 
virtual SoNodecopy (SbBool copyConnections=FALSE) const
 Copy method.
 
virtual SbBool affectsState () const
 See SoNode::affectsState() for explanations.
 
- Public Member Functions inherited from SoBaseKit
 SoBaseKit ()
 Constructor.
 
virtual SoNodegetPart (const SbName &partName, SbBool makeIfNeeded)
 Searches the nodekit catalog (and those of all nested nodekits) for the part named partName.
 
template<typename PartType >
PartType * getPart (const SbName &partName)
 Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to TRUE.
 
template<typename PartType >
PartType * checkPart (const SbName &partName)
 Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to FALSE.
 
SbString getPartString (const SoBase *part)
 Given a node or a path to a node, checks if the part exists in the nodekit, in a nested nodekit, or an element of a list part.
 
virtual SoNodeKitPathcreatePathToPart (const SbName &partName, SbBool makeIfNeeded, const SoPath *pathToExtend=NULL)
 Returns a path that begins at this nodekit and ends at partName.
 
virtual SbBool setPart (const SbName &partName, SoNode *newPart)
 Inserts the given node (not a copy) as the new part specified by partName.
 
SoNONUNICODE SbBool set (char *nameValuePairListString)
 This function allows field values of parts (nodes) to be set in several different parts simultaneously.
 
SbBool set (const SbString &nameValuePairListString)
 This function allows field values of parts (nodes) to be set in several different parts simultaneously.
 
SoNONUNICODE SbBool set (const char *partNameString, const char *parameterString)
 This function allows field values of parts (nodes) to be set.
 
SbBool set (const SbString &partNameString, const SbString &parameterString)
 This function allows field values of parts (nodes) to be set.
 
- 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 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.
 
- Public Member Functions inherited from SoGetView
 SoGetView ()
 Default constructor.
 
virtual ~SoGetView ()
 
virtual SbBool getViewportIsEnabled () const
 Returns TRUE if SoGetView functionalities are enabled, FALSE otherwise.
 
virtual const SbVec2f getViewportOrigin () const
 Returns SbViewportRegion origin.
 
virtual const SbVec2f getViewportSize () const
 Returns SbViewportRegion size.
 

Static Public Member Functions

static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static const SoNodekitCataloggetClassNodekitCatalog ()
 Returns the SoNodekitCatalog for this class.
 
- Static Public Member Functions inherited from PoMesh3D
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static const SoNodekitCataloggetClassNodekitCatalog ()
 Returns the SoNodekitCatalog for this class.
 
- Static Public Member Functions inherited from PoMesh
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static const SoNodekitCataloggetClassNodekitCatalog ()
 Returns the SoNodekitCatalog for this class.
 
- Static Public Member Functions inherited from Po3DdataMaster
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static const SoNodekitCataloggetClassNodekitCatalog ()
 Returns the SoNodekitCatalog for this class.
 
- Static Public Member Functions inherited from PoBase
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static const SoNodekitCataloggetClassNodekitCatalog ()
 Returns the SoNodekitCatalog for this class.
 
static void setNodeWriteFormat (NodeWriteFormat format)
 Sets the node write format.
 
static NodeWriteFormat getNodeWriteFormat ()
 Gets the node write format.
 
static void setTextType (TextType type)
 Sets the type of text used.
 
static TextType getTextType ()
 Gets the type of text used.
 
static void setVRML2Mode (SbBool flag)
 Set the VRML2 mode.
 
static SbBool isVRML2Mode ()
 Gets the VRML2 mode (TRUE = VRML2 mode, FALSE Inventor mode)
 
- Static Public Member Functions inherited from SoBaseKit
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static const SoNodekitCataloggetClassNodekitCatalog ()
 Returns the SoNodekitCatalog for the class SoBaseKit.
 
static void setSearchingChildren (SbBool newVal)
 Sets if nodekit children are searched during SoSearchAction traversal.
 
static SbBool isSearchingChildren ()
 Returns TRUE if nodekit children are searched during SoSearchAction traversal.
 
- 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

SoSFEnum surfOrientation
 Orientation of the level surface.
 
SoSFFloat levelValue
 Value of the level surface.
 
SoSFInt32 valuesIndexForLevel
 Index of the set of value used to compute the level surface.
 
- Public Attributes inherited from PoMesh
SoSFInt32 valuesIndex
 Defines the index of the set of values for the coloring.
 
SoSFInt32 valuesIndexForCellFilter
 Specifies the index of the set of values used to filter cells for this mesh representation.
 
SoSFInt32 vecsIndex
 Defines the index of the set of vectors for all representations which need a vector at each mesh node (PoBaseStreamLine, PoMesh2DVec, PoMesh3DVec,...)
 
SoSFEnum coloringType
 Defines the type of method used to color each mesh element, mesh edge or mesh contour line of a representation.
 
SoSFNode moduleDataMapping
 Field used to do coloring according the module of the vectors.
 
SoSFBool smoothTextureContouring
 If set to true and combined with COLOR_TEXTURE_CONTOURING coloring type, the texture used for coloring appears smoothed, since a linear interpolation is used instead of a nearest one.
 
SoSFFloat creaseAngle
 Indicates the minimum angle (in radians) between two adjacent face normals required to form a sharp crease at the edge when default normals are computed and used.
 
- Public Attributes inherited from SoBaseKit
SoSFBool boundingBoxIgnoring
 Whether to ignore this node during bounding box traversal.
 

Detailed Description

MeshViz Representation of level surface of volume mesh.

This class represents a 3D level surface of the current volume mesh. See PoMesh for more explanations about the current mesh.

The geometry of the level surface is defined by interpolation relating to the set of scalar values of which index is defined by the field valuesIndexForLevel. However, if valuesIndexForLevel = -1, the set of scalar values is the one of which index is PoMesh::valuesIndex. If this scalar value set does not exist in the current mesh, the representation is empty.

If the field PoMesh::valuesIndex is not defined (or if coloringType = COLOR_INHERITED), the representation uses only one inherited color. If the field PoMesh::valuesIndex is defined (and if coloringType != COLOR_INHERITED), the representation is colored by using the current data mapping applied to each mesh node value. (see PoMesh for more explanations about the current data-mapping).

NOTE : This class is not designed to build an isosurface with a "per cell" data set : When valuesIndexForLevel refers to a data set with a "PER_CELL" data binding (see PbMesh::DataBinding), the result is unpredictable. However, an isosurface can be built with a "PER_NODE" data set, and colored using a "PER_CELL" data set : when valuesIndexForLevel refers to a PER_NODE data set and valuesIndex refers to a PER_CELL data set, a valid isosurface is built.

The vector data of the mesh for this representation is unused.

The isosurface can be generated by using either a triangle strip set or an indexed face set depending on the preference variable SoPreference::OIV_3DDATA_USE_TRIANGLE_STRIP_SET

FILE FORMAT/DEFAULT

    PoMeshLevelSurf {
    levelValue 0.0
    surfOrientation ORIENTED_TO_MAX
    valuesIndexForLevel -1
    valuesIndex -1
    coloringType COLOR_INHERITED
    vecsIndex -1
    valuesIndexForCellFilter -1
    moduleDataMapping NULL
    }

    CATALOG PARTS

      PoMeshLevelSurf {
        Separator alternateRep (from PoBase) {
          AppearanceKit appearance (from PoBase)
          Specifies the appearance of all the kit. By default lightModel.model=PHONG. material.diffuseColor is set when the kit is rebuilt, if the field coloringType is different from COLOR_INHERITED.
          MatrixTransform domainTransform (from PoBase)
          Corresponds to the domain transformation.
            Group groupLevelSurf
            Contains an SoShapeHints property with creaseAngle = 0.0 and an SoCoordinate3 node followed by an indexed shape to draw the level surface of the mesh.
          }
        }

      Definition at line 92 of file PoMeshLevelSurf.h.

    Member Enumeration Documentation

    ◆ SurfOrientation

    Type of level surface orientation.

    Enumerator
    ORIENTED_TO_MIN 
    ORIENTED_TO_MAX 

    Definition at line 114 of file PoMeshLevelSurf.h.

    Constructor & Destructor Documentation

    ◆ PoMeshLevelSurf()

    PoMeshLevelSurf::PoMeshLevelSurf ( )

    Constructor.

    Member Function Documentation

    ◆ getClassNodekitCatalog()

    static const SoNodekitCatalog * PoMeshLevelSurf::getClassNodekitCatalog ( )
    static

    Returns the SoNodekitCatalog for this class.

    ◆ getClassTypeId()

    static SoType PoMeshLevelSurf::getClassTypeId ( )
    static

    Returns the type identifier for this class.


    ◆ getNodekitCatalog()

    virtual const SoNodekitCatalog * PoMeshLevelSurf::getNodekitCatalog ( ) const
    virtual

    Returns the SoNodekitCatalog for this instance.

    Reimplemented from PoMesh3D.

    ◆ getTypeId()

    virtual SoType PoMeshLevelSurf::getTypeId ( ) const
    virtual

    Returns the type identifier for this specific instance.

    Reimplemented from PoMesh3D.

    ◆ rebuild()

    virtual void PoMeshLevelSurf::rebuild ( )
    virtual

    Forces node-kit rebuilding.

    See PoBase.

    Reimplemented from PoBase.

    Member Data Documentation

    ◆ levelValue

    SoSFFloat PoMeshLevelSurf::levelValue

    Value of the level surface.

    Definition at line 138 of file PoMeshLevelSurf.h.

    ◆ surfOrientation

    SoSFEnum PoMeshLevelSurf::surfOrientation

    Orientation of the level surface.

    ORIENTED_TO_MIN: The facet normals of the level surface are oriented to the region of the mesh where the values are less than levelValue.

    ORIENTED_TO_MAX: The facet normals of the level surface are oriented to the region of the mesh where the values are greater than levelValue. These normal orientations are respected if each element of the mesh respects the orientation rules (see the definition of each type of mesh).

    Definition at line 133 of file PoMeshLevelSurf.h.

    ◆ valuesIndexForLevel

    SoSFInt32 PoMeshLevelSurf::valuesIndexForLevel

    Index of the set of value used to compute the level surface.

    If valuesIndexForLevel == -1, this index is defined by PoMesh::valuesIndex. -1 by default.

    Definition at line 145 of file PoMeshLevelSurf.h.


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