CFx SDK Documentation  2023 SP0
Public Types | Public Member Functions | List of all members
OdDbBaseLayoutPE Class Referenceabstract

#include <DbBaseDatabase.h>

Inheritance diagram for OdDbBaseLayoutPE:
OdRxObject

Public Types

enum  PlotRotation { k0degrees = 0 , k90degrees = 1 , k180degrees = 2 , k270degrees = 3 }
 

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdDbBaseLayoutPE)
 
virtual OdString name (const OdRxObject *)=0
 
virtual bool isModelLayout (const OdRxObject *)=0
 
virtual bool printLineweights (const OdRxObject *)=0
 
virtual bool showPlotStyles (const OdRxObject *)=0
 
virtual OdString paperName (const OdRxObject *)=0
 
virtual void getPaperSize (const OdRxObject *, double &paperWidth, double &paperHeight) const =0
 
virtual PlotRotation plotRotation (const OdRxObject *)=0
 
virtual double getTopMargin (const OdRxObject *)=0
 
virtual double getRightMargin (const OdRxObject *)=0
 
virtual double getBottomMargin (const OdRxObject *)=0
 
virtual double getLeftMargin (const OdRxObject *)=0
 
virtual bool isOverallVPortErased (const OdRxObject *)=0
 
virtual OdResult getGeomExtents (const OdRxObject *, OdGeExtents3d &ext)=0
 
virtual bool useStandardScale (const OdRxObject *)=0
 
virtual void getStdScale (const OdRxObject *, double &scale)=0
 
virtual void getCustomPrintScale (const OdRxObject *, double &numerator, double &denominator)=0
 
virtual int plotType (const OdRxObject *)=0
 
virtual OdString getPlotViewName (const OdRxObject *)=0
 
virtual void getPlotWindowArea (const OdRxObject *, double &xmin, double &ymin, double &xmax, double &ymax)=0
 
virtual void getPlotOrigin (const OdRxObject *, double &x, double &y)=0
 
virtual void getPlotPaperSize (const OdRxObject *, double &paperWidth, double &paperHeight)=0
 
virtual int plotPaperUnits (const OdRxObject *)=0
 
virtual OdDbStub * getBlockId (const OdRxObject *) const =0
 
virtual bool scalePSLinetypes (const OdRxObject *) const =0
 
virtual bool getApproxExtents (const OdRxObject *, OdGePoint3d &extMin, OdGePoint3d &extMax) const =0
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObject * queryX (const OdRxClass *pClass) const
 
virtual OdRxObject * x (const OdRxClass *pClass) const
 
virtual OdRxClass * isA () 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 OdRxClass * desc ()
 

Detailed Description

This class is the protocol extension to be used as a layout abstraction, independent of the underlying database (OdDbDatabase or OdDgDatabase).

See also
TD_DbRoot

<group OdDbRoot_Classes>

Definition at line 662 of file DbBaseDatabase.h.

Member Enumeration Documentation

◆ PlotRotation

enum OdDbBaseLayoutPE::PlotRotation

Determines the types of plot rotations.

Enumerator
k0degrees 

No rotation.

k90degrees 

90° CCW.

k180degrees 

Inverted.

k270degrees 

90° CW.

Definition at line 673 of file DbBaseDatabase.h.

Member Function Documentation

◆ getApproxExtents()

virtual bool OdDbBaseLayoutPE::getApproxExtents ( const OdRxObject *  ,
OdGePoint3d &  extMin,
OdGePoint3d &  extMax 
) const
pure virtual

Returns the approximate extents of a specified layout.

Parameters
[in]Apointer to a layout object.
extMin[in] A reference to an OdGePoint3d object to store and return the left lower corner of the extents rectangle.
extMax[in] A reference to an OdGePoint3d object to store and return the right upper corner of the extents rectangle.

◆ getBlockId()

virtual OdDbStub* OdDbBaseLayoutPE::getBlockId ( const OdRxObject *  ) const
pure virtual

Returns the block identifier for a specified layout.

Parameters
[in]Apointer to a layout object.

◆ getBottomMargin()

virtual double OdDbBaseLayoutPE::getBottomMargin ( const OdRxObject *  )
pure virtual

Returns the current bottom margin value for a specified layout.

Parameters
[in]Apointer to a layout object.

◆ getCustomPrintScale()

virtual void OdDbBaseLayoutPE::getCustomPrintScale ( const OdRxObject *  ,
double &  numerator,
double &  denominator 
)
pure virtual

Returns a custom print scale value for a specified layout.

Parameters
[in]Apointer to a layout object.
numerator[out] A reference to a double value to store and return the real world units.
denominator[out] A reference to a double value to store and return the drawing units.

◆ getGeomExtents()

virtual OdResult OdDbBaseLayoutPE::getGeomExtents ( const OdRxObject *  ,
OdGeExtents3d &  ext 
)
pure virtual

Returns current geometry extents of a specified layout object.

Parameters
[in]Apointer to a layout object.
ext[out] A reference to an OdGeExtents3d object to store and retrieve the layout's geometry extents.

◆ getLeftMargin()

virtual double OdDbBaseLayoutPE::getLeftMargin ( const OdRxObject *  )
pure virtual

Returns the current left margin value for a specified layout.

Parameters
[in]Apointer to a layout object.

◆ getPaperSize()

virtual void OdDbBaseLayoutPE::getPaperSize ( const OdRxObject *  ,
double &  paperWidth,
double &  paperHeight 
) const
pure virtual

Returns the current paper size for a specified layout.

Parameters
[in]Apointer to a layout object.
paperWidth[out] A reference for storing and retrieving paper width value.
paperHeight[out] A reference for storing and retrieving paper height value.

◆ getPlotOrigin()

virtual void OdDbBaseLayoutPE::getPlotOrigin ( const OdRxObject *  ,
double &  x,
double &  y 
)
pure virtual

Returns the current origin plot for a specified layout.

Parameters
[in]Apointer to a layout object.
x[out] A reference to be used for returning the X coordinate of the layout's plot origin.
y[out] A reference to be used for returning the Y coordinate of the layout's plot origin.

◆ getPlotPaperSize()

virtual void OdDbBaseLayoutPE::getPlotPaperSize ( const OdRxObject *  ,
double &  paperWidth,
double &  paperHeight 
)
pure virtual

Returns the current paper size for a specified layout.

Parameters
[in]Apointer to a layout object.
x[out] A reference to be used for returning the paper width value.
y[out] A reference to be used for returning the paper height value.

◆ getPlotViewName()

virtual OdString OdDbBaseLayoutPE::getPlotViewName ( const OdRxObject *  )
pure virtual

Returns a plot viewport name for a specified layout.

Parameters
Apointer to a layout object.

◆ getPlotWindowArea()

virtual void OdDbBaseLayoutPE::getPlotWindowArea ( const OdRxObject *  ,
double &  xmin,
double &  ymin,
double &  xmax,
double &  ymax 
)
pure virtual

Returns the current information about the plot window area for a specified layout.

Parameters
[in]Apointer to a layout object.
xmin[out] A reference to be used for returning the X coordinate of the window area's lower left corner.
ymin[out] A reference to be used for returning the Y coordinate of the window area's lower left corner.
xmax[out] A reference to be used for returning the X coordinate of the window area's upper right corner.
ymax[out] A reference to be used for returning the Y coordinate of the window area's upper right corner.

◆ getRightMargin()

virtual double OdDbBaseLayoutPE::getRightMargin ( const OdRxObject *  )
pure virtual

Returns the current right margin value for a specified layout.

Parameters
[in]Apointer to a layout object.

◆ getStdScale()

virtual void OdDbBaseLayoutPE::getStdScale ( const OdRxObject *  ,
double &  scale 
)
pure virtual

Returns the standard scale value for a specified layout.

Parameters
[in]Apointer to a layout object.
scale[out] A reference to a double value to store and return the scale value.

◆ getTopMargin()

virtual double OdDbBaseLayoutPE::getTopMargin ( const OdRxObject *  )
pure virtual

Returns the current top margin value for a specified layout.

Parameters
[in]Apointer to a layout object.

◆ isModelLayout()

virtual bool OdDbBaseLayoutPE::isModelLayout ( const OdRxObject *  )
pure virtual

Determines whether a specified layout belongs to model space.

Parameters
[in]Apointer to a layout object.
Returns
Returns true if the layout belongs to model space, otherwise returns false.

◆ isOverallVPortErased()

virtual bool OdDbBaseLayoutPE::isOverallVPortErased ( const OdRxObject *  )
pure virtual

Determines whether the overall viewport of a layout is erased.

Parameters
[in]Apointer to a layout object.
Returns
Returns true if the overall viewport of the layout is erased, otherwise returns false.

◆ name()

virtual OdString OdDbBaseLayoutPE::name ( const OdRxObject *  )
pure virtual

Returns the current name of a specified layout.

Parameters
[in]Apointer to a layout object.

◆ ODRX_DECLARE_MEMBERS()

OdDbBaseLayoutPE::ODRX_DECLARE_MEMBERS ( OdDbBaseLayoutPE  )

◆ paperName()

virtual OdString OdDbBaseLayoutPE::paperName ( const OdRxObject *  )
pure virtual

Returns the name of the paper orientation for a specified layout (for example, "A4").

Parameters
[in]Apointer to a layout object.

◆ plotPaperUnits()

virtual int OdDbBaseLayoutPE::plotPaperUnits ( const OdRxObject *  )
pure virtual

Returns the current plot units for a specified layout in paper space.

Parameters
[in]Apointer to a layout object.

◆ plotRotation()

virtual PlotRotation OdDbBaseLayoutPE::plotRotation ( const OdRxObject *  )
pure virtual

Returns the current plot rotation mode for a specified layout.

Parameters
[in]Apointer to a layout object.

◆ plotType()

virtual int OdDbBaseLayoutPE::plotType ( const OdRxObject *  )
pure virtual

Returns the current plot type for a specified layout.

Parameters
[in]Apointer to a layout object.

◆ printLineweights()

virtual bool OdDbBaseLayoutPE::printLineweights ( const OdRxObject *  )
pure virtual

Determines whether lineweights should be printed for a specified layout.

Parameters
[in]Apointer to a layout object.
Returns
Returns true if lineweights should be printed, otherwise returns false.

◆ scalePSLinetypes()

virtual bool OdDbBaseLayoutPE::scalePSLinetypes ( const OdRxObject *  ) const
pure virtual

Determines whether generation of linetypes for polylines is used in paper space for the specified layout.

Parameters
[in]Apointer to a layout object.

◆ showPlotStyles()

virtual bool OdDbBaseLayoutPE::showPlotStyles ( const OdRxObject *  )
pure virtual

Determines whether plot styles should be shown for a specified layout.

Parameters
[in]Apointer to a layout object.
Returns
Returns true if plot styles should be shown, otherwise returns false.

◆ useStandardScale()

virtual bool OdDbBaseLayoutPE::useStandardScale ( const OdRxObject *  )
pure virtual

Determines whether a standard scale is used for a specified layout.

Parameters
[in]Apointer to a layout object.
Returns
Returns true if a standard scale is used for the layout, otherwise returns false.
The documentation for this class was generated from the following file:
Generated on Thu Feb 24 2022 15:10:41