#include <DbGsManager.h>

Inheritance diagram for OdGsLayoutHelper:

Public Member Functions
	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

Static Public Member Functions
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 41 of file DbGsManager.h.

Member Function Documentation

◆ activeView()

virtual OdGsViewPtr OdGsLayoutHelper::activeView ( ) const

pure virtual

Returns the active GsView object of the Layout object associated with this LayoutHelper object.

◆ extractLayoutIdForGsState()

static bool OdGsLayoutHelper::extractLayoutIdForGsState	(	OdStreamBuf *	pStream,
		OdDbDatabase *	pDb,
		OdDbObjectId &	layoutObjId,
		OdUInt32	nFlags = `0`
	)

static

Extracts Layout object Id from Gs state stream.

Parameters

pStream	[in] Pointer onto OdStreamBuf object into which Gs state will be stored.
pDb	[in] Opened database pointer.
layoutObjId	[out] Layout object Id will be returned through this argument.
nFlags	[in] Optional flags.

◆ gsModel()

virtual OdGsModel* OdGsLayoutHelper::gsModel ( )

pure virtual

Return the OdGsModel object associated with this layout helper.

◆ layoutId()

virtual OdDbObjectId OdGsLayoutHelper::layoutId ( ) const

pure virtual

Returns the Layout object associated with this LayoutHelper object.

◆ makeViewActive()

virtual void OdGsLayoutHelper::makeViewActive ( OdGsView * pView )

pure virtual

Sets the active GsView object of the Layout object associated with this LayoutHelper object.

Parameters

pView [in] Pointer to the GsView.

◆ ODRX_DECLARE_MEMBERS()

OdGsLayoutHelper::ODRX_DECLARE_MEMBERS ( OdGsLayoutHelper )

◆ restoreGsViewDbLinkState()

virtual void OdGsLayoutHelper::restoreGsViewDbLinkState ( )

pure virtual

Restores layout GsView database linkages state.

◆ restoreLayoutGsState()

virtual bool OdGsLayoutHelper::restoreLayoutGsState	(	OdStreamBuf *	pStream,
		OdUInt32	nFlags = `0`
	)

pure virtual

Restores Gs state compatible with this LayoutHelper object.

Parameters

pStream	[in] Pointer onto OdStreamBuf object from which Gs state will be restored.
nFlags	[in] Optional flags.
pRetFiler	[out] Returns filer object invoked for state loading.

◆ setActiveViewport() [1/2]

virtual bool OdGsLayoutHelper::setActiveViewport ( const OdDbObjectId & id )

pure virtual

Parameters

id	[in] ObjectId of viewport which will be made active.

◆ setActiveViewport() [2/2]

virtual bool OdGsLayoutHelper::setActiveViewport ( const OdGePoint2d & screenPt )

pure virtual

Sets the active viewport

Parameters

at	[in] Pick point in device coordinates.

◆ storeLayoutGsState()

virtual bool OdGsLayoutHelper::storeLayoutGsState	(	OdStreamBuf *	pStream,
		OdUInt32	nFlags = `0`
	)		const

pure virtual

Stores Gs state compatible with this LayoutHelper object.

Parameters

pStream	[in] Pointer onto OdStreamBuf object into which Gs state will be stored.
nFlags	[in] Optional flags.

◆ supportLayoutGsStateSaving()

virtual bool OdGsLayoutHelper::supportLayoutGsStateSaving ( ) const

pure virtual

Checks does underlying device supports Gs state saving/loading.

◆ underlyingDevice()

virtual OdGsDevicePtr OdGsLayoutHelper::underlyingDevice ( ) const

pure virtual

Returns the underlying OdGsDevice object associated with this LayoutHelper object.

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

DbGsManager.h

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ activeView()

◆ extractLayoutIdForGsState()

◆ gsModel()

◆ layoutId()

◆ makeViewActive()

◆ ODRX_DECLARE_MEMBERS()

◆ restoreGsViewDbLinkState()

◆ restoreLayoutGsState()

◆ setActiveViewport() [1/2]

◆ setActiveViewport() [2/2]

◆ storeLayoutGsState()

◆ supportLayoutGsStateSaving()

◆ underlyingDevice()