#include <DbPointCloudDef.h>
Static Public Member Functions | |
| static int | classVersion () |
| static OdDbObjectId | createPointCloudDictionary (OdDbDatabase &) |
| static OdDbObjectId | pointCloudDictionary (const OdDbDatabase &) |
 Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
Detailed Description
This class defines Point Cloud Definition objects in an OdDbDatabase instance.
- See also
- AcDbPointCloudObj
- Remarks
- Point Cloud Definitions (OdDbPointCloudDef objects) work with Point Cloud (OdDbPointCloud) entities in much the same way that Raster Image Definitions (OdDbRasterImageDef objects) work with Image References (OdDbRasterImage entities).
<group OdDbPointCloud_Classes>
Definition at line 45 of file DbPointCloudDef.h.
Constructor & Destructor Documentation
◆ OdDbPointCloudDef()
| OdDbPointCloudDef::OdDbPointCloudDef | ( | ) |
Default constructor. Constructs an empty OdDbPointCloudDef object.
Member Function Documentation
◆ activeFileName()
| OdString OdDbPointCloudDef::activeFileName | ( | ) | const |
Returns the path name of the actual point cloud file being currently used for this PointCloud Definition object.
- Remarks
- This PointCloudDef object must be open for reading.
◆ classVersion()
|
static |
◆ createPointCloudDictionary()
|
static |
Returns Pointcloud Dictionary ID. Creates the dictionary, if one is not already present, in the specified OdDbDatabase instance.
- Parameters
-
Db [in] The database.
◆ defaultHeight()
| double OdDbPointCloudDef::defaultHeight | ( | ) | const |
Returns the default height of this OdDbPointCloudDef object.
◆ defaultLength()
| double OdDbPointCloudDef::defaultLength | ( | ) | const |
Returns the default length of this OdDbPointCloudDef object.
◆ defaultWidth()
| double OdDbPointCloudDef::defaultWidth | ( | ) | const |
Returns the default width of this OdDbPointCloudDef object.
◆ 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 OdDbObject.
◆ 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 OdDbObject.
◆ 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 OdDbObject.
◆ 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 OdDbObject.
◆ entityCount()
| int OdDbPointCloudDef::entityCount | ( | bool * | ) | const |
Returns the number of OdDbPointCloud entities in the current drawing that are dependent upon this object.
- Parameters
-
pbLocked [in] If it's non-zero, then this function will set the true value at that pointer if any dependent entities reside on locked layers, or set false otherwise.
◆ fileType()
Returns the type of the source file containing the point cloud data for this PointCloud Definition object (as it is stored in file).
- Remarks
- This PointCloudDef object must be open for reading.
◆ getNativeCloudExtent()
| OdResult OdDbPointCloudDef::getNativeCloudExtent | ( | OdGeExtents3d & | ) | const |
Calculates the extents of this OdDbPointCloudDef object.
- Returns
- Returns eOk if the extents are valid or eInvalidExtents otherwise.
◆ isLoaded()
| bool OdDbPointCloudDef::isLoaded | ( | ) | const |
Returns true if and only if the point cloud file for this PointCloud definition object is loaded.
◆ load()
| OdResult OdDbPointCloudDef::load | ( | bool | bModifyDatabase | ) |
Currently not implemented.
◆ ODDB_DECLARE_MEMBERS()
| OdDbPointCloudDef::ODDB_DECLARE_MEMBERS | ( | OdDbPointCloudDef | ) |
◆ pointCloudDictionary()
|
static |
Returns the Object ID of the point cloud dictionary in the specified OdDbDatabase instance.
- Parameters
-
Db [in] The database.
◆ setActiveFileName()
Returns the path name of the actual point cloud file being currently used for this PointCloud Definition object.
- Returns
- Returns eOk if the file is accessible or eInvalidInput otherwise.
◆ setExtents()
| void OdDbPointCloudDef::setExtents | ( | const OdGeExtents3d & | ) |
Sets the extents for this OdDbPointCloudDef object.
- Parameters
-
exts [in] Extents to be set.
◆ setSourceFileName()
Sets the name of the external file containing the point cloud data (.pcg or .isd) for this PointCloud Definition object (as it is stored in file).
- Returns
- Returns eOk if the file is accessible or eInvalidInput otherwise.
◆ sourceFileName()
| OdString OdDbPointCloudDef::sourceFileName | ( | ) | const |
Returns the name of the external file containing the point cloud data (.pcg or .isd) for this PointCloud Definition object (as it is stored in file).
- Remarks
- This PointCloudDef object must be open for reading.
◆ 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.
◆ subErase()
|
virtual |
Called as the first operation as this object is being erased or unerased.
- Parameters
-
erasing [in] A copy of the erasing argument passed to erase().
- Remarks
- This function is notified just before the current object is to be erased, giving this function the ability to cancel the erase.
Returns eOk if and only if erase() is to continue.
When overriding this function:
1) If the OdDbObject's state is incorrect, return something other than eOk.
2) If the parent class's subErase() returns anything other than eOk, immediately return it.
3) If other actions are required before erase, do them.
4) Return eOk.
If you must make changes to this object's state, either make them after step 2, or roll them back if step 2 returns other than eOk.
The default implementation of this function does nothing but return eOk. This function can be overridden in custom classes.
Reimplemented from OdDbObject.
◆ subHandOverTo()
|
virtual |
Called as the first operation of the handOverTo function.
- Parameters
-
pNewObject [in] Pointer to the object with which to replace this object in the database.
- Remarks
- This function allows custom classes to populate the new object.
- Overriding this function in a child class allows a child instance to be notified each time an object is handed over.
This function is notified just before an object is to be handed over; giving this function the ability to cancel the handover.
When overriding this function:
1) If the OdDbObject's state is incorrect, throw exception.
2) Call parent class's subHandover().
3) If other actions are required before handover, do them.
The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented from OdDbObject.
◆ subWblockClone()
|
virtual |
Reimplemented from OdDbObject.
◆ totalPointsCount()
| OdUInt64 OdDbPointCloudDef::totalPointsCount | ( | ) | const |
Returns the total number of points of this OdDbPointCloudDef object.
◆ unload()
| void OdDbPointCloudDef::unload | ( | bool | bModifyDatabase | ) |
Currently not implemented.
The documentation for this class was generated from the following file: