CFx SDK Documentation  2020SP3
Public Member Functions | List of all members
OdDbAbstractPlotData Class Referenceabstract

#include <DbAbstractPlotData.h>

Inheritance diagram for OdDbAbstractPlotData:
OdRxObject OdDbAbstractPlotDataForDbPlotSettings OdDbAbstractPlotDataForDbViewport

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdDbAbstractPlotData)
 
virtual void setProps (OdRxObject *pDstPlotObj, const OdRxObject *pSrcPlotObj) const
 
virtual bool useStandardScale (const OdRxObject *pPlotObj) const =0
 
virtual double customScale (const OdRxObject *pPlotObj) const =0
 
virtual void setCustomScale (OdRxObject *pPlotObj, double customScale) const =0
 
virtual OdDbPlotSettings::StdScaleType standardScale (const OdRxObject *pPlotObj) const =0
 
virtual void setStandardScale (OdRxObject *pPlotObj, const OdDbPlotSettings::StdScaleType standardScale) const =0
 
virtual OdString styleSheet (const OdRxObject *pPlotObj) const =0
 
virtual void setStyleSheet (OdRxObject *pPlotObj, const OdString &styleSheetName) const =0
 
virtual OdDbPlotSettings::ShadePlotType shadePlot (const OdRxObject *pPlotObj) const =0
 
virtual void setShadePlot (OdRxObject *pPlotObj, OdDbPlotSettings::ShadePlotType shadePlotSet) const =0
 
virtual OdDbObjectId shadePlotId (const OdRxObject *pPlotObj) const =0
 
virtual void setShadePlot (OdRxObject *pPlotObj, OdDbPlotSettings::ShadePlotType type, OdDbObjectId shadePlotId) const =0
 
virtual bool plotHiddenLines (const OdRxObject *pPlotObj) const =0
 
virtual void setPlotHiddenLines (OdRxObject *pPlotObj, bool plotHidden) const =0
 
virtual bool plotWireframe (const OdRxObject *pPlotObj) const =0
 
virtual bool plotAsRaster (const OdRxObject *pPlotObj) const =0
 
virtual bool plotTransparency (const OdRxObject *pPlotObj) const =0
 
virtual void setPlotTransparency (OdRxObject *pPlotObj, bool bEnable) const =0
 
virtual bool modelType (const OdRxObject *pPlotObj) const =0
 
virtual void setModelType (OdRxObject *pPlotObj, bool modelTypeSet)=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
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

This class is the base class for Protocol Extension classes for OdDbViewport and OdDbPlotSettings objects.

Corresponding C++ library: TD_Db

Remarks
Only the following objects are supported:

OdDbViewport OdDbPlotSettings Derivatives of one of the above.

<group OdDb_Classes>

Definition at line 45 of file DbAbstractPlotData.h.

Member Function Documentation

◆ customScale()

virtual double OdDbAbstractPlotData::customScale ( const OdRxObject pPlotObj) const
pure virtual

Returns the custom print scale for this Plot object.

Parameters
pPlotObj[in] Pointer to the Plot object.

Implemented in OdDbAbstractPlotDataForDbViewport, and OdDbAbstractPlotDataForDbPlotSettings.

◆ modelType()

virtual bool OdDbAbstractPlotData::modelType ( const OdRxObject pPlotObj) const
pure virtual

Returns true if and only if this Plot object is of ModelSpace type.

Parameters
pPlotObj[in] Pointer to the Plot object.

Implemented in OdDbAbstractPlotDataForDbViewport, and OdDbAbstractPlotDataForDbPlotSettings.

◆ ODRX_DECLARE_MEMBERS()

OdDbAbstractPlotData::ODRX_DECLARE_MEMBERS ( OdDbAbstractPlotData  )

◆ plotAsRaster()

virtual bool OdDbAbstractPlotData::plotAsRaster ( const OdRxObject pPlotObj) const
pure virtual

Controls whether the output is raster-based when using shade plot settings of a viewport.

Parameters
pPlotObj[in] Pointer to the Plot object.

Implemented in OdDbAbstractPlotDataForDbViewport, and OdDbAbstractPlotDataForDbPlotSettings.

◆ plotHiddenLines()

virtual bool OdDbAbstractPlotData::plotHiddenLines ( const OdRxObject pPlotObj) const
pure virtual

Returns true if and only if the hidden line removal algorithm is to be applied to entities for this Plot object.

Parameters
pPlotObj[in] Pointer to the Plot object.

Implemented in OdDbAbstractPlotDataForDbViewport, and OdDbAbstractPlotDataForDbPlotSettings.

◆ plotTransparency()

virtual bool OdDbAbstractPlotData::plotTransparency ( const OdRxObject pPlotObj) const
pure virtual

Returns true if and only if transparencies plotting enabled for this Plot object.

Implemented in OdDbAbstractPlotDataForDbViewport, and OdDbAbstractPlotDataForDbPlotSettings.

◆ plotWireframe()

virtual bool OdDbAbstractPlotData::plotWireframe ( const OdRxObject pPlotObj) const
pure virtual

Controls whether the output is vector-based when using shade plot settings of a viewport.

Parameters
pPlotObj[in] Pointer to the Plot object.

Implemented in OdDbAbstractPlotDataForDbViewport, and OdDbAbstractPlotDataForDbPlotSettings.

◆ setCustomScale()

virtual void OdDbAbstractPlotData::setCustomScale ( OdRxObject pPlotObj,
double  customScale 
) const
pure virtual

Sets the custom scale of this Plot object.

Parameters
pPlotObj[in] Pointer to the Plot object.
customScale[in] Custom scale.

Implemented in OdDbAbstractPlotDataForDbViewport, and OdDbAbstractPlotDataForDbPlotSettings.

◆ setModelType()

virtual void OdDbAbstractPlotData::setModelType ( OdRxObject pPlotObj,
bool  modelTypeSet 
)
pure virtual

Controls the ModelSpace type of this Plot object.

Parameters
pPlotObj[in] Pointer to the Plot object.
modelTypeSet[in] True if and only if it is of ModelSpace type.

Implemented in OdDbAbstractPlotDataForDbViewport, and OdDbAbstractPlotDataForDbPlotSettings.

◆ setPlotHiddenLines()

virtual void OdDbAbstractPlotData::setPlotHiddenLines ( OdRxObject pPlotObj,
bool  plotHidden 
) const
pure virtual

Controls the application of the hidden line removal algorithm to entities for this Plot object.

Parameters
pPlotObj[in] Pointer to the Plot object.
plotHidden[in] True if and only hidden lines are to be removed.

Implemented in OdDbAbstractPlotDataForDbViewport, and OdDbAbstractPlotDataForDbPlotSettings.

◆ setPlotTransparency()

virtual void OdDbAbstractPlotData::setPlotTransparency ( OdRxObject pPlotObj,
bool  bEnable 
) const
pure virtual

Controls transparencies plotting for this Plot object.

Parameters
pPlotObj[in] Pointer to the Plot object.
bEnable[in] New transparencies plotting setting.

Implemented in OdDbAbstractPlotDataForDbViewport, and OdDbAbstractPlotDataForDbPlotSettings.

◆ setProps()

virtual void OdDbAbstractPlotData::setProps ( OdRxObject pDstPlotObj,
const OdRxObject pSrcPlotObj 
) const
virtual

Sets the parameters for the specified Plot object according to the arguments.

Parameters
pDstPlotObj[in] Pointer to the destination Plot object
pSrcPlotObj[in] Pointer to the source Plot object.

◆ setShadePlot() [1/2]

virtual void OdDbAbstractPlotData::setShadePlot ( OdRxObject pPlotObj,
OdDbPlotSettings::ShadePlotType  shadePlotSet 
) const
pure virtual

Sets the shade plot type for this Plot object.

Parameters
pPlotObj[in] Pointer to the Plot object.
shadePlotSet[in] New shade plot setting.

Implemented in OdDbAbstractPlotDataForDbViewport, and OdDbAbstractPlotDataForDbPlotSettings.

◆ setShadePlot() [2/2]

virtual void OdDbAbstractPlotData::setShadePlot ( OdRxObject pPlotObj,
OdDbPlotSettings::ShadePlotType  type,
OdDbObjectId  shadePlotId 
) const
pure virtual

Sets the shade plot type and OdDbObjectId of the OdDbVisualStyle or OdDbRenderSettings object for this Plot object.

Parameters
pPlotObj[in] Pointer to the Plot object.
type[in] New shade plot setting.
shadePlotId[in] OdDbObjectId of the OdDbVisualStyle or OdDbRenderSettings object for this Plot object.

Implemented in OdDbAbstractPlotDataForDbViewport, and OdDbAbstractPlotDataForDbPlotSettings.

◆ setStandardScale()

virtual void OdDbAbstractPlotData::setStandardScale ( OdRxObject pPlotObj,
const OdDbPlotSettings::StdScaleType  standardScale 
) const
pure virtual

Sets the standard scale type of this Plot object.

Parameters
pPlotObj[in] Pointer to the Plot object.
standardScale[in] Standard scale type.

Implemented in OdDbAbstractPlotDataForDbViewport, and OdDbAbstractPlotDataForDbPlotSettings.

◆ setStyleSheet()

virtual void OdDbAbstractPlotData::setStyleSheet ( OdRxObject pPlotObj,
const OdString styleSheetName 
) const
pure virtual

Sets the plot style sheet name associated with this Plot object.

Parameters
pPlotObj[in] Pointer to the Plot object.
styleSheetName[in] Style sheet name.

Implemented in OdDbAbstractPlotDataForDbViewport, and OdDbAbstractPlotDataForDbPlotSettings.

◆ shadePlot()

virtual OdDbPlotSettings::ShadePlotType OdDbAbstractPlotData::shadePlot ( const OdRxObject pPlotObj) const
pure virtual

Returns the shade plot type for this Plot object.

Parameters
pPlotObj[in] Pointer to the Plot object.

Implemented in OdDbAbstractPlotDataForDbViewport, and OdDbAbstractPlotDataForDbPlotSettings.

◆ shadePlotId()

virtual OdDbObjectId OdDbAbstractPlotData::shadePlotId ( const OdRxObject pPlotObj) const
pure virtual

Returns the OdDbObjectId of the OdDbVisualStyle or OdDbRenderSettings object referenced by this object.

Parameters
pPlotObj[in] Pointer to the Plot object.

Implemented in OdDbAbstractPlotDataForDbViewport, and OdDbAbstractPlotDataForDbPlotSettings.

◆ standardScale()

virtual OdDbPlotSettings::StdScaleType OdDbAbstractPlotData::standardScale ( const OdRxObject pPlotObj) const
pure virtual

Returns the standard scale type of this Plot object.

Parameters
pPlotObj[in] Pointer to the Plot object.

Implemented in OdDbAbstractPlotDataForDbViewport, and OdDbAbstractPlotDataForDbPlotSettings.

◆ styleSheet()

virtual OdString OdDbAbstractPlotData::styleSheet ( const OdRxObject pPlotObj) const
pure virtual

Returns the current style sheet.

Parameters
pPlotObj[in] Pointer to the Plot object.

Implemented in OdDbAbstractPlotDataForDbViewport, and OdDbAbstractPlotDataForDbPlotSettings.

◆ useStandardScale()

virtual bool OdDbAbstractPlotData::useStandardScale ( const OdRxObject pPlotObj) const
pure virtual

Returns true if and only if this Plot object uses a standard scale.

Parameters
pPlotObj[in] Pointer to the Plot object.

Implemented in OdDbAbstractPlotDataForDbViewport, and OdDbAbstractPlotDataForDbPlotSettings.


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