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

#include <DbLayoutPaperPE.h>

Inheritance diagram for OdDbLayoutPaperPE:
OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdDbLayoutPaperPE)
 
virtual bool drawPaper (const OdDbLayout *pThis, OdGiWorldDraw *pWd, OdGePoint3d *points)=0
 
virtual bool drawBorder (const OdDbLayout *pThis, OdGiWorldDraw *pWd, OdGePoint3d *points)=0
 
virtual bool drawMargins (const OdDbLayout *pThis, OdGiWorldDraw *pWd, OdGePoint3d *points)=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 Protocol Extension class for OdDbLayout objects.

Remarks
The Protocol Extension class can be registered on the OdDbLayout class to provide a vectorization client the opportunity to customize the drawing of the background paper during PaperSpace vectorization.
See also
TD_Db

<group OdDb_Classes>

Definition at line 45 of file DbLayoutPaperPE.h.

Member Function Documentation

◆ drawBorder()

virtual bool OdDbLayoutPaperPE::drawBorder ( const OdDbLayout pThis,
OdGiWorldDraw pWd,
OdGePoint3d points 
)
pure virtual

This function is called during vectorization to draw the paper border.

Parameters
pThis[in] The layout that is being vectorized.
pWd[in/out] Draw object that can be used by this function to set the necessary attributes and create the necessary geometry.
points[in] Contains the 4 corners of the paper.
Returns
true if the border was successfully drawn, otherwise false, in which case the layout will do a default rendering of the border.

◆ drawMargins()

virtual bool OdDbLayoutPaperPE::drawMargins ( const OdDbLayout pThis,
OdGiWorldDraw pWd,
OdGePoint3d points 
)
pure virtual

This function is called during vectorization to draw the paper margins.

Parameters
pThis[in] The layout that is being vectorized.
pWd[in/out] Draw object that can be used by this function to set the necessary attributes and create the necessary geometry.
points[in] Contains the 4 margin points.
Returns
true if the margins were successfully drawn, otherwise false, in which case the layout will do a default rendering of the margins.

◆ drawPaper()

virtual bool OdDbLayoutPaperPE::drawPaper ( const OdDbLayout pThis,
OdGiWorldDraw pWd,
OdGePoint3d points 
)
pure virtual

This function is called during vectorization to draw the paper.

Parameters
pThis[in] The layout that is being vectorized.
pWd[in/out] Draw object that can be used by this function to set the necessary attributes and create the necessary geometry.
points[in] Contains the 4 corners of the paper.
Returns
true if the paper was successfully drawn, otherwise false, in which case the layout will do a default rendering of the paper.

◆ ODRX_DECLARE_MEMBERS()

OdDbLayoutPaperPE::ODRX_DECLARE_MEMBERS ( OdDbLayoutPaperPE  )

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