Open Inventor Release 2024.1.3
 
Loading...
Searching...
No Matches
PoMeshCrossSection Class Reference

MeshViz Representation of cross section of a volume mesh. More...

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

+ Inheritance diagram for PoMeshCrossSection:

Public Types

enum  CrossSectionMethod {
  DEFAULT ,
  ISOSURFACE ,
  INTERSECTION
}
 Specifies the method used to compute intersections. 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.
 
 PoMeshCrossSection ()
 Constructor.
 
virtual void rebuild ()
 Forces node-kit rebuilding.
 
void setCrossSectionMethod (CrossSectionMethod method=DEFAULT)
 Specifies the method used to build this shape.
 
- 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

SoSFPlane plane
 Position of the cross section.
 
- 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 cross section of a volume mesh.

Class to build a filled representation of a cross-section in a volume mesh.

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).

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

When using the ISOSURFACE mode, the cross section 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

    PoMeshCrossSection {
    plane Z=0 plane
    valuesIndex -1
    coloringType COLOR_INHERITED
    vecsIndex -1
    valuesIndexForCellFilter -1
    moduleDataMapping NULL
    }

    CATALOG PARTS

      PoMeshCrossSection {
        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 groupCrossSection
            Contains a SoQuadMesh shape for ParalCartesianGrid3D and RegularCartesianGrid3D meshes and when the cross section is perpendicular to the X, Y or Z axis,  an indexed   shape otherwise, to draw the cross section of the mesh.
          }
        }

      Definition at line 87 of file PoMeshCrossSection.h.

    Member Enumeration Documentation

    ◆ CrossSectionMethod

    Specifies the method used to compute intersections.

    See also
    setCrossSectionMethod().
    Enumerator
    DEFAULT 

    Depending on the mesh type the cross section is computed either like an isosurface or by doing classic intersection.

    Classic intersections are done for PbParalCartesianGrid3D and PbRegularCartesianGrid3D. An isosurface is computed for all other mesh types.

    ISOSURFACE 

    The cross section is computed like an isosurface.

    INTERSECTION 

    The cross section is computed by doing classic intersections Be careful, this method doesn't support cell filtering (PoCellFilter).

    Definition at line 117 of file PoMeshCrossSection.h.

    Constructor & Destructor Documentation

    ◆ PoMeshCrossSection()

    PoMeshCrossSection::PoMeshCrossSection ( )

    Constructor.

    Member Function Documentation

    ◆ getClassNodekitCatalog()

    static const SoNodekitCatalog * PoMeshCrossSection::getClassNodekitCatalog ( )
    static

    Returns the SoNodekitCatalog for this class.

    ◆ getClassTypeId()

    static SoType PoMeshCrossSection::getClassTypeId ( )
    static

    Returns the type identifier for this class.


    ◆ getNodekitCatalog()

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

    Returns the SoNodekitCatalog for this instance.

    Reimplemented from PoMesh3D.

    ◆ getTypeId()

    virtual SoType PoMeshCrossSection::getTypeId ( ) const
    virtual

    Returns the type identifier for this specific instance.

    Reimplemented from PoMesh3D.

    ◆ rebuild()

    virtual void PoMeshCrossSection::rebuild ( )
    virtual

    Forces node-kit rebuilding.

    See PoBase.

    Reimplemented from PoBase.

    ◆ setCrossSectionMethod()

    void PoMeshCrossSection::setCrossSectionMethod ( CrossSectionMethod  method = DEFAULT)
    inline

    Specifies the method used to build this shape.

    By default PoMeshCrossSection builds a shape by computing an isosurface on a non regular mesh. The node's data are the distances to the plane. This method is safe but it uses a significant amount of memory for each instance of PoMeshCrossSection.

    Calling setCrossSectionMethod(INTERSECTION) forces the use of the classic method. The classic method computes the shapes by intersecting each cell with the plane. However it can be risky as it assumes that each mesh's cell is convex and therefore that the intersection of a plane and a cell's face can produce only one edge. Using the classic method with concave faces may produce unpredictable results or an infinite loop.

    The environment variable OIV_3DDATA_CROSS_SECTION_METHOD can also be set to specify the method used to build this shape. It can take the values INTERSECTION or ISOSURFACE. However, calling setCrossSectionMethod overrides this environment variable.

    Parameters
    methodDEFAULT by default.

    Definition at line 155 of file PoMeshCrossSection.h.

    Member Data Documentation

    ◆ plane

    SoSFPlane PoMeshCrossSection::plane

    Position of the cross section.

    Z=0 plane by default.

    Definition at line 110 of file PoMeshCrossSection.h.


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