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

MeshViz Rendering node that displays a clip line of a surface mesh. More...

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

+ Inheritance diagram for MoMeshClipLine:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 MoMeshClipLine ()
 Constructor.
 
const MiClipLineExtractUnstructuredgetUnstructuredExtractor ()
 Get extractor for reuse outside this node.
 
const MiClipLineExtractIjgetIjExtractor ()
 
- 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 MoMeshLineRepresentation
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

SoDEPRECATED SoSFPlane plane
 Position of the plane slice.
 
SoMFVec3f polyline
 Set of points defining a polyline to be projected on the 3D surface mesh.
 
SoSFVec3f direction
 Direction of the projection or normal to the plane if polyline contains a single point.
 
- 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 a clip line of a surface mesh.

A clip line is an unstructured line mesh defined by the intersection of several arbitrary planes with a surface mesh. Two types of clip line are possible:

  • a clip line is the projection along a direction of an input polyline onto a 3D surface mesh. This type of clip line requires at least 2 points in the polyline. The projected polyline follows the shape of the 3D surface.
    The ClipLine example highlights this first use case.

    Clip line
  • a clip line is the intersection of a plane and a 3D surface when the field polyline contains one single point. The plane is defined by the point of the polyline and its normal vector defined by direction. If the 3D surface is flat, the output clip line follows a straight line. If the 3D surface corresponds to the external skin of a volume, the clip line is a closed contour.
    The ClipLineOnSkin example highlights this second use case.

    Clip line on skin

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

FILE FORMAT/DEFAULT

    MeshClipLine {
    colorScalarSetId 0
    parallel TRUE
    plane 0,0,1,0
    polyline empty
    direction 1,0,0
    }

SEE ALSO

MoCellFilter, MoColorMapping, MoDrawStyle, MoMaterial,
MiClipLineExtractIj, MiClipLineExtractUnstructured, MoLineDetail

Definition at line 87 of file MoMeshClipLine.h.

Constructor & Destructor Documentation

◆ MoMeshClipLine()

MoMeshClipLine::MoMeshClipLine ( )

Constructor.

Member Function Documentation

◆ getClassTypeId()

static SoType MoMeshClipLine::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getIjExtractor()

const MiClipLineExtractIj * MoMeshClipLine::getIjExtractor ( )

◆ getTypeId()

virtual SoType MoMeshClipLine::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from MoMeshLineRepresentation.

◆ getUnstructuredExtractor()

const MiClipLineExtractUnstructured * MoMeshClipLine::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 traversal has occurred.

Member Data Documentation

◆ direction

SoSFVec3f MoMeshClipLine::direction

Direction of the projection or normal to the plane if polyline contains a single point.

This field is set to the x-axis direction by default.

NOTE: field available since Open Inventor 2023.1

Definition at line 120 of file MoMeshClipLine.h.

◆ plane

SoDEPRECATED SoSFPlane MoMeshClipLine::plane

Position of the plane slice.

Z=0 plane by default.

Definition at line 102 of file MoMeshClipLine.h.

◆ polyline

SoMFVec3f MoMeshClipLine::polyline

Set of points defining a polyline to be projected on the 3D surface mesh.

If this field contains a single point P, an intersection of the plane (P, direction) is extracted and rendered. This field is empty by default.

NOTE: field available since Open Inventor 2023.1

Definition at line 112 of file MoMeshClipLine.h.


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