#include <DbPointCloudEx.h>
Public Types inherited from Detailed Description
This class represents PointCloudEx entities in an OdDbDatabase instance.
Corresponding C++ library: AcDbPointCloudObj
<group OdDbPointCloud_Classes>
Definition at line 41 of file DbPointCloudEx.h.
Member Enumeration Documentation
◆ DisplayOptionOutOfRange
This enumeration represents various types of behaviour when an option (intensity of elevation) is out of range.
| Enumerator | |
|---|---|
| kUseMinMaxColors | |
| kUseRGBScanColors | |
| kHidePoints | |
Definition at line 360 of file DbPointCloudEx.h.
◆ StylizationType
This enumeration represents various stylization types for point cloud entities.
| Enumerator | |
|---|---|
| kTrueColor | |
| kSingleColor | |
| kNormalRamp | |
| kHeightRamp | |
| kIntensityRamp | |
| kClassificationRamp | |
Definition at line 268 of file DbPointCloudEx.h.
Constructor & Destructor Documentation
◆ OdDbPointCloudEx()
| OdDbPointCloudEx::OdDbPointCloudEx | ( | ) |
Default constructor. Creates an empty point cloud entity.
◆ ~OdDbPointCloudEx()
|
inline |
Destructor.
Definition at line 57 of file DbPointCloudEx.h.
Member Function Documentation
◆ addCroppingBoundary()
| void OdDbPointCloudEx::addCroppingBoundary | ( | OdDbPointCloudCropping const & | boundary | ) |
Adds a cropping boundary to the boundary array if it's valid.
- Parameters
-
boundary [in] New cropping boundary to be added.
◆ clearCropping()
| OdResult OdDbPointCloudEx::clearCropping | ( | ) |
Clears the cropping boundary array.
- Returns
- eOk.
◆ 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.
◆ elevationApplyToFixedRange()
| bool OdDbPointCloudEx::elevationApplyToFixedRange | ( | ) | const |
Checks if elevation is applied to a fixed range.
- Returns
- true if elevation is applied to a fixed range, false - otherwise.
◆ elevationOutOfRangeBehavior()
| DisplayOptionOutOfRange OdDbPointCloudEx::elevationOutOfRangeBehavior | ( | ) | const |
Returns the behaviour that will be executed when elevation is out of range.
- Remarks
- Possible behaviours:
Name Value Description kUseMinMaxColors 0 UseMinMaxColors desc. kUseRGBScanColors 1 UseRGBScanColors desc. kHidePoints 2 HidePoints desc.
◆ getActiveFileName()
| bool OdDbPointCloudEx::getActiveFileName | ( | OdString & | fileName | ) | const |
Retrieves the currently active file name.
- Parameters
-
fileName [out] Output active file name.
- Returns
- true.
◆ getColorSchemeForStylization()
| OdString OdDbPointCloudEx::getColorSchemeForStylization | ( | StylizationType | type | ) | const |
◆ getConstPointCloudCropping() [1/2]
| OdDbPointCloudCropping * OdDbPointCloudEx::getConstPointCloudCropping | ( | int | index | ) |
Returns the current point cloud cropping.
- Parameters
-
index [in]
- Returns
- NULL if index if greater than the array size. Pointer to the OdDbPointCloudCropping element with specified index from an array - otherwise.
◆ getConstPointCloudCropping() [2/2]
| OdDbPointCloudCropping const * OdDbPointCloudEx::getConstPointCloudCropping | ( | int | index | ) | const |
Returns the current point cloud cropping.
- Parameters
-
index [in]
- Returns
- NULL if index if greater than the array size. Pointer to the OdDbPointCloudCropping element with specified index from an array - otherwise.
◆ getCroppingCount()
| OdUInt32 OdDbPointCloudEx::getCroppingCount | ( | ) | const |
NOT IMPLEMENTED
◆ getCroppingInvert()
| bool OdDbPointCloudEx::getCroppingInvert | ( | ) | const |
NOT IMPLEMENTED
◆ getCurrentColorScheme()
| OdString OdDbPointCloudEx::getCurrentColorScheme | ( | ) | const |
Retrieves the current color scheme. if the current stylization type is one of the following:
kHeightRamp kClassificationRamp
- Returns
- The current color scheme if the current stylization type is one of the following:
kHeightRamp kClassificationRamp
Empty string otherwise.
◆ getDisplayedVisiblePointCount()
| unsigned int OdDbPointCloudEx::getDisplayedVisiblePointCount | ( | OdGeExtents3d | extents | ) |
NOT IMPLEMENTED
◆ getLoadedVisiblePointCount()
| unsigned int OdDbPointCloudEx::getLoadedVisiblePointCount | ( | OdGeExtents3d | extents | ) |
NOT IMPLEMENTED
◆ getNativeCloudExtent()
| void OdDbPointCloudEx::getNativeCloudExtent | ( | OdGeExtents3d & | extents | ) | const |
Returns native cloud extents.
- Parameters
-
extents [out] Output extents.
◆ getPointCloudName()
| OdString OdDbPointCloudEx::getPointCloudName | ( | ) | const |
Returns the name of the saved file.
◆ getVisiblePointCount()
| unsigned int OdDbPointCloudEx::getVisiblePointCount | ( | OdGeExtents3d | extents | ) |
NOT IMPLEMENTED
◆ intensityOutOfRangeBehavior()
| DisplayOptionOutOfRange OdDbPointCloudEx::intensityOutOfRangeBehavior | ( | ) | const |
Returns the behaviour that will be executed when intensity is out of range.
- Remarks
- Possible behaviours:
Name Value Description kUseMinMaxColors 0 UseMinMaxColors desc. kUseRGBScanColors 1 UseRGBScanColors desc. kHidePoints 2 HidePoints desc.
◆ location()
| OdGePoint3d OdDbPointCloudEx::location | ( | ) | const |
Returns the 3d point, that the represents the translation values in the transformation matrix.
◆ locked()
| bool OdDbPointCloudEx::locked | ( | ) | const |
Returns true if the point cloud entity ex is locked or false otherwise.
◆ maxElevation()
| double OdDbPointCloudEx::maxElevation | ( | ) | const |
Returns the current maximal elevation.
◆ maxIntensity()
| OdInt32 OdDbPointCloudEx::maxIntensity | ( | ) | const |
Returns the current value of maximal intensity.
◆ minElevation()
| double OdDbPointCloudEx::minElevation | ( | ) | const |
Returns the current minimal elevation.
◆ minIntensity()
| OdInt32 OdDbPointCloudEx::minIntensity | ( | ) | const |
Returns the current value of minimal intensity.
◆ ODDB_DECLARE_MEMBERS()
| OdDbPointCloudEx::ODDB_DECLARE_MEMBERS | ( | OdDbPointCloudEx | ) |
◆ pointCloudDefExId()
| OdDbObjectId OdDbPointCloudEx::pointCloudDefExId | ( | ) | const |
Returns the Object ID of the OdDbPointCloudDefEx object associated with this point cloud ex entity.
◆ reactorId()
| OdDbObjectId OdDbPointCloudEx::reactorId | ( | ) | const |
Returns the Object ID of the OdDbPointCloudDefReactorEx object associated with this point cloud ex entity.
- Remarks
- Each OdDbPointCloudEx object must have an OdDbPointCloudDefReactorEx associated with the OdDbPointCloudDefEx object it is using.
◆ removeLastCropping()
| OdResult OdDbPointCloudEx::removeLastCropping | ( | ) |
Removes the last cropping boundary from the array.
- Returns
- eOk.
◆ rotation()
| double OdDbPointCloudEx::rotation | ( | ) | const |
Returns the current rotation angle value.
◆ scale()
| double OdDbPointCloudEx::scale | ( | ) | const |
Returns the current scaling multiplier.
◆ setActiveFileName()
| bool OdDbPointCloudEx::setActiveFileName | ( | const OdChar * | strActiveFileName | ) |
Sets an active file name.
- Parameters
-
strActiveFileName [in] New active file name.
- Returns
- true.
◆ setColorSchemeForStylization()
| OdResult OdDbPointCloudEx::setColorSchemeForStylization | ( | const OdString & | guid, |
| StylizationType | type | ||
| ) |
◆ setCroppingInvert()
| OdResult OdDbPointCloudEx::setCroppingInvert | ( | bool | bInvert | ) |
NOT IMPLEMENTED
◆ setCurrentColorScheme()
Sets new color scheme f the current stylization type is one of the following:
kHeightRamp kClassificationRamp
- Parameters
-
guid [in] New color scheme to be set.
- Returns
- eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ setElevationApplyToFixedRange()
| void OdDbPointCloudEx::setElevationApplyToFixedRange | ( | bool | bFixedRange | ) |
Sets a flag whether to apply elevation to a fixed range.
- Parameters
-
bFixedRange [in] Flag value.
◆ setElevationOutOfRangeBehavior()
| void OdDbPointCloudEx::setElevationOutOfRangeBehavior | ( | DisplayOptionOutOfRange | displayOption | ) |
Sets the behaviour that will be executed when elevation is out of range.
- Parameters
-
displayOption [in] Enum value associated with the behaviour.
- Remarks
- Possible behaviours:
Name Value Description kUseMinMaxColors 0 UseMinMaxColors desc. kUseRGBScanColors 1 UseRGBScanColors desc. kHidePoints 2 HidePoints desc.
◆ setInCreatingCroppingMode()
| OdResult OdDbPointCloudEx::setInCreatingCroppingMode | ( | bool | bCreating | ) |
NOT IMPLEMENTED
◆ setIntensityOutOfRangeBehavior()
| void OdDbPointCloudEx::setIntensityOutOfRangeBehavior | ( | DisplayOptionOutOfRange | displayOption | ) |
Sets the behaviour that will be executed when intensity is out of range.
- Parameters
-
displayOption [in] Enum value associated with the behaviour.
- Remarks
- Possible behaviours:
Name Value Description kUseMinMaxColors 0 UseMinMaxColors desc. kUseRGBScanColors 1 UseRGBScanColors desc. kHidePoints 2 HidePoints desc.
◆ setLocation()
| void OdDbPointCloudEx::setLocation | ( | OdGePoint3d | newLocation | ) |
Sets new translation values to the transformation matrix.
- Parameters
-
newLocation [in] New translation values as a point.
◆ setLocked()
| void OdDbPointCloudEx::setLocked | ( | bool | bLocked | ) |
Sets the point cloud entity ex to be locked.
◆ setMinMaxElevation()
| OdResult OdDbPointCloudEx::setMinMaxElevation | ( | double | min, |
| double | max | ||
| ) |
Sets minimal and maximal elevation.
- Parameters
-
min [in] New minimal elevation. max [in] New maximal elevation.
- Returns
- eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ setMinMaxIntensity()
Sets minimal and maximal intensity.
- Parameters
-
min [in] New minimal intensity. max [in] New maximal intensity.
- Returns
- eOk if the operation completed successfully, or an appropriate error code otherwise.
◆ setPointCloudDefExId()
| void OdDbPointCloudEx::setPointCloudDefExId | ( | const OdDbObjectId | pointCloudDefExId | ) |
Sets the Object ID of the OdDbPointCloudDefEx object associated with this point cloud ex entity.
- Parameters
-
pointCloudDefExId [in] Object ID of the point cloud ex to be associated with this point cloud ex entity.
◆ setPointCloudName()
Sets the name of the saved file.
- Parameters
-
name [in] New saved file name.
- Returns
- eOk.
◆ setReactorId()
| void OdDbPointCloudEx::setReactorId | ( | const OdDbObjectId | pointCloudDefReactorExId | ) |
Sets the Object ID of the OdDbPointCloudDefReactorEx object associated with this point cloud entity.
- Parameters
-
pointCloudDefReactorExId [in] Object ID of a reactor for this point cloud ex entity.
- Remarks
- Each OdDbPointCloudEx object must have an OdDbPointCloudDefReactorEx associated with the OdDbPointCloudDefEx object it is using.
◆ setRotation()
| void OdDbPointCloudEx::setRotation | ( | double | newRotation | ) |
Sets a new rotation angle value.
- Parameters
-
newRotation [in] New rotation angle value.
◆ setScale()
| void OdDbPointCloudEx::setScale | ( | double | scale | ) |
Sets a new scaling multiplier.
- Parameters
-
scale [in] New scaling multiplier.
◆ setShowCropping()
| OdResult OdDbPointCloudEx::setShowCropping | ( | bool | bShowCropping | ) |
Set whether this point cloud ex entity is displayed as clipped.
- Parameters
-
bShowcropping [in] Value for option.
- Returns
- Returns eOk.
◆ setShowElevationAsGradient()
| void OdDbPointCloudEx::setShowElevationAsGradient | ( | bool | bShowAsGradient | ) |
Sets a falg whether to show elevation as gradient.
- Parameters
-
bShowAsGradient [in] Flag value.
◆ setShowIntensityAsGradient()
| void OdDbPointCloudEx::setShowIntensityAsGradient | ( | bool | bShowAsGradient | ) |
Sets a flag whether to show intensity as gradient.
- Parameters
-
bShowAsGradient [in] Flag value.
◆ setStylizationType()
| OdResult OdDbPointCloudEx::setStylizationType | ( | StylizationType | type | ) |
Sets new stylization type.
- Parameters
-
type [in] Enum value of stylization type.
- Returns
- eOk if the opertation completed successfully, or an appropriate error code otherwise.
- Remarks
- Possible stylization type values:
Name Value Description kTrueColor 1 TrueColor description. kSingleColor 2 SingleColor description. kNormalRamp 3 NormalRamp description. kHeightRamp 4 HeightRamp desctiption. kIntensityRamp 5 IntensityRamp description. kClassificationRamp 6 ClassificationRamp description.
◆ showCropping()
| bool OdDbPointCloudEx::showCropping | ( | ) | const |
Returns true only if this point cloud ex entity is displayed as clipped.
◆ showElevationAsGradient()
| bool OdDbPointCloudEx::showElevationAsGradient | ( | ) | const |
Checks if the elevation is shown as gradient.
- Returns
- true if elevation is shows as gradient, false - otherwise.
◆ showIntensityAsGradient()
| bool OdDbPointCloudEx::showIntensityAsGradient | ( | ) | const |
Checks if the intensity is shown as gradient.
- Returns
- true if intensity is shown as gradient, false - otherwise.
◆ stylizationType()
| StylizationType OdDbPointCloudEx::stylizationType | ( | ) | const |
Returns the current stylization type.
- Remarks
- Possible stylization type values:
Name Value Description kTrueColor 1 TrueColor description. kSingleColor 2 SingleColor description. kNormalRamp 3 NormalRamp description. kHeightRamp 4 HeightRamp desctiption. kIntensityRamp 5 IntensityRamp description. kClassificationRamp 6 ClassificationRamp description.
◆ 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.
◆ subGetGeomExtents()
|
virtual |
Retrieves geometrical extents affected by current transformation.
- Parameters
-
extents [out] Geometrical extents.
- Returns
- Returns eOk.
Reimplemented from OdDbEntity.
◆ subTransformBy()
|
virtual |
Applies a transformation matrix to this XData object. Only available if transformation is uniform.
- Parameters
-
xform [in] Transformation matrix to be applied.
- Returns
- eOk if the operation completed successfully, or an appropriate error code otherwise
Reimplemented from OdDbEntity.
◆ subViewportDraw()
|
virtual |
Reimplemented from OdDbEntity.
◆ subWorldDraw()
|
virtual |
Reimplemented from OdDbEntity.
The documentation for this class was generated from the following file: