#include <DbSubDMesh.h>
Inheritance diagram for OdDbSubDMesh:
Public Member Functions inherited from Detailed Description
This class represents SubDMesh entities in an OdDbDatabase instance.
<group OdDb_Classes>
Definition at line 50 of file DbSubDMesh.h.
Constructor & Destructor Documentation
◆ OdDbSubDMesh()
| OdDbSubDMesh::OdDbSubDMesh | ( | ) |
The default constructor.
Member Function Documentation
◆ clearVertexColorArray()
| OdResult OdDbSubDMesh::clearVertexColorArray | ( | ) |
Clears the array of vertex colors.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ clearVertexNormalArray()
| OdResult OdDbSubDMesh::clearVertexNormalArray | ( | ) |
Clears the array of vertex normals.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ clearVertexTextureArray()
| OdResult OdDbSubDMesh::clearVertexTextureArray | ( | ) |
Clears the array of vertex textures.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ computeRayIntersection()
| OdResult OdDbSubDMesh::computeRayIntersection | ( | const OdGePoint3d & | rayStart, |
| const OdGeVector3d & | rayDir, | ||
| OdArray< OdDbSubentId > & | retSubents, | ||
| OdArray< double > & | retIntersectDist, | ||
| OdGePoint3dArray & | retIntersectPoint | ||
| ) | const |
Calculates an array of indices of all faces of current SubDMash entity that are intersected by a specified ray. Also the method returns two additional arrays containing the intersection points for each face and distances between the start point of the ray and intersection points.
- Parameters
-
rayStart [in] Start point of the ray. rayDir [in] Ray direction. retSubents [out] Array of indices of faces intersected by the ray. retIntersectDist [out] Array of distances between the start point of the ray and the intersection point for intersected subentities. retIntersectPoint [out] The array of intersection points for intersected subentities.
- Returns
- A value of the OdResult type containing the result of the method execution.
◆ computeSurfaceArea()
| OdResult OdDbSubDMesh::computeSurfaceArea | ( | double & | retSurfArea | ) | const |
Calculates the current surface area of a mesh.
- Parameters
-
retSurfArea [out] Surface area of the mesh.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ computeVolume()
| OdResult OdDbSubDMesh::computeVolume | ( | double & | retVolume | ) | const |
Calculates the current volume of a watertight mesh.
- Parameters
-
retVolume [out] Receives the volume of the mesh.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ convertToSolid()
| OdResult OdDbSubDMesh::convertToSolid | ( | bool | bConvertAsSmooth, |
| bool | optimize, | ||
| OdDb3dSolidPtr & | pSolid | ||
| ) | const |
Creates a new OdDb3dSolid object from this mesh.
- Parameters
-
bConvertAsSmooth [in] Specify true for converting to a smooth surface, or false for converting to a faceted surface. optimize [in] Specify true for converting as an optimized surface, or false otherwise. pSolid [out] Pointer to the newly created OdDb3dSolid object.
- Returns
Value Description eNotImplementedYet The method is not implemented yet for the current modeler. eInvalidContext The mesh is empty. eInvalidInput The mesh has self-intersections or zero area faces or the mesh does not form a closed volume. eOk 3dSolid created successfully.
- Remarks
- The mesh should not have self-intersections and zero area faces and should form a closed volume. The case when bConvertAsSmooth == true or optimize == true is not implemented yet.
◆ convertToSurface() [1/2]
| OdResult OdDbSubDMesh::convertToSurface | ( | bool | bConvertAsSmooth, |
| bool | optimize, | ||
| OdDbSurfacePtr & | pSurface | ||
| ) | const |
Creates a new OdDbSurface object from this mesh.
- Parameters
-
bConvertAsSmooth [in] Specify true for converting to a smooth surface, or false for converting to a faceted surface. optimize [in] Specify true for converting as an optimized surface, or false otherwise. pSurface [out] Pointer to the newly created OdDbSurface object.
- Returns
Value Description eNotImplementedYet The method is not implemented yet for the current modeler. eInvalidContext The mesh is empty. eInvalidInput The mesh has self-intersections or zero area faces. eOk The surface created successfully.
- Remarks
- The mesh should not have self-intersections and zero area faces. The case when bConvertAsSmooth == true or optimize == true is not implemented yet.
◆ convertToSurface() [2/2]
| OdResult OdDbSubDMesh::convertToSurface | ( | bool | bConvertAsSmooth, |
| const OdDbSubentId & | id, | ||
| OdDbSurfacePtr & | pSurface | ||
| ) | const |
Creates a new OdDbSurface object from a part of this mesh by the specified sub-entity ID.
- Parameters
-
bConvertAsSmooth [in] Specify true for converting to a smooth surface, or false for converting to a faceted surface. id [in] Sub-entity ID to convert. pSurface [out] Pointer to the newly created OdDbSurface object.
- Returns
Value Description eNotImplementedYet The method is not implemented yet for the current modeler. eInvalidContext The mesh is empty. eInvalidInput ID is not kFaceSubentType or the mesh has self-intersections or zero area faces. eOk The surface created successfully.
- Remarks
- The mesh should not have self-intersections and zero area faces. The case when bConvertAsSmooth == true is not implemented yet.
◆ decomposeForSave()
|
virtual |
Determines the behavior for custom objects when saving to .dwg or .dxf file.
- Parameters
-
ver [in] Drawing version to save as. replaceId [out] Object ID of the object replacing this object. exchangeXData [out] Set to true if and only if this function did not add XData to the replacement object.
- Remarks
- This function either
Returns an OdDbObjectPtr for a non- database -resident (NDBRO) replacement object, setting replaceId to OdDbObjectId::kNull. Returns NULL, setting replaceId for a database -resident (DBRO) replacement object.
Custom objects can decompose themselves into other objects, adding additional XData as required. The Drawings transfers XData from this object to the replacement object if and only if exchangeXData is true.
The default implementation returns NULL and sets replaceId to OdDbObjectId::kNull. This function can be overridden in custom classes.
The method is not intended to be called by client code. For processing owned objects use convertForSave() method.
Reimplemented from OdDbObject.
◆ 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.
◆ 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.
◆ 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.
◆ extrudeConnectedFaces()
| OdResult OdDbSubDMesh::extrudeConnectedFaces | ( | const OdDbFullSubentPathArray & | subentPaths, |
| double | length, | ||
| const OdGeVector3d & | dir, | ||
| double | taper | ||
| ) |
Extrudes connected faces along the given direction and with a given taper angle.
- Parameters
-
subentPaths [in] Array of faces to be extruded. length [in] Length of extrusion. dir [in] Direction of extrusion. taper [in] Taper angle of extrusion.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ extrudeFaces() [1/2]
| OdResult OdDbSubDMesh::extrudeFaces | ( | const OdDbFullSubentPathArray & | subentPaths, |
| const OdGePoint3dArray & | alongPath, | ||
| double | taper | ||
| ) |
Extrudes faces along the given direction and with a given taper angle.
- Parameters
-
subentPaths [in] Array of faces to be extruded. alongPath [in] Array of points, which describes the path, along which the faces will be extruded. taper [in] Taper angle of extrusion.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ extrudeFaces() [2/2]
| OdResult OdDbSubDMesh::extrudeFaces | ( | const OdDbFullSubentPathArray & | subentPaths, |
| double | length, | ||
| const OdGeVector3d & | dir, | ||
| double | taper | ||
| ) |
Extrudes faces along the given direction and with a given taper angle.
- Parameters
-
subentPaths [in] Array of faces to be extruded. length [in] Length of extrusion. dir [in] Direction of extrusion. taper [in] Taper angle of extrusion.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ getAdjacentSubentPath()
| OdResult OdDbSubDMesh::getAdjacentSubentPath | ( | const OdDbFullSubentPath & | path, |
| OdDb::SubentType | type, | ||
| OdDbFullSubentPathArray & | subentPaths | ||
| ) | const |
Retrieves subentities adjacent to a given one.
- Parameters
-
path [in] Original subentity. type [in] Type of subentities to be returned. subentPaths [out] Array of subentities adjacent to the original one.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ getCrease() [1/2]
| OdResult OdDbSubDMesh::getCrease | ( | const OdDbFullSubentPathArray & | subentPaths, |
| OdDoubleArray & | result | ||
| ) | const |
Retrieves crease values for mesh subentities.
- Parameters
-
subentPaths [in] Array of mesh subentities. result [out] Receives an array of crease values.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ getCrease() [2/2]
| OdResult OdDbSubDMesh::getCrease | ( | const OdDbSubentId & | id, |
| double & | result | ||
| ) | const |
Retrieves the crease value for a mesh subentity via its ID.
- Parameters
-
id [in] Subentity ID. result [out] Receives the crease value.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ getEdgeArray()
| OdResult OdDbSubDMesh::getEdgeArray | ( | OdInt32Array & | edgeArray | ) | const |
Retrieves the base level edges.
- Parameters
-
edgeArray [out] Receives an array of the base level edges.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ getFaceArray()
| OdResult OdDbSubDMesh::getFaceArray | ( | OdInt32Array & | faceArray | ) | const |
Retrieves the base level faces.
- Parameters
-
faceArray [out] Receives an array of the base level faces.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ getFacePlane()
| OdResult OdDbSubDMesh::getFacePlane | ( | const OdDbSubentId & | id, |
| OdGePlane & | facePlane | ||
| ) | const |
Retrieves the face plane of a given face.
- Parameters
-
id [in] ID of the face. facePlane [out] Receives the face plane of the given face.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ getNormalArray()
| OdResult OdDbSubDMesh::getNormalArray | ( | OdGeVector3dArray & | normalArray | ) | const |
Calculates normals for all vertices of the current SubDMash entity.
- Parameters
-
normalArray [out] Receives an array of normals.
- Returns
- A value of the OdResult type containing the result of the method execution.
- Remarks
- The normal for a vertex is calculated as the average of all normals for the faces that include the vertex. This method assumes that the smoothness level is zero.
◆ getSubDividedData() [1/2]
| OdResult OdDbSubDMesh::getSubDividedData | ( | OdGePoint3dArray & | vertexArray, |
| OdInt32Array & | edgeArray, | ||
| OdInt32Array & | faceArray | ||
| ) | const |
◆ getSubDividedData() [2/2]
| OdResult OdDbSubDMesh::getSubDividedData | ( | OdGePoint3dArray & | vertexArray, |
| OdInt32Array & | edgeArray, | ||
| OdInt32Array & | faceArray, | ||
| OdGeDoubleArray & | newCreases, | ||
| OdUInt32Array & | edgeData | ||
| ) | const |
◆ getSubDividedEdgeArray()
| OdResult OdDbSubDMesh::getSubDividedEdgeArray | ( | OdInt32Array & | edgeArray | ) | const |
◆ getSubDividedFaceArray()
| OdResult OdDbSubDMesh::getSubDividedFaceArray | ( | OdInt32Array & | faceArray | ) | const |
Retrieves the faces for a smoothened mesh.
- Parameters
-
faceArray [out] Receives an array of the faces.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ getSubDividedNormalArray()
| OdResult OdDbSubDMesh::getSubDividedNormalArray | ( | OdGeVector3dArray & | normalArray | ) | const |
Calculates normals for all vertices of the current SubDMash entity taking into account the level of smoothing.
- Parameters
-
normalArray [out] Receives an array of normals.
- Returns
- A value of the OdResult type containing the result of the method execution.
- Remarks
- The normal for a vertex is calculated as the average of all normals for the faces that include the vertex. This method takes into account the level of smoothness, which can take any value from 0 to 4.
◆ getSubDividedVertexAt() [1/2]
| OdResult OdDbSubDMesh::getSubDividedVertexAt | ( | const OdDbSubentId & | id, |
| OdGePoint3d & | vertex | ||
| ) | const |
Retrieves a vertex of a smooth mesh using the given subentity ID.
- Parameters
-
id [in] Subentity ID of the vertex. vertex [out] Receives the vertex.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ getSubDividedVertexAt() [2/2]
| OdResult OdDbSubDMesh::getSubDividedVertexAt | ( | OdInt32 | nIndex, |
| OdGePoint3d & | vertex | ||
| ) | const |
Retrieves a vertex of a smooth mesh using the given index.
- Parameters
-
nIndex [in] Index of the vertex. vertex [out] Receives the vertex.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ getSubDividedVertices()
| OdResult OdDbSubDMesh::getSubDividedVertices | ( | OdGePoint3dArray & | vertexArray | ) | const |
Retrieves the vertices for a smoothened mesh.
- Parameters
-
vertexArray [out] Receives an array of the vertices.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ getSubentColor()
| OdResult OdDbSubDMesh::getSubentColor | ( | const OdDbSubentId & | id, |
| OdCmColor & | color | ||
| ) | const |
Retrieves the color of a given subentity.
- Parameters
-
id [in] ID of the subentity. color [out] Receives the color of the subentity.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ getSubentMaterial()
| OdResult OdDbSubDMesh::getSubentMaterial | ( | const OdDbSubentId & | id, |
| OdDbObjectId & | material | ||
| ) | const |
Retrieves the material of a given subentity.
- Parameters
-
id [in] ID of the subentity. material [out] Receives the material of the subentity.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ getSubentMaterialMapper()
| OdResult OdDbSubDMesh::getSubentMaterialMapper | ( | const OdDbSubentId & | id, |
| OdGiMapper & | mapper | ||
| ) | const |
Retrieves the material mapper of a subentity.
- Parameters
-
id [in] ID of the subentity. mapper [out] Receives the material mapper of the subentity.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ getSubentPath()
| OdResult OdDbSubDMesh::getSubentPath | ( | OdInt32 | nIndex, |
| OdDb::SubentType | type, | ||
| OdDbFullSubentPathArray & | subentPaths | ||
| ) | const |
Retrieves all subentity paths by the specified index and subentity type.
- Parameters
-
nIndex [in] Subentity index. If it's equal to -1, then all subentities of the specified type will be returned as an array. type [in] Type of the input subentity. subentPaths [out] Array of subentities.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ getVertexAt() [1/2]
| OdResult OdDbSubDMesh::getVertexAt | ( | const OdDbSubentId & | id, |
| OdGePoint3d & | vertex | ||
| ) | const |
Retrieves a vertex using a specified subentity ID.
- Parameters
-
id [in] Subentity ID of the vertex. vertex [out] Receives the vertex.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ getVertexAt() [2/2]
| OdResult OdDbSubDMesh::getVertexAt | ( | OdInt32 | nIndex, |
| OdGePoint3d & | vertex | ||
| ) | const |
Retrieves a vertex from a specified position on a mesh.
- Parameters
-
nIndex [in] Index of the vertex. vertex [out] Receives the vertex.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ getVertexColorArray()
| OdResult OdDbSubDMesh::getVertexColorArray | ( | OdCmEntityColorArray & | arrColor | ) |
Retrieves the array of vertex colors.
- Parameters
-
arrColor [out] Receives an array of texture coordinates.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ getVertexNormalArray()
| OdResult OdDbSubDMesh::getVertexNormalArray | ( | OdGeVector3dArray & | arrNorm | ) |
Retrieves the array of the normals for vertices.
- Parameters
-
arrNorm [out] Receives an array of normals.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ getVertexTextureArray()
| OdResult OdDbSubDMesh::getVertexTextureArray | ( | OdGePoint3dArray & | arrPts | ) |
Retrieves the array of texture coordinates.
- Parameters
-
arrPts [out] Receives an array of texture coordinates.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ getVertices()
| OdResult OdDbSubDMesh::getVertices | ( | OdGePoint3dArray & | vertexArray | ) | const |
Retrieves the base level vertices.
- Parameters
-
vertexArray [out] Receives an array of the base level vertices.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ isWatertight()
| OdResult OdDbSubDMesh::isWatertight | ( | bool & | result | ) | const |
Checks whether a mesh is watertight.
- Parameters
-
result [out] Receives true if the mesh is watertight, false otherwise.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ negate()
| OdResult OdDbSubDMesh::negate | ( | ) |
Inverts the vertex order of each face.
- Returns
- Returns eOk if the mesh is successfully negated, or a corresponding error code otherwise.
◆ numOfEdges()
Retrieves the number of edges for the base level.
- Parameters
-
result [out] Receives the number of edges for the base level. Receives 0 if the mesh hasn't been initialized yet.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ numOfFaces()
Retrieves the number of faces for the base level.
- Parameters
-
result [out] Receives the number of faces for the base level. Receives 0 if the mesh hasn't been initialized yet.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ numOfSubDividedFaces()
Retrieves the number of faces with the current level of smoothness.
- Parameters
-
result [out] Receives the number of smooth faces.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ numOfSubDividedFacesAt()
| OdResult OdDbSubDMesh::numOfSubDividedFacesAt | ( | const OdDbFullSubentPathArray & | subentPaths, |
| OdInt32 & | result | ||
| ) | const |
Retrieves the number of smooth faces for given base mesh faces.
- Parameters
-
subentPaths [out] Array of faces. result [out] Receives the number of faces.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ numOfSubDividedVertices()
Retrieves the number of vertices with the current level of smoothness.
- Parameters
-
result [out] Receives the number of vertices.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ numOfVertices()
Retrieves the number of vertices for base level.
- Parameters
-
result [out] Receives the number of vertices for the base level.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ ODDB_DECLARE_MEMBERS()
| OdDbSubDMesh::ODDB_DECLARE_MEMBERS | ( | OdDbSubDMesh | ) |
◆ setBox()
| OdResult OdDbSubDMesh::setBox | ( | double | xLen, |
| double | yLen, | ||
| double | zLen, | ||
| OdInt32 | divX, | ||
| OdInt32 | divY, | ||
| OdInt32 | divZ, | ||
| OdInt32 | subDLevel | ||
| ) |
Creates a mesh of a box.
- Parameters
-
xLen [in] Box depth. yLen [in] Box width. zLen [in] Box height. divX [in] Specify how many divisions are made along the depth direction. divY [in] Specify how many divisions are made along the width direction. divZ [in] Specify how many divisions are made along the height direction. subDLevel [in] Level of smoothness.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ setCone()
| OdResult OdDbSubDMesh::setCone | ( | double | majorRadius, |
| double | minorRadius, | ||
| double | height, | ||
| OdInt32 | divAxis, | ||
| OdInt32 | divHeight, | ||
| OdInt32 | divCap, | ||
| double | radiusRatio, | ||
| OdInt32 | subDLevel | ||
| ) |
Creates a mesh of a cone.
- Parameters
-
majorRadius [in] Major radius. minorRadius [in] Minor radius. height [in] Height of a cone. divAxis [in] Specify how many divisions are made for the base circle. divHeight [in] Specify how many divisions are made in the direction of the height of a cone. divCap [in] Specify how many radial divisions are made for the base circle. radiusRatio [in] Ratio of top to bottom radii. subDLevel [in] Level of smoothness.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ setCrease() [1/2]
| OdResult OdDbSubDMesh::setCrease | ( | const OdDbFullSubentPathArray & | subentPaths, |
| double | creaseVal | ||
| ) |
Sharpens faces, edges, vertices of a mesh.
- Parameters
-
subentPaths [in] Array of subentities, to which the crease will be applied. creaseVal [in] Flag, defining when to apply the crease.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
- Remarks
- The value of the creaseVal parameter can be one of the following:
Value Description -1 Always apply the crease. 0 Never apply the crease. any positive value Apply the crease starting from this level.
◆ setCrease() [2/2]
| OdResult OdDbSubDMesh::setCrease | ( | double | creaseVal | ) |
Sharpens the edges of a mesh.
- Parameters
-
creaseVal [in] Flag, defining when to apply the crease.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
- Remarks
- The value of the creaseVal parameter can be one of the following:
Value Description -1 Always apply the crease. 0 Never apply the crease. any positive value Apply the crease starting from this level.
◆ setCylinder()
| OdResult OdDbSubDMesh::setCylinder | ( | double | majorRadius, |
| double | minorRadius, | ||
| double | height, | ||
| OdInt32 | divAxis, | ||
| OdInt32 | divHeight, | ||
| OdInt32 | divCap, | ||
| OdInt32 | subDLevel | ||
| ) |
Creates a mesh of a cylinder.
- Parameters
-
majorRadius [in] Major radius. minorRadius [in] Minor radius. height [in] Height of a cylinder. divAxis [in] Specify how many divisions are made for the base circle. divHeight [in] Specify how many divisions are made in the direction of the height of a cylinder. divCap [in] Specify how many radial divisions are made for the base circle. subDLevel [in] Level of smoothness.
- Returns
- eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ setPyramid()
| OdResult OdDbSubDMesh::setPyramid | ( | double | radius, |
| double | height, | ||
| OdInt32 | divLength, | ||
| OdInt32 | divHeight, | ||
| OdInt32 | divCap, | ||
| OdInt32 | nSides, | ||
| double | radiusRatio, | ||
| OdInt32 | subDLevel | ||
| ) |
Creates a mesh of a pyramid.
- Parameters
-
radius [in] Radius of a circle inscribed in a pyramid. height [in] Pyramid height. divLength [in] Specify how many divisions are made along the length direction. divHeight [in] Specify how many divisions are made along the height direction. divCap [in] Specify how many radial divisions are made for the base face. nSides [in] Number of sides that pyramid will have. radiusRatio [in] Ratio of major to minor radii. subDLevel [in] Level of smoothness.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ setSphere()
| OdResult OdDbSubDMesh::setSphere | ( | double | radius, |
| OdInt32 | divAxis, | ||
| OdInt32 | divHeight, | ||
| OdInt32 | subDLevel | ||
| ) |
Creates a mesh of a sphere.
- Parameters
-
radius [in] Sphere radius. divAxis [in] Specify how many divisions are made for the base circle. divHeight [in] Specify how many divisions are made in the direction of the height of a sphere. subDLevel [in] Level of smoothness.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ setSubDMesh()
| OdResult OdDbSubDMesh::setSubDMesh | ( | const OdGePoint3dArray & | vertexArray, |
| const OdInt32Array & | faceArray, | ||
| OdInt32 | subDLevel | ||
| ) |
Creates a mesh using input arrays of vertices and faces.
- Parameters
-
vertexArray [in] Array of vertices. faceArray [in] Array of integers, describing faces. subDLevel [in] Level of smoothness.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
- Remarks
- Face array is arranged using the following pattern: the first number is the number a vertices a face has, the following numbers are indices of vertices, that form a face.
◆ setSubentColor()
| OdResult OdDbSubDMesh::setSubentColor | ( | const OdDbSubentId & | id, |
| const OdCmColor & | color | ||
| ) |
Sets the color of a given subentity.
- Parameters
-
id [in] ID of the subentity. color [in] Color to be set to the subentity.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ setSubentMaterial()
| OdResult OdDbSubDMesh::setSubentMaterial | ( | const OdDbSubentId & | id, |
| const OdDbObjectId & | material | ||
| ) |
Sets the material of a given subentity.
- Parameters
-
id [in] ID of the subentity. material [in] Material to be set to the subentity.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ setSubentMaterialMapper()
| OdResult OdDbSubDMesh::setSubentMaterialMapper | ( | const OdDbSubentId & | id, |
| const OdGiMapper & | mapper | ||
| ) |
Sets the material mapper of a subentity.
- Parameters
-
id [in] ID of the subentity. mapper [in] Material mapper to be set to the subentity.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ setTorus()
| OdResult OdDbSubDMesh::setTorus | ( | double | majorRadius, |
| OdInt32 | divSection, | ||
| OdInt32 | divSweepPath, | ||
| double | sectionRadiusRatio, | ||
| double | sectionRotate, | ||
| OdInt32 | subDLevel | ||
| ) |
Creates a mesh of a torus.
- Parameters
-
majorRadius [in] Major radius of a torus. divSection [in] Specify how many divisions are made for the base circle. divSweepPath [in] Specify how many divisions are made along the torus' path. sectionRadiusRatio [in] Ratio of major to minor radii. sectionRotate [in] Angle of section rotation. subDLevel [in] Level of smoothness.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ setVertexAt() [1/2]
| OdResult OdDbSubDMesh::setVertexAt | ( | const OdDbSubentId & | id, |
| const OdGePoint3d & | vertex | ||
| ) |
Sets a vertex using the given subentity ID.
- Parameters
-
id [in] Subentity ID of the vertex. vertex [in] Vertex to be set.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ setVertexAt() [2/2]
| OdResult OdDbSubDMesh::setVertexAt | ( | OdInt32 | nIndex, |
| const OdGePoint3d & | vertex | ||
| ) |
Sets a vertex using the given index.
- Parameters
-
nIndex [in] Index of the vertex. vertex [in] Vertex to be set.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ setVertexColorArray()
| OdResult OdDbSubDMesh::setVertexColorArray | ( | OdCmEntityColorArray & | arrColor | ) |
Sets the array of vertex colors.
- Parameters
-
arrColor [in] Input array of vertex colors.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ setVertexNormalArray()
| OdResult OdDbSubDMesh::setVertexNormalArray | ( | OdGeVector3dArray & | arrNorm | ) |
Sets the array of vertex normals.
- Parameters
-
arrNorm [in] Input array of vertex normals.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ setVertexTextureArray()
| OdResult OdDbSubDMesh::setVertexTextureArray | ( | OdGePoint3dArray & | arrPts | ) |
Sets the array of texture coordinates.
- Parameters
-
arrPts [in] Input array of texture coordinates.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ setWedge()
| OdResult OdDbSubDMesh::setWedge | ( | double | xLen, |
| double | yLen, | ||
| double | zLen, | ||
| OdInt32 | divLength, | ||
| OdInt32 | divWidth, | ||
| OdInt32 | divHeight, | ||
| OdInt32 | divSlope, | ||
| OdInt32 | divCap, | ||
| OdInt32 | subDLevel | ||
| ) |
Creates a mesh of a wedge.
- Parameters
-
xLen [in] Wedge depth. yLen [in] Wedge width. zLen [in] Wedge height. divLength [in] Specify how many divisions are made along the depth direction. divWidth [in] Specify how many divisions are made along the width direction. divHeight [in] Specify how many divisions are made along the height direction. divSlope [in] Specify how many divisions are made along the slope direction. divCap [in] Specify how many radial divisions are made for the base face. subDLevel [in] Level of smoothness.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ splitFace()
| OdResult OdDbSubDMesh::splitFace | ( | const OdDbSubentId & | subentFaceId, |
| const OdDbSubentId & | subent0, | ||
| const OdGePoint3d & | point0, | ||
| const OdDbSubentId & | subent1, | ||
| const OdGePoint3d & | point1 | ||
| ) |
Cuts a face in two using two points on different edges of the original face.
- Parameters
-
subentFaceId [in] ID of the face that will be cut. subent0 [in] First edge. point0 [in] Point on the first edge. subent1 [in] Second edge. point1 [in] Point on the second edge.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ subdDivideDown()
| OdResult OdDbSubDMesh::subdDivideDown | ( | ) |
Decreases the smoothness level by one.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ subdDivideUp()
| OdResult OdDbSubDMesh::subdDivideUp | ( | ) |
Increases the smoothness level by one.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ subdLevel()
Retrieves the current level of smoothness.
- Parameters
-
result [out] Current level of smoothness.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ subdRefine() [1/2]
| OdResult OdDbSubDMesh::subdRefine | ( | ) |
Applies the current level of smoothness to an array of vertices and faces. The level of smoothing will be set to 0.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ subdRefine() [2/2]
| OdResult OdDbSubDMesh::subdRefine | ( | const OdDbFullSubentPathArray & | subentPaths | ) |
Applies the current level of smoothness to an array of vertices and faces. The level of smoothing will be set to 0.
- Parameters
-
subentPaths [in] Array of subentities.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
- Remarks
- Currently not implemented.
◆ subExplode()
|
virtual |
Explodes this entity into a set of simpler entities.
- Parameters
-
entitySet [out] Array of pointers to the new entities.
- Returns
- Returns eOk if successful, or an appropriate error code otherwise.
Reimplemented from OdDbEntity.
◆ subGetGeomExtents()
|
virtual |
Calculates geometrical extents of this object by vertices coordinates.
- Parameters
-
extents [out] Receives the extents.
- Returns
- Returns eOk if successful, or an appropriate error code otherwise.
Reimplemented from OdDbEntity.
◆ subGetGsMarkersAtSubentPath()
|
virtual |
Gets all graphic system markers by subentity paths.
- Parameters
-
subPath [in] Full subentity path to the subentity. gsMarkers [out] Array of integer identifiers (GS markers).
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
Reimplemented from OdDbEntity.
◆ subGetSubentPathsAtGsMarker()
|
virtual |
Gets all subentity paths by graphic system marker.
- Parameters
-
type [in] Subentity type being queried (OdDb::kClassSubentType only). gsMarker [in] The GS marker of the subentity being queried. pickPoint [in] The WCS point being queried (not used). xrm [in] The WCS->DCS transformation matrix (not used). subentPaths [out] Array of OdDbFullSubentPath objects. pEntAndInsertStack [in] Array of objectIds of the objects that are the nested containers of the subentity.
- Returns
- Returns eOk if the operation completed successfully, or an appropriate error code otherwise.
Reimplemented from OdDbEntity.
◆ subSetAttributes()
|
virtual |
Sets the values of this object's subentity traits, and returns with the calling object's subentity traits.
- Parameters
-
pTraits [in] Pointer to the OdGiDrawableTraits object to be set.
- Remarks
- When overriding subSetAttributes(), you must OR (|) the return value of <base class>::subSetAttributes(pTraits) with any flags you add.
A derived class may not remove flags for any reason.
The default implementation does nothing but returns kDrawableNone. This function can be overridden in custom classes.
Reimplemented from OdDbEntity.
◆ subTransformBy()
|
virtual |
Applies the specified 3D transformation matrix to this entity.
- Parameters
-
xfm [in] 3D transformation matrix.
- Returns
- Returns eOk if successful, or an appropriate error code otherwise.
Reimplemented from OdDbEntity.
◆ subWorldDraw()
|
virtual |
Draws OdDbSubDMesh to the specified OdGiWorldDraw object.
- Parameters
-
pWd [in] Pointer to the OdGiWorldDraw object.
- Returns
- The true value if the entity has no view-dependent graphics, or false otherwise.
Reimplemented from OdDbEntity.
The documentation for this class was generated from the following file: