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

#include <GiPointCloud.h>

Inheritance diagram for OdGiPointCloud:
OdRxObject

Classes

struct  Components
 
struct  ComponentsRaw
 

Public Types

enum  Component { kVertexComponent = 0 , kColorComponent , kNormalComponent , kNumComponents }
 
enum  ExtraComponent { kTransparencyComponent = kNumComponents , kNumExtraComponents }
 
enum  ComponentMask { kNoComponents = 0 , kColors = (1 << 0) , kTransparencies = (1 << 1) , kNormals = (1 << 2) }
 
enum  DataSize { kDataSizeByte = 0 , kDataSizeWord , kDataSizeFloat , kDataSizeDouble }
 
enum  Flags { kLastComponentFlag = (1 << (kNumComponents << 1)) , kAsyncCall = (kLastComponentFlag << 0) , kPartialData = (kLastComponentFlag << 1) , kLastFlag = kPartialData }
 
typedef OdArray< ComponentsComponentsArray
 
typedef OdArray< ComponentsRaw, OdMemoryAllocator< ComponentsRaw > > ComponentsRawArray
 

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdGiPointCloud)
 
virtual OdUInt32 totalPointsCount () const =0
 
virtual OdUInt32 componentsMask () const
 
virtual OdUInt32 supportFlags (Component component=kNumComponents) const
 
virtual const OdGeMatrix3dglobalTransform () const
 
virtual OdInt32 defaultPointSize () const
 
virtual bool getExtents (OdGeBoundBlock3d &) const
 
virtual bool calculateExtents (OdGeExtents3d &extents, const OdGiPointCloudFilter *pFilter=NULL) const
 
virtual bool isDataCompatible (const OdGiViewport &pVp1, const OdGiViewport &pVp2) const =0
 
virtual bool updatePointsData (OdGiPointCloudReceiver *pReceiver, OdUInt32 components=kNoComponents, OdUInt32 flags=0, const OdGiViewport *pVp=NULL, const OdGiViewport *pVpFrom=NULL, OdUInt32 pointSize=0) const =0
 
- 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 OdUInt32 addDataSizeFlags (OdUInt32 *pFlags, Component component, DataSize ds)
 
static DataSize getDataSizeFlags (OdUInt32 flags, Component component)
 
static OdUInt32 getDefaultDataSizeFlags ()
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

Basic point cloud interface object.

<group OdGi_Classes>

Definition at line 49 of file GiPointCloud.h.

Member Typedef Documentation

◆ ComponentsArray

Definition at line 117 of file GiPointCloud.h.

◆ ComponentsRawArray

Definition at line 138 of file GiPointCloud.h.

Member Enumeration Documentation

◆ Component

Enumerator
kVertexComponent 
kColorComponent 
kNormalComponent 
kNumComponents 

Definition at line 52 of file GiPointCloud.h.

◆ ComponentMask

Enumerator
kNoComponents 
kColors 
kTransparencies 
kNormals 

Definition at line 65 of file GiPointCloud.h.

◆ DataSize

Enumerator
kDataSizeByte 
kDataSizeWord 
kDataSizeFloat 
kDataSizeDouble 

Definition at line 71 of file GiPointCloud.h.

◆ ExtraComponent

Enumerator
kTransparencyComponent 
kNumExtraComponents 

Definition at line 60 of file GiPointCloud.h.

◆ Flags

Enumerator
kLastComponentFlag 
kAsyncCall 
kPartialData 
kLastFlag 

Definition at line 78 of file GiPointCloud.h.

Member Function Documentation

◆ addDataSizeFlags()

static OdUInt32 OdGiPointCloud::addDataSizeFlags ( OdUInt32 pFlags,
Component  component,
DataSize  ds 
)
inlinestatic

Helper function to set data type size into flags.

Definition at line 90 of file GiPointCloud.h.

◆ calculateExtents()

virtual bool OdGiPointCloud::calculateExtents ( OdGeExtents3d extents,
const OdGiPointCloudFilter pFilter = NULL 
) const
virtual

Return extents of point cloud entity.

◆ componentsMask()

virtual OdUInt32 OdGiPointCloud::componentsMask ( ) const
inlinevirtual

Returns set of data components available for point cloud entity (see ComponentsMask enum).

Definition at line 149 of file GiPointCloud.h.

◆ defaultPointSize()

virtual OdInt32 OdGiPointCloud::defaultPointSize ( ) const
inlinevirtual

Returns default point size.

Definition at line 167 of file GiPointCloud.h.

◆ getDataSizeFlags()

static DataSize OdGiPointCloud::getDataSizeFlags ( OdUInt32  flags,
Component  component 
)
inlinestatic

Helper function extracts data type size from flags.

Definition at line 98 of file GiPointCloud.h.

◆ getDefaultDataSizeFlags()

static OdUInt32 OdGiPointCloud::getDefaultDataSizeFlags ( )
inlinestatic

Returns default point cloud setting (actual for Gi implementation).

Definition at line 105 of file GiPointCloud.h.

◆ getExtents()

virtual bool OdGiPointCloud::getExtents ( OdGeBoundBlock3d ) const
inlinevirtual

Return extents of point cloud entity.

Definition at line 172 of file GiPointCloud.h.

◆ globalTransform()

virtual const OdGeMatrix3d & OdGiPointCloud::globalTransform ( ) const
inlinevirtual

Returns global transformation, which should be applied by underlying renderer to render point could data.

Definition at line 163 of file GiPointCloud.h.

◆ isDataCompatible()

virtual bool OdGiPointCloud::isDataCompatible ( const OdGiViewport pVp1,
const OdGiViewport pVp2 
) const
pure virtual

Check that point data compatible for specified viewports.

◆ ODRX_DECLARE_MEMBERS()

OdGiPointCloud::ODRX_DECLARE_MEMBERS ( OdGiPointCloud  )

◆ supportFlags()

virtual OdUInt32 OdGiPointCloud::supportFlags ( Component  component = kNumComponents) const
inlinevirtual

Returns format support flags. If set to any component except kNumComponents returns bit flags represent support data type sizes: 1 - byte, 2 - short, 4 - float, 8 - double. For color 2 means OdCmEntityColor+OdCmTransparency combination. If set to kNumComponents return flags (see Flags enum). By default: Vertex as doubles, Colors as OdCmEntityColor, Normals as doubles and No Flags.

Definition at line 157 of file GiPointCloud.h.

◆ totalPointsCount()

virtual OdUInt32 OdGiPointCloud::totalPointsCount ( ) const
pure virtual

Returns total number of points, contained by point cloud entity.

◆ updatePointsData()

virtual bool OdGiPointCloud::updatePointsData ( OdGiPointCloudReceiver pReceiver,
OdUInt32  components = kNoComponents,
OdUInt32  flags = 0,
const OdGiViewport pVp = NULL,
const OdGiViewport pVpFrom = NULL,
OdUInt32  pointSize = 0 
) const
pure virtual

Compute point cloud data.


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