#include <DbPolygonMesh.h>
Public Member Functions inherited from Detailed Description
This class represents PolygonMesh entities in an OdDbDatabase instance.
- See also
- TD_Db
- Remarks
- A PolygonMesh entity consists of a list of PolygonMeshVertex (coordinate) vertices describing a M x N array of vertices, defining a set of 3D faces.
M is the number vertices in a row, N is the number of vertices in a column. The first N vertices define the first column, the second N, the second column, etc.
The mesh may be closed in the M and/or N directions. A closed mesh is connected from the last row or column to the first.
- Remarks
- Never derive from this class.
<group OdDb_Classes>
Definition at line 76 of file DbPolygonMesh.h.
Constructor & Destructor Documentation
◆ OdDbPolygonMesh()
| OdDbPolygonMesh::OdDbPolygonMesh | ( | ) |
Member Function Documentation
◆ appendVertex()
| OdDbObjectId OdDbPolygonMesh::appendVertex | ( | OdDbPolygonMeshVertex * | pVertex, |
| OdDb::Vertex3dType | vType = OdDb::k3dSimpleVertex |
||
| ) |
Appends the specified vertex onto this PolygonMesh entity.
- Parameters
-
pVertex [in] Pointer to the vertex to append. vType [in] Vertex type.
- Returns
- Returns the Object ID of the appended vertex.
vType must be one of the following:
Value DXF 70 Description OdDb::k3dSimpleVertex 0 0x40 Standard vertex. OdDb::k3dControlVertex 1 0x10 Spline-fit or curve-fit control point. OdDb::k3dFitVertex 2 0x08 Spline-fit or curve-fit generated vertex.
◆ convertToPolyMeshType()
| void OdDbPolygonMesh::convertToPolyMeshType | ( | OdDb::PolyMeshType | polyMeshType | ) |
Uses surfaceFit() to convert mesh type of this PolygonMesh entity (DXF 75).
- Parameters
-
polyMeshType [in] PolygonMesh type.
- Remarks
- polyMeshType must be one of the following:
Value Description OdDb::kSimpleMesh 0 Simple Mesh OdDb::kQuadSurfaceMesh 5 Quadratic B-spline fitting OdDb::kCubicSurfaceMesh 6 Cubic B-spline fitting OdDb::kBezierSurfaceMesh 8 Bezier Surface fitting
◆ dwgInFields()
|
virtual |
Reads the .dwg file data of this object.
- Parameters
-
pFiler [in] Filer object from which data are read.
- Returns
- Returns the filer status.
This function is called by dwgIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dwgInFields(pFiler) returned. 4) Call the OdDbDwgFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbEntity.
◆ dwgOutFields()
|
virtual |
Writes the .dwg file data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are written.
- Remarks
This function is called by dwgIn() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dwgOutFields(pFiler). 3) Call the OdDbDwgFiler(pFiler) methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbEntity.
◆ dxfIn()
|
virtual |
Reads the DXF format data of this object from the specified filer.
- Parameters
-
pFiler [in] Pointer to the filer from which the data are to be read.
- Returns
- Returns the filer status.
This function calls this object's dxfInFields(pFiler), then loads any Xdata associated with this object.
Reimplemented from OdDbEntity.
◆ dxfInFields()
|
virtual |
Reads the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer from which data are read.
- Returns
- Returns the filer status.
This function is called by dxfIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfInFields(pFiler) returned. 4) Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbEntity.
◆ dxfInFields_R12()
|
virtual |
Reads the DXF R12 format data of this object.
- Parameters
-
pFiler [in] Pointer to the filer from which data are to be read.
- Returns
- Returns the filer status.
This function is called by dxfIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dxfInFields_R12(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfOutFields_R12(pFiler) returned. 4) Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbEntity.
◆ dxfOut()
|
virtual |
Writes the DXF format data of this object to the specified filer.
- Parameters
-
pFiler [in] Pointer to the filer to which the data are to be written.
- Remarks
- This function calls this object's dxfOutFields(pFiler) function, writes any Xdata associated with this object.
Reimplemented from OdDbEntity.
◆ dxfOutFields()
|
virtual |
Writes the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are to be written.
- Remarks
This function is called by dxfOut() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dxfOutFields(pFiler). 4) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbEntity.
◆ dxfOutFields_R12()
|
virtual |
Writes the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are to be written.
- Returns
- Returns the filer status.
This function is called by dxfOut() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dxfOutFields(pFiler). 3) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbEntity.
◆ explodeGeometry()
|
virtual |
- Remarks
- Creates and returns a set of OdDbFace entities.
Reimplemented from OdDbEntity.
◆ getPlane()
|
virtual |
Returns the plane that contains this entity.
- Parameters
-
plane [out] Receives the plane that contains this entity. planarity [out] Receives the planarity of this entity.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
planarity and plane return values as follows::
Value Description plane kNonPlanar 0 Non-planar Not set kPlanar 1 Planar Entity plane kLinear 2 Linear Arrbitrary plane containing this entity
Reimplemented from OdDbEntity.
◆ isMClosed()
| bool OdDbPolygonMesh::isMClosed | ( | ) | const |
Returns true if and only if this PolygonMesh entity is closed in the M direction (DXF 70, bit 0x01).
◆ isNClosed()
| bool OdDbPolygonMesh::isNClosed | ( | ) | const |
Returns true if and only if this PolygonMesh entity is closed in the N direction (DXF 70, bit 0x20).
◆ isPlanar()
|
virtual |
Returns true if and only if this entity is planar.
Reimplemented from OdDbEntity.
◆ makeMClosed()
| void OdDbPolygonMesh::makeMClosed | ( | ) |
Sets this PolygonMesh entity closed in the M direction (DXF 70, bit 0x01).
◆ makeMOpen()
| void OdDbPolygonMesh::makeMOpen | ( | ) |
Sets this PolygonMesh entity opened in the M direction (DXF 70, bit 0x01).
◆ makeNClosed()
| void OdDbPolygonMesh::makeNClosed | ( | ) |
Sets this PolygonMesh entity closed in the N direction (DXF 70, bit 0x20).
◆ makeNOpen()
| void OdDbPolygonMesh::makeNOpen | ( | ) |
Sets this PolygonMesh entity opened in the N direction (DXF 70, bit 0x20).
◆ mSize()
| OdInt16 OdDbPolygonMesh::mSize | ( | ) | const |
Returns the number of vertices in the M direction for this PolygonMesh entity (DXF 71).
◆ mSurfaceDensity()
| OdInt16 OdDbPolygonMesh::mSurfaceDensity | ( | ) | const |
Returns the M surface density for this PolygonMesh entity (DXF 73).
- Remarks
- This is the number of vertices in the M direction after a surfaceFit.
Used instead of M if polyMeshType() != OdDb::kSimpleMesh.
◆ nSize()
| OdInt16 OdDbPolygonMesh::nSize | ( | ) | const |
Returns the number of vertices in the N direction for this PolygonMesh entity (DXF 72).
◆ nSurfaceDensity()
| OdInt16 OdDbPolygonMesh::nSurfaceDensity | ( | ) | const |
Returns the N surface density for this PolygonMesh entity (DXF 74).
- Remarks
- This is the number of vertices in the N direction after a surfaceFit.
Used instead of N if polyMeshType() != OdDb::kSimpleMesh.
◆ ODDB_DECLARE_MEMBERS()
| OdDbPolygonMesh::ODDB_DECLARE_MEMBERS | ( | OdDbPolygonMesh | ) |
◆ openSequenceEnd()
| OdDbSequenceEndPtr OdDbPolygonMesh::openSequenceEnd | ( | OdDb::OpenMode | mode | ) |
Opens the OdDbSequenceEnd entity for this PolygonMesh entity.
- Parameters
-
mode [in] Mode in which to open the OdDbSequenceEnd entity.
- Returns
- Returns a SmartPointer to the newly opened OdDbSequenceEnd, or a null SmartPointer.
- Remarks
- This method is provided solely for applications that store XData on OdDbSequenceEnd entities; this is not recommended.
◆ openVertex()
| OdDbPolygonMeshVertexPtr OdDbPolygonMesh::openVertex | ( | OdDbObjectId | vertId, |
| OdDb::OpenMode | mode, | ||
| bool | openErasedOne = false |
||
| ) |
Opens a vertex owned by this PolygonMesh entity.
- Parameters
-
vertId [in] Object ID of vertex to be opened. mode [in] Mode in which to open the vertex. openErasedOne [in] If and only if true, erased objects will be opened.
- Returns
- Returns a SmartPointer to the opened object if successful, otherwise a null SmartPointer.
◆ polyMeshType()
| OdDb::PolyMeshType OdDbPolygonMesh::polyMeshType | ( | ) | const |
Returns the mesh type of this PolygonMesh entity (DXF 75).
- Remarks
- polyMeshType() returns one of the following:
Value Description OdDb::kSimpleMesh 0 Simple Mesh OdDb::kQuadSurfaceMesh 5 Quadratic B-spline fitting OdDb::kCubicSurfaceMesh 6 Cubic B-spline fitting OdDb::kBezierSurfaceMesh 8 Bezier Surface fitting
◆ setMSize()
Sets the number of vertices in the M direction for this PolygonMesh entity (DXF 71).
- Parameters
-
mSize [in] Number of vertices in M direction.
◆ setMSurfaceDensity()
Sets the M surface density for this PolygonMesh entity (DXF 73).
- Parameters
-
mSurfaceDensity [in] M surface density.
- Remarks
- This is the number of vertices in the M direction after a surfaceFit.
Used instead of M if polyMeshType() != OdDb::kSimpleMesh.
◆ setNSize()
Sets the number of vertices in the N direction for this PolygonMesh entity (DXF 72).
- Parameters
-
nSize [in] Number of vertices in N direction.
◆ setNSurfaceDensity()
Sets the M surface density for this PolygonMesh entity (DXF 74).
- Parameters
-
nSurfaceDensity [in] N surface density.
- Remarks
- This is the number of vertices in the N direction after a surfaceFit.
Used instead of N if polyMeshType() != OdDb::kSimpleMesh.
◆ setPolyMeshType()
| void OdDbPolygonMesh::setPolyMeshType | ( | OdDb::PolyMeshType | polyMeshType | ) |
Sets the mesh type of this PolygonMesh entity (DXF 75).
- Parameters
-
polyMeshType [in] PolygonMesh type.
- Remarks
- polyMeshType must be one of the following:
Value Description OdDb::kSimpleMesh 0 Simple Mesh OdDb::kQuadSurfaceMesh 5 Quadratic B-spline fitting OdDb::kCubicSurfaceMesh 6 Cubic B-spline fitting OdDb::kBezierSurfaceMesh 8 Bezier Surface fitting
◆ straighten()
| void OdDbPolygonMesh::straighten | ( | ) |
Removes all the surface fit vertices for this PolygonMesh entity.
◆ subClose()
|
virtual |
Called as the first operation as this object is being closed, for database -resident objects only.
- Remarks
- This function is notified just before the current open operation is to be closed, giving this function the ability to perform necessary operatons.
When overriding this function:
1) If the OdDbObject's state is incorrect, throw exception.
2) Call parent class's subClose().
3) If other actions are required before close, do them.
The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented from OdDbObject.
◆ subExplode()
|
virtual |
- Remarks
- Creates and returns a set of OdDbFace entities.
Reimplemented from OdDbEntity.
◆ subGetClassID()
Reimplemented from OdDbEntity.
◆ subGetGsMarkersAtSubentPath()
|
virtual |
Reimplemented from OdDbEntity.
◆ subGetSubentPathsAtGsMarker()
|
virtual |
Reimplemented from OdDbEntity.
◆ subTransformBy()
|
virtual |
Reimplemented from OdDbEntity.
◆ subWorldDraw()
|
virtual |
Reimplemented from OdDbEntity.
◆ surfaceFit() [1/2]
| void OdDbPolygonMesh::surfaceFit | ( | ) |
Surface fits a smooth surface to this PolygonMesh entity.
◆ surfaceFit() [2/2]
| void OdDbPolygonMesh::surfaceFit | ( | OdDb::PolyMeshType | surfType, |
| OdInt16 | surfU, | ||
| OdInt16 | surfV | ||
| ) |
Surface fits a smooth surface to this PolygonMesh entity.
- Parameters
-
surfType [in] Surface type (overrides SURFTYPE system variable). surfU [in] M Surface density (overrides SURFU system variable). surfV [in] N Surface density (overrides SURFV system variable.
- Remarks
- surfU and surfV will be in the range [2..200].
- surfType must be one of the following:
Value Description OdDb::kQuadSurfaceMesh 5 Quadratic B-spline fitting OdDb::kCubicSurfaceMesh 6 Cubic B-spline fitting OdDb::kBezierSurfaceMesh 8 Bezier Surface fitting
◆ vertexIterator()
| OdDbObjectIteratorPtr OdDbPolygonMesh::vertexIterator | ( | ) | const |
Returns an Iterator that can be used to traverse the vertices owned by this PolygonMesh entity.
The documentation for this class was generated from the following file: