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

#include <OdDbGeoDataMarker.h>

Inheritance diagram for OdDbGeoDataMarker:
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
 
 ~OdDbGeoDataMarker ()
 
void setView (OdGsView *pView, OdGsModel *pGsModel)
 
void clearView ()
 
OdGsViewPtr getView () 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 OdDbGeoDataMarkerPtr createObject ()
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Protected Member Functions

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

OdDbGeoDataMarker is OdDbGeoData location marker. It should be drawn only in active viewport, for both model and paper spaces when GEOMARKERVISIBILITY == true and GeoData is present in database. It shouldn't be drawn in paper space viewport if activeView is overallView.

<group OdDb_Classes>

Definition at line 45 of file OdDbGeoDataMarker.h.

Constructor & Destructor Documentation

◆ OdDbGeoDataMarker()

OdDbGeoDataMarker::OdDbGeoDataMarker ( )
protected

◆ ~OdDbGeoDataMarker()

OdDbGeoDataMarker::~OdDbGeoDataMarker ( )

Virtual destructor.

Member Function Documentation

◆ addRef()

void OdDbGeoDataMarker::addRef ( )
virtual

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.

◆ clearView()

void OdDbGeoDataMarker::clearView ( )

Clear current view value.

◆ createObject()

static OdDbGeoDataMarkerPtr OdDbGeoDataMarker::createObject ( )
static

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

◆ getView()

OdGsViewPtr OdDbGeoDataMarker::getView ( ) const

Get view in which current object is drawn.

Returns
Returns OdGsViewPtr or NULL if current view wasn't set.

◆ gsNode()

OdGsCache * OdDbGeoDataMarker::gsNode ( ) const
virtual

Retrieves the OdGsCache associated with this object.

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

Implements OdGiDrawable.

◆ id()

OdDbStub * OdDbGeoDataMarker::id ( ) const
virtual

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.

◆ isPersistent()

bool OdDbGeoDataMarker::isPersistent ( ) const
virtual

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

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

Implements OdGiDrawable.

◆ numRefs()

long OdDbGeoDataMarker::numRefs ( ) const
virtual

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.

◆ release()

void OdDbGeoDataMarker::release ( )
virtual

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.

◆ setGsNode()

void OdDbGeoDataMarker::setGsNode ( OdGsCache pGsNode)
virtual

Assigns the specified OdGsCache to this object.

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

Implements OdGiDrawable.

◆ setView()

void OdDbGeoDataMarker::setView ( OdGsView pView,
OdGsModel pGsModel 
)

Set view in which current object is drawn.

Parameters
pView[in] Pointer to an OdGsView object.
pGsModel[in] Pointer to an OdGsModel object.

◆ subSetAttributes()

OdUInt32 OdDbGeoDataMarker::subSetAttributes ( OdGiDrawableTraits pTraits) const
virtual

Implements OdGiDrawable.

◆ subViewportDraw()

void OdDbGeoDataMarker::subViewportDraw ( OdGiViewportDraw pVd) const
virtual

Implements OdGiDrawable.

◆ subWorldDraw()

bool OdDbGeoDataMarker::subWorldDraw ( OdGiWorldDraw pWd) const
virtual

Implements OdGiDrawable.


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