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< GsDeviceInterface, RedirectionBase >
	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< RedirectionBaseInterface, RedirectionInterface >
	OdGsDefaultRedirectionBase (RedirectionBaseInterface *pRedirectionObj=NULL)
bool	hasRedirection () const
const RedirectionBaseInterface *	redirection () const
RedirectionBaseInterface *	redirection ()
void	setRedirection (RedirectionBaseInterface *pRedirectionObj)
void	resetRedirection ()

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

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 2701 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

Constructor for the OdGsDeviceWrapperMinimalImpl class. Sets redirection device and background color for it.

Parameters

pRedirectionDevice

[in] Pointer to the redirection (wrapped) device.

Definition at line 2715 of file GsInterfaceWrappers.h.

Member Function Documentation

addView()

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

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

inline

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()

Definition at line 2801 of file GsInterfaceWrappers.h.

createView()

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

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

inline

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()

Definition at line 2783 of file GsInterfaceWrappers.h.

eraseAllViews()

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

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

inline

Erases all views associated with this Device object.

Definition at line 2832 of file GsInterfaceWrappers.h.

eraseView() [1/2]

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

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

inline

Erases the specified View object.

Parameters

viewIndex

[in] View index.

Returns

Returns true if and only if successful.

Definition at line 2827 of file GsInterfaceWrappers.h.

eraseView() [2/2]

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

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

inline

Erases the specified View object.

Parameters

pView

[in] Pointer to the OdGsView object.

Returns

Returns true if and only if successful.

Definition at line 2818 of file GsInterfaceWrappers.h.

getBackgroundColor()

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

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

inline

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

Definition at line 2856 of file GsInterfaceWrappers.h.

getLogicalPalette()

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

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

inline

Returns the logical palette used by this Device object.

Parameters

numColors

[out] Number of colors in palette.

Definition at line 2879 of file GsInterfaceWrappers.h.

getSize() [1/2]

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

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

inline

Returns device surface output rectangle.

Parameters

outputRect

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

Definition at line 2763 of file GsInterfaceWrappers.h.

getSize() [2/2]

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

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

inline

Returns device surface output rectangle.

Parameters

outputRect

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

Definition at line 2770 of file GsInterfaceWrappers.h.

insertView()

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

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

inline

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.

Definition at line 2809 of file GsInterfaceWrappers.h.

numViews()

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

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

inline

Returns the number of views associated with this Device object.

Definition at line 2837 of file GsInterfaceWrappers.h.

onSize() [1/2]

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

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

inline

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, .

Definition at line 2746 of file GsInterfaceWrappers.h.

onSize() [2/2]

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

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

inline

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, .

Definition at line 2756 of file GsInterfaceWrappers.h.

setBackgroundColor()

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

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

inline

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

Parameters

backgroundColor

[in] Background color.

Returns

true.

Definition at line 2851 of file GsInterfaceWrappers.h.

setLogicalPalette()

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

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

inline

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

Parameters

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

Remarks

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

Definition at line 2867 of file GsInterfaceWrappers.h.

setUserGiContext()

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

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

inline

Sets the User Context object associated with this Device object.

Parameters

pUserGiContext

[in] Pointer to the User Context.

Definition at line 2732 of file GsInterfaceWrappers.h.

userGiContext()

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

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

inline

Sets the User Context object associated with this Device object.

Parameters

pUserGiContext

[in] Pointer to the User Context.

Definition at line 2726 of file GsInterfaceWrappers.h.

viewAt()

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

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

inline

Returns the specified OdGsView object associated with this Device object.

Parameters

viewIndex

[in] View index.

Definition at line 2843 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 2705 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 2708 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 2704 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 2707 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 2706 of file GsInterfaceWrappers.h.

---

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

• GsInterfaceWrappers.h