MoMeshClipLine Class Reference
[Representations]
Rendering node that displays a clip line of a surface mesh.
More...
#include <MeshVizXLM/mapping/nodes/MoMeshClipLine.h>
Public Member Functions | |
| virtual SoType | getTypeId () const |
| MoMeshClipLine () | |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
Public Attributes | |
| SoDEPRECATED SoSFPlane | plane |
| SoMFVec3f | polyline |
| SoSFVec3f | direction |
|
| |
| const MiClipLineExtractUnstructured * | getUnstructuredExtractor () |
| const MiClipLineExtractIj * | getIjExtractor () |
Detailed Description
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
- See related examples:
Constructor & Destructor Documentation
| MoMeshClipLine::MoMeshClipLine | ( | ) |
Constructor.
Member Function Documentation
| static SoType MoMeshClipLine::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from MoMeshLineRepresentation.
| const MiClipLineExtractIj* MoMeshClipLine::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 traversal has occurred.
| virtual SoType MoMeshClipLine::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Reimplemented from MoMeshLineRepresentation.
| 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 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| SoDEPRECATED SoSFPlane MoMeshClipLine::plane |
Position of the plane slice.
Z=0 plane by default.
- Deprecated:
-
Deprecated since Open Inventor 2023.1
Use polyline and direction fields instead to define a plane.
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.1The documentation for this class was generated from the following file:
- MeshVizXLM/mapping/nodes/MoMeshClipLine.h