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

#include <OdDbGeoDataDrawingPE.h>

Inheritance diagram for OdDbGeoDataProvidersString:
OdGiDrawable OdRxObject

Public Member Functions

void addRef ()
 
void release ()
 
long numRefs () const
 
void setGsNode (OdGsCache *pGsNode)
 
OdGsCachegsNode () const
 
bool isPersistent () const
 
OdDbStub * id () const
 
OdUInt32 subSetAttributes (OdGiDrawableTraits *pTraits) const
 
bool subWorldDraw (OdGiWorldDraw *pWd) const
 
void subViewportDraw (OdGiViewportDraw *pVd) const
 
 ~OdDbGeoDataProvidersString ()
 
- 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 OdDbGeoDataProvidersStringPtr createObject ()
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Protected Member Functions

 OdDbGeoDataProvidersString ()
 
- 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
 

Additional Inherited Members

- 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
}
 

Detailed Description

This class represents implementation of OdGiDrawable, that is used to draw providers string for OdDbGeoData.

<group OdDb_Classes>

Definition at line 153 of file OdDbGeoDataDrawingPE.h.

Constructor & Destructor Documentation

◆ OdDbGeoDataProvidersString()

OdDbGeoDataProvidersString::OdDbGeoDataProvidersString ( )
protected

◆ ~OdDbGeoDataProvidersString()

OdDbGeoDataProvidersString::~OdDbGeoDataProvidersString ( )

Virtual destructor.

Member Function Documentation

◆ addRef()

void OdDbGeoDataProvidersString::addRef ( )
inlinevirtual

Declares the method incrementing the reference counter in objects derived from this class.

Remarks
It is the pure virtual method that does not have an implementation. You must redefine it in the derived class.
See also
<link smart_pointers_overview.html, Overview of Smart Pointer Classes>

Implements OdRxObject.

Definition at line 161 of file OdDbGeoDataDrawingPE.h.

◆ createObject()

static OdDbGeoDataProvidersStringPtr OdDbGeoDataProvidersString::createObject ( )
inlinestatic

It is the pseudo-constructor that creates an instance of this class and returns the typified smart pointer to it.

Definition at line 193 of file OdDbGeoDataDrawingPE.h.

◆ gsNode()

OdGsCache * OdDbGeoDataProvidersString::gsNode ( ) const
inlinevirtual

Retrieves the OdGsCache associated with this object.

Returns
Pointer to the OdGsCache that represents cache associated with this object.

Implements OdGiDrawable.

Definition at line 176 of file OdDbGeoDataDrawingPE.h.

◆ id()

OdDbStub * OdDbGeoDataProvidersString::id ( ) const
inlinevirtual

Retrieves the database ID of this object.

Returns
pointer to OdDbStub which represents a database identifier of this object.
Remarks
Returns a null pointer if this object is not persistent.

Implements OdGiDrawable.

Definition at line 178 of file OdDbGeoDataDrawingPE.h.

◆ isPersistent()

bool OdDbGeoDataProvidersString::isPersistent ( ) const
inlinevirtual

Checks whether this object is persistent (stored in a database).

Returns
true this object is persistent (stored in a database), false otherwise.

Implements OdGiDrawable.

Definition at line 177 of file OdDbGeoDataDrawingPE.h.

◆ numRefs()

long OdDbGeoDataProvidersString::numRefs ( ) const
inlinevirtual

Returns the value of the reference counter, that is, the number of references to an instance of this class.

Remarks
This method has the default implementation that returns 1. You shloud redefine it in the derived class.
See also
<link smart_pointers_overview.html, Overview of Smart Pointer Classes>

Reimplemented from OdRxObject.

Definition at line 173 of file OdDbGeoDataDrawingPE.h.

◆ release()

void OdDbGeoDataProvidersString::release ( )
inlinevirtual

Declares the method decrementing the reference counter in objects derived from this class.

Remarks
It is the pure virtual method that does not have an implementation. You must redefine it in the derived class.
See also
<link smart_pointers_overview.html, Overview of Smart Pointer Classes>

Implements OdRxObject.

Definition at line 165 of file OdDbGeoDataDrawingPE.h.

◆ setGsNode()

void OdDbGeoDataProvidersString::setGsNode ( OdGsCache pGsNode)
inlinevirtual

Assigns the specified OdGsCache to this object.

Parameters
pGsNode[in] Pointer to the OdGsCache to be assigned.

Implements OdGiDrawable.

Definition at line 175 of file OdDbGeoDataDrawingPE.h.

◆ subSetAttributes()

OdUInt32 OdDbGeoDataProvidersString::subSetAttributes ( OdGiDrawableTraits pTraits) const
virtual

Implements OdGiDrawable.

◆ subViewportDraw()

void OdDbGeoDataProvidersString::subViewportDraw ( OdGiViewportDraw pVd) const
virtual

Implements OdGiDrawable.

◆ subWorldDraw()

bool OdDbGeoDataProvidersString::subWorldDraw ( OdGiWorldDraw pWd) const
virtual

Implements OdGiDrawable.


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