OdGsIfcLayoutHelper Class Reference

#include <IfcGsManager.h>

Inheritance diagram for OdGsIfcLayoutHelper:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGsIfcLayoutHelper)
virtual OdDAIObjectId	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 OdDAIObjectId &id)=0
virtual void	restoreGsViewDbLinkState ()=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 OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

An abstract class that implements base functionality for working with layout views.

Definition at line 38 of file IfcGsManager.h.

Member Function Documentation

activeView()

virtual OdGsViewPtr OdGsIfcLayoutHelper::activeView ( ) const

pure virtual

Retrieves the current active Gs view object associated with the object.

Returns

Returns a smart pointer to the <exref target="https://docs.opendesign.com/tv/OdGsView.html">OdGsView</exref> object.

gsModel()

virtual OdGsModel * OdGsIfcLayoutHelper::gsModel ( )

pure virtual

Retrieves the current Gs model instance associated with the object.

Returns

Returns a raw pointer to the <exref target="https://docs.opendesign.com/tv/OdGsModel.html">OdGsModel</exref> object associated with the object.

layoutId()

virtual OdDAIObjectId OdGsIfcLayoutHelper::layoutId ( ) const

pure virtual

Retrieves the current layout identifier.

Returns

Returns the layout object's identifier associated with the object.

makeViewActive()

virtual void OdGsIfcLayoutHelper::makeViewActive ( OdGsView *  pView )

pure virtual

Sets a new active Gs view for the layout associated with the object.

Parameters

pView

[in] A raw pointer to the <exref target="https://docs.opendesign.com/tv/OdGsView.html">OdGsView</exref> object.

ODRX_DECLARE_MEMBERS()

OdGsIfcLayoutHelper::ODRX_DECLARE_MEMBERS

(

OdGsIfcLayoutHelper

)

restoreGsViewDbLinkState()

virtual void OdGsIfcLayoutHelper::restoreGsViewDbLinkState ( )

pure virtual

Restores the layout GsView database linkage state.

setActiveViewport() [1/2]

virtual bool OdGsIfcLayoutHelper::setActiveViewport ( const OdDAIObjectId &  id )

pure virtual

Sets a new active viewport for the object.

Parameters

id	[in] An identifier of the new viewport object that should be set as active.

Returns

Returns true if the new active viewport was successfully set; otherwise, the method returns false.

setActiveViewport() [2/2]

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

pure virtual

Sets a new active viewport for the object.

Parameters

screenPt

[in] A pick point in the device coordinates that defines the viewport.

Returns

Returns true if the new active viewport was successfully set; otherwise, the method returns false.

underlyingDevice()

virtual OdGsDevicePtr OdGsIfcLayoutHelper::underlyingDevice ( ) const

pure virtual

Retrieves the current underlying Gs device object associated with the object.

Returns

Returns a smart pointer to the <exref target="https://docs.opendesign.com/tv/OdGsDevice.html">OdGsDevice</exref> underlying object associated with the object.

---

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

• IfcGsManager.h