CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | List of all members
OdDbPointCloudDefEx Class Reference

#include <DbPointCloudDefEx.h>

Inheritance diagram for OdDbPointCloudDefEx:
OdDbObject OdGiDrawable OdRxObject

Public Types

enum  PropState { kNone = -1 , kSome = 0 , kAll = 1 }
 
enum  Property {
  kColor = 1 , kIntensity = 2 , kClassification = 3 , kNormal = 4 ,
  kSegmentation = 5 , kGeoGraphic = 6
}
 
- Public Types inherited from OdGiDrawable
enum  SetAttributesFlags {
  kDrawableNone = 0 , kDrawableIsAnEntity = 1 , kDrawableUsesNesting = 2 , kDrawableIsCompoundObject = 4 ,
  kDrawableViewIndependentViewportDraw = 8 , kDrawableIsInvisible = 16 , kDrawableHasAttributes = 32 , kDrawableRegenTypeDependantGeometry = 64 ,
  kDrawableIsDimension = (kDrawableIsAnEntity + kDrawableIsCompoundObject + 128) , kDrawableRegenDraw = 256 , kDrawableStandardDisplaySingleLOD = 512 , kDrawableShadedDisplaySingleLOD = 1024 ,
  kDrawableViewDependentViewportDraw = 2048 , kDrawableBlockDependentViewportDraw = 4096 , kDrawableIsExternalReference = 8192 , kDrawableNotPlottable = 16384 ,
  kDrawableNotAllowLCS = 32768 , kDrawableMergeControlOff = 65536 , kLastFlag = kDrawableMergeControlOff
}
 
enum  DrawableType {
  kGeometry = 0 , kDistantLight = 1 , kPointLight = 2 , kSpotLight = 3 ,
  kAmbientLight , kSolidBackground , kGradientBackground , kImageBackground ,
  kGroundPlaneBackground , kViewport , kWebLight , kSkyBackground ,
  kImageBasedLightingBackground
}
 

Public Member Functions

 ODDB_DECLARE_MEMBERS (OdDbPointCloudDefEx)
 
 OdDbPointCloudDefEx ()
 
OdString sourceFileName () const
 
OdResult setSourceFileName (const OdString &sPathName)
 
const OdCharactiveFileName () const
 
OdResult setActiveFileName (const OdChar *pPathName)
 
const OdCharfileType () const
 
bool isLoaded () const
 
OdResult load ()
 
void unload ()
 
int entityCount (bool *pbLocked) const
 
OdUInt64 totalPointsCount () const
 
double defaultHeight () const
 
double defaultLength () const
 
double defaultWidth () const
 
OdResult extents (OdGeExtents3d &exts) const
 
OdUInt32 totalRegionsCount () const
 
OdUInt32 totalScansCount () const
 
OdString coordinateSystemName () const
 
OdString getRcsFilePath (const OdString &guid) const
 
void getAllRcsFilePaths (OdStringArray &list) const
 
PropState hasProperty (Property prop) const
 
OdResult createThumbnailBitmap (BITMAPINFO *&pBmpInfo, int width, int height) const
 
virtual OdResult dwgInFields (OdDbDwgFiler *pFiler)
 
virtual void dwgOutFields (OdDbDwgFiler *pFiler) const
 
virtual OdResult dxfInFields (OdDbDxfFiler *pFiler)
 
virtual void dxfOutFields (OdDbDxfFiler *pFiler) const
 
- Public Member Functions inherited from OdDbObject
 ODDB_DECLARE_MEMBERS (OdDbObject)
 
 ~OdDbObject ()
 
void addRef ()
 
void release ()
 
long numRefs () const
 
OdDbObjectId objectId () const
 
OdDbHandle getDbHandle () const
 
OdDbHandle handle () const
 
OdDbObjectId ownerId () const
 
virtual void setOwnerId (OdDbObjectId ownerId)
 
OdDbDatabasedatabase () const
 
void createExtensionDictionary ()
 
OdDbObjectId extensionDictionary () const
 
bool releaseExtensionDictionary ()
 
OdDbXrecordPtr createXrecord (const OdString &xrecordName, OdDb::DuplicateRecordCloning style=OdDb::kDrcIgnore)
 
void upgradeOpen ()
 
void downgradeOpen ()
 
void cancel ()
 
virtual OdResult subOpen (OdDb::OpenMode mode)
 
virtual void subClose ()
 
OdResult erase (bool eraseIt=true)
 
virtual OdResult subErase (bool erasing)
 
void handOverTo (OdDbObject *pNewObject, bool keepXData=true, bool keepExtDict=true)
 
virtual void subHandOverTo (OdDbObject *pNewObject)
 
void swapIdWith (OdDbObjectId otherId, bool swapXdata=false, bool swapExtDict=false)
 
virtual void subSwapIdWith (const OdDbObjectId &otherId, bool swapXdata=false, bool swapExtDict=false)
 
virtual void audit (OdDbAuditInfo *pAuditInfo)
 
void dwgIn (OdDbDwgFiler *pFiler)
 
void dwgOut (OdDbDwgFiler *pFiler) const
 
virtual OdResult dxfIn (OdDbDxfFiler *pFiler)
 
virtual void dxfOut (OdDbDxfFiler *pFiler) const
 
virtual OdResult dwgInFields (OdDbDwgFiler *pFiler)
 
virtual void dwgOutFields (OdDbDwgFiler *pFiler) const
 
virtual OdResult dxfInFields (OdDbDxfFiler *pFiler)
 
virtual void dxfOutFields (OdDbDxfFiler *pFiler) const
 
virtual OdResult dxfInFields_R12 (OdDbDxfFiler *pFiler)
 
virtual void dxfOutFields_R12 (OdDbDxfFiler *pFiler) const
 
virtual OdDb::DuplicateRecordCloning mergeStyle () const
 
virtual OdResBufPtr xData (const OdString &regappName=OdString::kEmpty) const
 
virtual void setXData (const OdResBuf *pRb)
 
bool isEraseStatusToggled () const
 
bool isErased () const
 
bool isReadEnabled () const
 
bool isWriteEnabled () const
 
bool isNotifyEnabled () const
 
bool isModified () const
 
bool isModifiedXData () const
 
bool isModifiedGraphics () const
 
bool isNewObject () const
 
bool isNotifying () const
 
bool isUndoing () const
 
bool isReallyClosing () const
 
bool isDBRO () const
 
void assertReadEnabled () const
 
void assertWriteEnabled (bool autoUndo=true, bool recordModified=true)
 
void assertNotifyEnabled () const
 
void disableUndoRecording (bool disable)
 
bool isUndoRecordingDisabled () const
 
OdDbDwgFilerundoFiler ()
 
virtual void applyPartialUndo (OdDbDwgFiler *pUndoFiler, OdRxClass *pClassObj)
 
void addReactor (OdDbObjectReactor *pReactor) const
 
void removeReactor (OdDbObjectReactor *pReactor) const
 
virtual void addPersistentReactor (const OdDbObjectId &objId)
 
virtual void removePersistentReactor (const OdDbObjectId &objId)
 
bool hasPersistentReactor (const OdDbObjectId &objId) const
 
OdDbObjectIdArray getPersistentReactors () const
 
OdDbObjectReactorArray getTransientReactors () const
 
virtual void recvPropagateModify (const OdDbObject *pSubObj)
 
virtual void xmitPropagateModify () const
 
ODRX_SEALED_VIRTUAL OdDbObjectPtr deepClone (OdDbIdMapping &idMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdDbObjectPtr wblockClone (OdDbIdMapping &idMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
 
virtual void appendToOwner (OdDbIdPair &idPair, OdDbObject *pOwnerObject, OdDbIdMapping &idMap)
 
void setOdDbObjectIdsInFlux ()
 
bool isOdDbObjectIdsInFlux () const
 
virtual void copied (const OdDbObject *pObject, const OdDbObject *pNewObject)
 
virtual void erased (const OdDbObject *pObject, bool erasing=true)
 
virtual void goodbye (const OdDbObject *pObject)
 
virtual void openedForModify (const OdDbObject *pObject)
 
virtual void modified (const OdDbObject *pObject)
 
virtual void subObjModified (const OdDbObject *pObject, const OdDbObject *pSubObj)
 
virtual void modifyUndone (const OdDbObject *pObject)
 
virtual void modifiedXData (const OdDbObject *pObject)
 
virtual void unappended (const OdDbObject *pObject)
 
virtual void reappended (const OdDbObject *pObject)
 
bool isAProxy () const
 
virtual void objectClosed (const OdDbObjectId &objectId)
 
virtual void modifiedGraphics (const OdDbObject *pObject)
 
virtual void copyFrom (const OdRxObject *pSource)
 
bool hasSaveVersionOverride () const
 
void setHasSaveVersionOverride (bool hasSaveVersionOverride)
 
virtual OdDb::DwgVersion getObjectSaveVersion (const OdDbFiler *pFiler, OdDb::MaintReleaseVer *pMaintVer=0) const
 
virtual OdDbObjectPtr decomposeForSave (OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)
 
virtual OdDbObjectPtr decomposeForSave (OdDb::SaveType format, OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)
 
void convertForSave (OdDb::DwgVersion ver)
 
virtual void composeForLoad (OdDb::SaveType format, OdDb::DwgVersion version, OdDbAuditInfo *pAuditInfo)
 
virtual OdGiDrawabledrawable ()
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *pTraits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *pWd) const
 
virtual void subViewportDraw (OdGiViewportDraw *pVd) const
 
virtual bool isPersistent () const
 
virtual OdDbStub * id () const
 
ODRX_SEALED_VIRTUAL OdResult getClassID (void *pClsid) const ODRX_SEALED
 
void setGsNode (OdGsCache *pNode)
 
OdGsCachegsNode () const
 
void xDataTransformBy (const OdGeMatrix3d &xfm)
 
bool hasFields () const
 
OdDbObjectId getField (const OdString &fieldName) const
 
OdDbObjectPtr getField (const OdString &fieldName, OdDb::OpenMode mode) const
 
virtual OdDbObjectId setField (const OdString &fieldName, OdDbField *pField)
 
virtual OdResult removeField (OdDbObjectId fieldId)
 
virtual OdDbObjectId removeField (const OdString &fieldName)
 
OdDbObjectId getFieldDictionary () const
 
OdDbObjectPtr getFieldDictionary (OdDb::OpenMode mode) const
 
virtual OdRxClasssaveAsClass (OdRxClass *pClass) const
 
- Public Member Functions inherited from OdGiDrawable
 ODRX_DECLARE_MEMBERS (OdGiDrawable)
 
virtual DrawableType drawableType () const
 
ODRX_SEALED_VIRTUAL OdUInt32 setAttributes (OdGiDrawableTraits *pTraits) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL bool worldDraw (OdGiWorldDraw *pWd) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL void viewportDraw (OdGiViewportDraw *pVd) const ODRX_SEALED
 
virtual bool isPersistent () const =0
 
virtual OdDbStub * id () const =0
 
virtual void setGsNode (OdGsCache *pGsNode)=0
 
virtual OdGsCachegsNode () const =0
 
ODRX_SEALED_VIRTUAL OdUInt32 viewportDrawLogicalFlags (OdGiViewportDraw *pVd) const ODRX_SEALED
 
virtual OdResult getGeomExtents (OdGeExtents3d &extents) const
 
ODRX_SEALED_VIRTUAL OdUInt32 regenSupportFlags () const ODRX_SEALED
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Static Public Member Functions

static OdDbObjectId createPointCloudExDictionary (OdDbDatabase *pDb)
 
static OdDbObjectId pointCloudExDictionary (const OdDbDatabase *pDb)
 
static OdDbDictionarygetPointCloudExDictionary (OdDbPointCloudDefEx *pDefEx)
 
static int classVersion ()
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Additional Inherited Members

- Protected Member Functions inherited from OdDbObject
 OdDbObject ()
 
virtual OdResult subGetClassID (void *pClsid) const
 
virtual OdDbObjectPtr subDeepClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const
 
virtual OdDbObjectPtr subWblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const
 
- Protected Member Functions inherited from OdGiDrawable
 OdGiDrawable ()
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const =0
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const =0
 
virtual void subViewportDraw (OdGiViewportDraw *vd) const =0
 
virtual OdUInt32 subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const
 
virtual OdUInt32 subRegenSupportFlags () const
 
- Protected Attributes inherited from OdDbObject
OdDbObjectImplm_pImpl
 

Detailed Description

<group OdDbPointCloud_Classes>

This class represents an interface for a point cloud extension definition object. Object of this class links an .rcp or .rcs file to the drawing database. OdDbPointCloudDefEx objects are stored in the point cloud extension dictionary named ACAD_POINTCLOUD_EX_DICT.

Definition at line 42 of file DbPointCloudDefEx.h.

Member Enumeration Documentation

◆ Property

This enumeration defines the types of properties available for a point cloud.

Enumerator
kColor 
kIntensity 
kClassification 
kNormal 
kSegmentation 
kGeoGraphic 

Definition at line 62 of file DbPointCloudDefEx.h.

◆ PropState

This enumeration defines the property state indicators.

Enumerator
kNone 
kSome 
kAll 

Definition at line 52 of file DbPointCloudDefEx.h.

Constructor & Destructor Documentation

◆ OdDbPointCloudDefEx()

OdDbPointCloudDefEx::OdDbPointCloudDefEx ( )

Default constructor. Constructs an empty OdDbPointCloudDefEx object.

Member Function Documentation

◆ activeFileName()

const OdChar * OdDbPointCloudDefEx::activeFileName ( ) const

Returns the path name of the actual point cloud file being currently used for this PointCloudEx Definition object.

Returns
The path name of the file.
Remarks
This PointCloudDef object must be open for reading.

◆ classVersion()

static int OdDbPointCloudDefEx::classVersion ( )
static

Returns the current class version.

Returns
Class version as an integer value.

◆ coordinateSystemName()

OdString OdDbPointCloudDefEx::coordinateSystemName ( ) const

Gets the the coordinate system name of the point cloud.

Returns
The name of the coordinate system.

◆ createPointCloudExDictionary()

static OdDbObjectId OdDbPointCloudDefEx::createPointCloudExDictionary ( OdDbDatabase pDb)
static

Returns the PointCloudEx Dictionary ID. Creates the dictionary, if no one is already present in the specified OdDbDatabase instance.

Parameters
Db[in] The pointer to the dwg database.
Returns
The PointCloudEx Dictionary ID as an OdDbObjectId object.

◆ createThumbnailBitmap()

OdResult OdDbPointCloudDefEx::createThumbnailBitmap ( BITMAPINFO *&  pBmpInfo,
int  width,
int  height 
) const

Creates a thumbnail of the point cloud. NOT INPLEMENTED.

◆ defaultHeight()

double OdDbPointCloudDefEx::defaultHeight ( ) const

Returns the default height of this OdDbPointCloudDefEx object.

Returns
The default height as a double value.

◆ defaultLength()

double OdDbPointCloudDefEx::defaultLength ( ) const

Returns the default length of this OdDbPointCloudDefEx object.

Returns
The default length as a double value.

◆ defaultWidth()

double OdDbPointCloudDefEx::defaultWidth ( ) const

Returns the default width of this OdDbPointCloudDefEx object.

Returns
The default width as a double value.

◆ dwgInFields()

virtual OdResult OdDbPointCloudDefEx::dwgInFields ( OdDbDwgFiler pFiler)
virtual

This method is intended to read object specific data from a .dwg file. The method is not intended to be called directly, it is called by dwgIn().

Parameters
pFiler[in] Filer object which data is read from.
Returns
eOk if data was read successfully.

Reimplemented from OdDbObject.

◆ dwgOutFields()

virtual void OdDbPointCloudDefEx::dwgOutFields ( OdDbDwgFiler pFiler) const
virtual

This method is intended to write object specific data to a .dwg file. The method is not intended to be called directly, it is called by dwgOut().

Parameters
pFiler[in] Filer object which data is written to.

Reimplemented from OdDbObject.

◆ dxfInFields()

virtual OdResult OdDbPointCloudDefEx::dxfInFields ( OdDbDxfFiler pFiler)
virtual

This method is intended to read object specific data from a .dxf file. The method is not intended to be called directly, it is called by dxfIn().

Parameters
pFiler[in] Filer object which data is read from.
Returns
eOk if data was read successfully.

Reimplemented from OdDbObject.

◆ dxfOutFields()

virtual void OdDbPointCloudDefEx::dxfOutFields ( OdDbDxfFiler pFiler) const
virtual

This method is intended to write object specific data to a .dxf file. The method is not intended to be called directly, it is called by dxfOut().

Parameters
pFiler[in] Filer object which data is written to.

Reimplemented from OdDbObject.

◆ entityCount()

int OdDbPointCloudDefEx::entityCount ( bool *  pbLocked) const

Returns the number of OdDbPointCloudEx entities in the current drawing that are dependent upon this OdDbPointCloudDefEx object.

Parameters
pbLocked[out] When not NULL, this parameter is set to true if any dependent entities reside on locked layers; false otherwise.
Returns
A number of dependent OdDbPointCloudEx entities as an integer value.

◆ extents()

OdResult OdDbPointCloudDefEx::extents ( OdGeExtents3d exts) const

Calculates the extents of this OdDbPointCloudDefEx object.

Parameters
exts[out] Extents of this OdDbPointCloudDefEx object.
Returns
eOk if the extents are valid or eInvalidExtents otherwise.

◆ fileType()

const OdChar * OdDbPointCloudDefEx::fileType ( ) const

Returns the type of the source file containing the point cloud data for this PointCloudEx Definition object (as it is stored in file).

Returns
The type of the file.
Remarks
his PointCloudDefEx object must be open for reading.

◆ getAllRcsFilePaths()

void OdDbPointCloudDefEx::getAllRcsFilePaths ( OdStringArray list) const

Gets the list of paths for all .rcs files.

Parameters
list[in/out] An array of strings to be filled with paths to the .rcs files.
Returns
The array of strings containing paths to the .rcs files.

◆ getPointCloudExDictionary()

static OdDbDictionary * OdDbPointCloudDefEx::getPointCloudExDictionary ( OdDbPointCloudDefEx pDefEx)
static

Returns the pointer to the PointCloudEx Dictionary that contains the specified OdDbPointCloudDefEx object.

Parameters
pDefEx[in] the OdDbPointCloudDefEx object to get the dictionary which it is stored in.
Returns
The pointer to the PointCloudEx Dictionary object.

◆ getRcsFilePath()

OdString OdDbPointCloudDefEx::getRcsFilePath ( const OdString guid) const

Gets the path of a specified .rcs file.

Parameters
guid[in] The GUID of the .rcs file.
Returns
The path of the .rcs file.

◆ hasProperty()

PropState OdDbPointCloudDefEx::hasProperty ( Property  prop) const

Checks whether a specified property is present in scans of a point cloud. The result will show whether this property is present in all scans, some of the scans, or none of the scans.

Parameters
prop[in] Property to be checked.
Returns
The state of the property.

◆ isLoaded()

bool OdDbPointCloudDefEx::isLoaded ( ) const

Returns true if and only if the point cloud file for this PointCloudEx definition object is loaded.

Returns
True if the point cloud file is loaded; false otherwise.

◆ load()

OdResult OdDbPointCloudDefEx::load ( )

Loads the point cloud file for this PointCloudEx definition object.

Returns
eOk if the file was loaded successfully.

◆ ODDB_DECLARE_MEMBERS()

OdDbPointCloudDefEx::ODDB_DECLARE_MEMBERS ( OdDbPointCloudDefEx  )

◆ pointCloudExDictionary()

static OdDbObjectId OdDbPointCloudDefEx::pointCloudExDictionary ( const OdDbDatabase pDb)
static

Returns the ID of the PointCloudEx Dictionary in the specified OdDbDatabase instance.

Parameters
Db[in] The pointer to the dwg database.
Returns
The PointCloudEx Dictionary ID as an OdDbObjectId object.

◆ setActiveFileName()

OdResult OdDbPointCloudDefEx::setActiveFileName ( const OdChar pPathName)

Sets the path name of the actual point cloud file being currently used for this PointCloudEx Definition object.

Parameters
pPathName[in] The path name of the file.
Returns
Returns eOk if the file is accessible or eInvalidInput otherwise.

◆ setSourceFileName()

OdResult OdDbPointCloudDefEx::setSourceFileName ( const OdString sPathName)

Sets the name of the external file containing the point cloud extension data (.rcp or .rcs) for this PointCloudEx Definition object (as it is stored in a file).

Parameters
sPathName[in] The name of the file containing the point cloud extension data.
Returns
Returns eOk if the file is accessible or eInvalidInput otherwise.

◆ sourceFileName()

OdString OdDbPointCloudDefEx::sourceFileName ( ) const

Returns the name of the external file containing the point cloud extension data (.rcp or .rcs) for this PointCloudEx Definition object (as it is stored in a file).

Returns
The name of the file containing the point cloud extension data.
Remarks
This PointCloudDefEx object must be open for reading.

◆ totalPointsCount()

OdUInt64 OdDbPointCloudDefEx::totalPointsCount ( ) const

Returns the total number of points of this OdDbPointCloudDefEx object.

Returns
A number of points as an OdUInt64 value.

◆ totalRegionsCount()

OdUInt32 OdDbPointCloudDefEx::totalRegionsCount ( ) const

Returns the total number of regions for this OdDbPointCloudDefEx object.

Returns
A number of regions as an OdUInt32 value.

◆ totalScansCount()

OdUInt32 OdDbPointCloudDefEx::totalScansCount ( ) const

Returns the total number of scans for this OdDbPointCloudDefEx object.

Returns
A number of scans as an OdUInt32 value.

◆ unload()

void OdDbPointCloudDefEx::unload ( )

Unloads the point cloud file for this PointCloudEx definition object.


The documentation for this class was generated from the following file: