OdGsPaperLayoutHelper Class Reference

#include <DbGsManager.h>

Inheritance diagram for OdGsPaperLayoutHelper:

Public Types
enum	ViewportFilter { kVpScreenFilter = (1 << 0) , kVpSizeFilter = (1 << 1) , kVpMaxActFilter = (1 << 2) }
enum	ViewportFilterBranch { kVpBrDefault = 1 , kVpBrPlot = 2 , kVpBrAll = 3 }
enum	ViewportFilterMode { kVpFilterVisible = 3 , kVpFilterInvisible = 1 , kVpFilterDisable = 0 }

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGsPaperLayoutHelper)
virtual OdGsViewPtr	overallView () const =0
virtual void	makeViewOverall (OdGsView *pView)=0
virtual void	initGsView (OdGsView *pView, const OdDbViewport *pVp)=0
virtual OdGsViewPtr	addViewport (const OdDbViewport *pVp)
virtual OdGsViewPtr	insertViewport (int viewIndex, const OdDbViewport *pVp)
virtual void	setViewportFilter (ViewportFilter vpFilter, ViewportFilterBranch filterBranch=kVpBrAll, ViewportFilterMode filterMode=kVpFilterVisible, OdUInt32 filterParam=0)
Public Member Functions inherited from OdGsLayoutHelper
	ODRX_DECLARE_MEMBERS (OdGsLayoutHelper)
virtual OdDbObjectId	layoutId () const =0
virtual OdGsViewPtr	activeView () const =0
virtual void	makeViewActive (OdGsView *pView)=0
virtual OdGsModel *	gsModel ()=0
virtual OdGsDevicePtr	underlyingDevice () const =0
virtual bool	setActiveViewport (const OdGePoint2d &screenPt)=0
virtual bool	setActiveViewport (const OdDbObjectId &id)=0
virtual void	restoreGsViewDbLinkState ()=0
virtual bool	supportLayoutGsStateSaving () const =0
virtual bool	storeLayoutGsState (OdStreamBuf *pStream, OdUInt32 nFlags=0) const =0
virtual bool	restoreLayoutGsState (OdStreamBuf *pStream, OdUInt32 nFlags=0)=0
Public Member Functions inherited from OdGsDevice
	ODRX_DECLARE_MEMBERS (OdGsDevice)
virtual OdRxDictionaryPtr	properties ()=0
virtual OdGiContext *	userGiContext () const =0
virtual void	setUserGiContext (OdGiContext *pUserGiContext)=0
virtual void	invalidate ()=0
virtual void	invalidate (const OdGsDCRect &screenRect)=0
virtual bool	isValid () const =0
virtual void	update (OdGsDCRect *pUpdatedRect=0)=0
virtual void	onSize (const OdGsDCRect &outputRect)=0
virtual void	onSize (const OdGsDCRectDouble &outputRect)
virtual void	getSize (OdGsDCRect &outputRect) const =0
virtual void	getSize (OdGsDCRectDouble &outputRect) const
virtual void	onRealizeForegroundPalette ()=0
virtual void	onRealizeBackgroundPalette ()=0
virtual void	onDisplayChange (int bitsPerPixel, int xPixels, int yPixels)=0
virtual OdGsViewPtr	createView (const OdGsClientViewInfo *pViewInfo=0, bool enableLayerVisibilityPerView=false)=0
virtual void	addView (OdGsView *pView)=0
virtual OdGsModelPtr	createModel ()=0
virtual bool	isModelCompatible (OdGsModel *pModel) const
virtual bool	saveDeviceState (OdGsFiler *pFiler) const
virtual bool	loadDeviceState (OdGsFiler *pFiler)
virtual void	insertView (int viewIndex, OdGsView *pView)=0
virtual bool	eraseView (OdGsView *pView)=0
virtual bool	eraseView (int viewIndex)=0
virtual void	eraseAllViews ()=0
virtual int	numViews () const =0
virtual OdGsView *	viewAt (int viewIndex)=0
virtual bool	setBackgroundColor (ODCOLORREF backgroundColor)=0
virtual ODCOLORREF	getBackgroundColor ()=0
virtual void	setLogicalPalette (const ODCOLORREF *logicalPalette, int numColors)=0
virtual const ODCOLORREF *	getLogicalPalette (int &numColors) const =0
virtual void	getSnapShot (OdGiRasterImagePtr &pImage, const OdGsDCRect &region)=0
virtual OdGsUpdateManagerPtr	getUpdateManager (bool createIfNotExist=false)
virtual void	setUpdateManager (OdGsUpdateManagerPtr pManager)
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 OdGsLayoutHelper
static bool	extractLayoutIdForGsState (OdStreamBuf *pStream, OdDbDatabase *pDb, OdDbObjectId &layoutObjId, OdUInt32 nFlags=0)
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

Corresponding C++ library: TD_Db <group OdGs_Classes>

Definition at line 118 of file DbGsManager.h.

Member Enumeration Documentation

ViewportFilter

enum OdGsPaperLayoutHelper::ViewportFilter

Viewport filter type.

Enumerator
kVpScreenFilter
kVpSizeFilter
kVpMaxActFilter

Definition at line 135 of file DbGsManager.h.

ViewportFilterBranch

enum OdGsPaperLayoutHelper::ViewportFilterBranch

Viewport filter branch.

Enumerator
kVpBrDefault
kVpBrPlot
kVpBrAll

Definition at line 144 of file DbGsManager.h.

ViewportFilterMode

enum OdGsPaperLayoutHelper::ViewportFilterMode

Viewport filter application mode.

Enumerator
kVpFilterVisible
kVpFilterInvisible
kVpFilterDisable

Definition at line 153 of file DbGsManager.h.

Member Function Documentation

addViewport()

virtual OdGsViewPtr OdGsPaperLayoutHelper::addViewport ( const OdDbViewport *  pVp )

virtual

initGsView()

virtual void OdGsPaperLayoutHelper::initGsView ( OdGsView *  pView, const OdDbViewport *  pVp  )

pure virtual

insertViewport()

virtual OdGsViewPtr OdGsPaperLayoutHelper::insertViewport ( int  viewIndex, const OdDbViewport *  pVp  )

virtual

makeViewOverall()

virtual void OdGsPaperLayoutHelper::makeViewOverall ( OdGsView *  pView )

pure virtual

ODRX_DECLARE_MEMBERS()

OdGsPaperLayoutHelper::ODRX_DECLARE_MEMBERS

(

OdGsPaperLayoutHelper

)

overallView()

virtual OdGsViewPtr OdGsPaperLayoutHelper::overallView ( ) const

pure virtual

setViewportFilter()

virtual void OdGsPaperLayoutHelper::setViewportFilter ( ViewportFilter  vpFilter, ViewportFilterBranch  filterBranch = kVpBrAll, ViewportFilterMode  filterMode = kVpFilterVisible, OdUInt32  filterParam = 0  )

virtual

Setup specified viewport filter parameters.

Parameters

vpFilter	[in] Specify filter type for parameters setup.
filterBranch	[in] Specify filter branch(es) for parameters setup.
filterMode	[in] Specify filter application mode.
filterParam	[in] Specify filter parameter (actual for size filter only, where it is mean minimal viewport size in pixels).

---

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

• DbGsManager.h