OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase > Class Template Reference

#include <GsInterfaceWrappers.h>

Inheritance diagram for OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >:

Public Member Functions
	OdGsDeviceWrapperMinimalImpl (OdGsDevice *pRedirectionDevice=NULL)
OdGiContext *	userGiContext () const
void	setUserGiContext (OdGiContext *pUserGiContext)
void	onSize (const OdGsDCRect &outputRect)
void	onSize (const OdGsDCRectDouble &outputRect)
void	getSize (OdGsDCRect &outputRect) const
void	getSize (OdGsDCRectDouble &outputRect) const
OdGsViewPtr	createView (const OdGsClientViewInfo *pViewInfo=0, bool=false)
void	addView (OdGsView *pView)
void	insertView (int viewIndex, OdGsView *pView)
bool	eraseView (OdGsView *pView)
bool	eraseView (int viewIndex)
void	eraseAllViews ()
int	numViews () const
OdGsView *	viewAt (int viewIndex)
bool	setBackgroundColor (ODCOLORREF backgroundColor)
ODCOLORREF	getBackgroundColor ()
void	setLogicalPalette (const ODCOLORREF *logicalPalette, int numColors)
const ODCOLORREF *	getLogicalPalette (int &numColors) const
Public Member Functions inherited from OdGsDeviceWrapper< OdGsDevice, OdGsDefaultRedirectionBase< OdGsDevice, OdGsDevice > >
	OdGsDeviceWrapper (OdGsDevice *pRedirectionDevice=NULL)
OdRxDictionaryPtr	properties ()
OdGiContext *	userGiContext () const
void	setUserGiContext (OdGiContext *pUserGiContext)
void	invalidate ()
void	invalidate (const OdGsDCRect &screenRect)
bool	isValid () const
void	update (OdGsDCRect *pUpdatedRect=0)
void	onSize (const OdGsDCRect &outputRect)
void	onSize (const OdGsDCRectDouble &outputRect)
void	getSize (OdGsDCRect &outputRect) const
void	getSize (OdGsDCRectDouble &outputRect) const
void	onRealizeForegroundPalette ()
void	onRealizeBackgroundPalette ()
void	onDisplayChange (int bitsPerPixel, int xPixels, int yPixels)
OdGsViewPtr	createView (const OdGsClientViewInfo *pViewInfo=0, bool enableLayerVisibilityPerView=false)
void	addView (OdGsView *pView)
OdGsModelPtr	createModel ()
bool	isModelCompatible (OdGsModel *pModel) const
bool	saveDeviceState (OdGsFiler *pFiler) const
bool	loadDeviceState (OdGsFiler *pFiler)
void	insertView (int viewIndex, OdGsView *pView)
bool	eraseView (OdGsView *pView)
bool	eraseView (int viewIndex)
void	eraseAllViews ()
int	numViews () const
OdGsView *	viewAt (int viewIndex)
bool	setBackgroundColor (ODCOLORREF backgroundColor)
ODCOLORREF	getBackgroundColor ()
void	setLogicalPalette (const ODCOLORREF *logicalPalette, int numColors)
const ODCOLORREF *	getLogicalPalette (int &numColors) const
void	getSnapShot (OdGiRasterImagePtr &pImage, const OdGsDCRect &region)
OdGsUpdateManagerPtr	getUpdateManager (bool createIfNotExist)
void	setUpdateManager (OdGsUpdateManagerPtr pManager)
Public Member Functions inherited from OdGsDefaultRedirectionBase< OdGsDevice, OdGsDevice >
	OdGsDefaultRedirectionBase (OdGsDevice *pRedirectionObj=NULL)
bool	hasRedirection () const
const OdGsDevice *	redirection () const
OdGsDevice *	redirection ()
void	setRedirection (OdGsDevice *pRedirectionObj)
void	resetRedirection ()
Public Member Functions inherited from OdGsDevice
	ODRX_DECLARE_MEMBERS (OdGsDevice)
virtual bool	isValid () 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

Protected Attributes
OdSmartPtr< OdGiContext >	m_pContext
ODCOLORREF	m_backColor
OdArray< OdGsViewPtr >	m_views
OdGsDCRectDouble	m_size
OdArray< ODCOLORREF, OdMemoryAllocator< ODCOLORREF > >	m_palette

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

template<typename GsDeviceInterface = OdGsDevice, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsDevice, GsDeviceInterface>>
class OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >

Base template for OdGsDevice class wrappers.

Corresponding C++ library: TD_Gs

<group OdGs_Classes>

Definition at line 1097 of file GsInterfaceWrappers.h.

Constructor & Destructor Documentation

OdGsDeviceWrapperMinimalImpl()

template<typename GsDeviceInterface = OdGsDevice, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsDevice, GsDeviceInterface>>

OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >::OdGsDeviceWrapperMinimalImpl ( OdGsDevice *  pRedirectionDevice = NULL )

inline

Definition at line 1106 of file GsInterfaceWrappers.h.

Member Function Documentation

addView()

template<typename GsDeviceInterface = OdGsDevice, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsDevice, GsDeviceInterface>>

void OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >::addView ( OdGsView *  pView )

inlinevirtual

Associates the specified Viewport object with this Device object.

Parameters

pView

[in] Pointer to the OdGsView object.

Implements OdGsDevice.

Definition at line 1132 of file GsInterfaceWrappers.h.

createView()

template<typename GsDeviceInterface = OdGsDevice, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsDevice, GsDeviceInterface>>

OdGsViewPtr OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >::createView ( const OdGsClientViewInfo *  pViewInfo = 0, bool  enableLayerVisibilityPerView = false  )

inlinevirtual

Creates a new OdGsView object, and associates it with this Device object.

Parameters

pViewInfo	[in] Pointer to the Client View Information for this Device object.
enableLayerVisibilityPerView	[in] Layer visibility per viewport is supported, if and only if true.

Returns

Returns a SmartPointer to the newly created object.

pViewInfo contains information returned by OdGiViewport::acadWindowId() and OdGiViewportDraw::viewportObjectId()

Implements OdGsDevice.

Definition at line 1125 of file GsInterfaceWrappers.h.

eraseAllViews()

template<typename GsDeviceInterface = OdGsDevice, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsDevice, GsDeviceInterface>>

void OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >::eraseAllViews ( )

inlinevirtual

Erases all views associated with this Device object.

Implements OdGsDevice.

Definition at line 1136 of file GsInterfaceWrappers.h.

eraseView() [1/2]

template<typename GsDeviceInterface = OdGsDevice, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsDevice, GsDeviceInterface>>

bool OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >::eraseView ( int  viewIndex )

inlinevirtual

Erases the specified View object.

Parameters

viewIndex

[in] View index.

Returns

Returns true if and only if successful.

Implements OdGsDevice.

Definition at line 1135 of file GsInterfaceWrappers.h.

eraseView() [2/2]

template<typename GsDeviceInterface = OdGsDevice, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsDevice, GsDeviceInterface>>

bool OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >::eraseView ( OdGsView *  pView )

inlinevirtual

Erases the specified View object.

Parameters

pView

[in] Pointer to the OdGsView object.

Returns

Returns true if and only if successful.

Implements OdGsDevice.

Definition at line 1134 of file GsInterfaceWrappers.h.

getBackgroundColor()

template<typename GsDeviceInterface = OdGsDevice, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsDevice, GsDeviceInterface>>

ODCOLORREF OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >::getBackgroundColor ( )

inlinevirtual

Returns the Background Color of the GUI window of this Device object.

Implements OdGsDevice.

Definition at line 1141 of file GsInterfaceWrappers.h.

getLogicalPalette()

template<typename GsDeviceInterface = OdGsDevice, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsDevice, GsDeviceInterface>>

const ODCOLORREF* OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >::getLogicalPalette ( int &  numColors ) const

inlinevirtual

Returns the logical pallete used by this Device object.

Parameters

numColors

[out] Number of colors in palette.

Implements OdGsDevice.

Definition at line 1149 of file GsInterfaceWrappers.h.

getSize() [1/2]

template<typename GsDeviceInterface = OdGsDevice, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsDevice, GsDeviceInterface>>

void OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >::getSize ( OdGsDCRect &  outputRect ) const

inlinevirtual

Returns device surface output rectangle.

Parameters

outputRect

[out] Obtains size of the output rectangle in device coordinates (pixels).

Implements OdGsDevice.

Definition at line 1122 of file GsInterfaceWrappers.h.

getSize() [2/2]

template<typename GsDeviceInterface = OdGsDevice, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsDevice, GsDeviceInterface>>

void OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >::getSize ( OdGsDCRectDouble &  outputRect ) const

inlinevirtual

Returns device surface output rectangle.

Parameters

outputRect

[out] Obtains size of the output rectangle in device coordinates (pixels).

Reimplemented from OdGsDevice.

Definition at line 1123 of file GsInterfaceWrappers.h.

insertView()

template<typename GsDeviceInterface = OdGsDevice, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsDevice, GsDeviceInterface>>

void OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >::insertView ( int  viewIndex, OdGsView *  pView  )

inlinevirtual

Inserts the specified Viewport object to the specified position in this Device object.

Parameters

viewIndex	[in] View index.
pView	[in] Pointer to the OdGsView object.

Implements OdGsDevice.

Definition at line 1133 of file GsInterfaceWrappers.h.

numViews()

template<typename GsDeviceInterface = OdGsDevice, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsDevice, GsDeviceInterface>>

int OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >::numViews ( ) const

inlinevirtual

Returns the number of views associated with this Device object.

Implements OdGsDevice.

Definition at line 1137 of file GsInterfaceWrappers.h.

onSize() [1/2]

template<typename GsDeviceInterface = OdGsDevice, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsDevice, GsDeviceInterface>>

void OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >::onSize ( const OdGsDCRect &  outputRect )

inlinevirtual

Notification function called whenever the size of the GUI window for this Device object has changed.

Parameters

outputRect

[in] New size of the output rectangle in device coordinates (pixels).

Remarks

This function should not be called if this Device object has a width and/or height of 0, .

Implements OdGsDevice.

Definition at line 1120 of file GsInterfaceWrappers.h.

onSize() [2/2]

template<typename GsDeviceInterface = OdGsDevice, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsDevice, GsDeviceInterface>>

void OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >::onSize ( const OdGsDCRectDouble &  outputRect )

inlinevirtual

Notification function called whenever the size of the GUI window for this Device object has changed.

Parameters

outputRect

[in] New size of the output rectangle in device coordinates (pixels).

Remarks

This function should not be called if this Device object has a width and/or height of 0, .

Reimplemented from OdGsDevice.

Definition at line 1121 of file GsInterfaceWrappers.h.

setBackgroundColor()

template<typename GsDeviceInterface = OdGsDevice, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsDevice, GsDeviceInterface>>

bool OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >::setBackgroundColor ( ODCOLORREF  backgroundColor )

inlinevirtual

Sets the Background Color of the GUI window of this Device object.

Parameters

backgroundColor

[in] Background color.

Implements OdGsDevice.

Definition at line 1140 of file GsInterfaceWrappers.h.

setLogicalPalette()

template<typename GsDeviceInterface = OdGsDevice, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsDevice, GsDeviceInterface>>

void OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >::setLogicalPalette ( const ODCOLORREF *  logicalPalette, int  numColors  )

inlinevirtual

Sets the logical pallete to be used by this Device object.

Parameters

logicalPalette	[in] Logical palette.
numColors	[in] Number of colors in palette.

Remarks

The logical pallete is used with calls to OdGiSubEntityTraits::setColor().

Implements OdGsDevice.

Definition at line 1143 of file GsInterfaceWrappers.h.

setUserGiContext()

template<typename GsDeviceInterface = OdGsDevice, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsDevice, GsDeviceInterface>>

void OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >::setUserGiContext ( OdGiContext *  pUserGiContext )

inlinevirtual

Sets the User Context object associated with this Device object.

Parameters

pUserGiContext

[in] Pointer to the User Context.

Implements OdGsDevice.

Definition at line 1114 of file GsInterfaceWrappers.h.

userGiContext()

template<typename GsDeviceInterface = OdGsDevice, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsDevice, GsDeviceInterface>>

OdGiContext* OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >::userGiContext ( ) const

inlinevirtual

Returns the User Context object associated with this Device object.

Implements OdGsDevice.

Definition at line 1113 of file GsInterfaceWrappers.h.

viewAt()

template<typename GsDeviceInterface = OdGsDevice, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsDevice, GsDeviceInterface>>

OdGsView* OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >::viewAt ( int  viewIndex )

inlinevirtual

Returns the specified OdGsView object associated with this Device object.

Parameters

viewIndex

[in] View index.

Implements OdGsDevice.

Definition at line 1138 of file GsInterfaceWrappers.h.

Member Data Documentation

m_backColor

template<typename GsDeviceInterface = OdGsDevice, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsDevice, GsDeviceInterface>>

ODCOLORREF OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >::m_backColor

protected

Definition at line 1101 of file GsInterfaceWrappers.h.

m_palette

template<typename GsDeviceInterface = OdGsDevice, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsDevice, GsDeviceInterface>>

OdArray<ODCOLORREF, OdMemoryAllocator<ODCOLORREF> > OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >::m_palette

protected

Definition at line 1104 of file GsInterfaceWrappers.h.

m_pContext

template<typename GsDeviceInterface = OdGsDevice, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsDevice, GsDeviceInterface>>

OdSmartPtr<OdGiContext> OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >::m_pContext

mutableprotected

Definition at line 1100 of file GsInterfaceWrappers.h.

m_size

template<typename GsDeviceInterface = OdGsDevice, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsDevice, GsDeviceInterface>>

OdGsDCRectDouble OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >::m_size

protected

Definition at line 1103 of file GsInterfaceWrappers.h.

m_views

template<typename GsDeviceInterface = OdGsDevice, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsDevice, GsDeviceInterface>>

OdArray<OdGsViewPtr> OdGsDeviceWrapperMinimalImpl< GsDeviceInterface, RedirectionBase >::m_views

protected

Definition at line 1102 of file GsInterfaceWrappers.h.

---

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

• GsInterfaceWrappers.h