CFx SDK Documentation
2022 SP0
|
#include <GsInterfaceWrappers.h>
Additional Inherited Members | |
Static Public Member Functions inherited from OdRxObject | |
static OdRxObjectPtr | cast (const OdRxObject *pointer) |
static OdRxClass * | desc () |
Base template for OdGsDevice class wrappers.
Corresponding C++ library: TD_Gs
<group OdGs_Classes>
Definition at line 708 of file GsInterfaceWrappers.h.
|
inline |
Definition at line 715 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Associates the specified Viewport object with this Device object.
pView | [in] Pointer to the OdGsView object. |
Implements OdGsDevice.
Definition at line 807 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Creates a new OdGsModel object, and associates it with this Device object.
Implements OdGsDevice.
Definition at line 813 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Creates a new OdGsView object, and associates it with this Device object.
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. |
pViewInfo contains information returned by OdGiViewport::acadWindowId() and OdGiViewportDraw::viewportObjectId()
Implements OdGsDevice.
Definition at line 801 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Erases all views associated with this Device object.
Implements OdGsDevice.
Definition at line 856 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Erases the specified View object.
viewIndex | [in] View index. |
Implements OdGsDevice.
Definition at line 850 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Erases the specified View object.
pView | [in] Pointer to the OdGsView object. |
Implements OdGsDevice.
Definition at line 844 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Returns the Background Color of the GUI window of this Device object.
Implements OdGsDevice.
Definition at line 880 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Returns the logical pallete used by this Device object.
numColors | [out] Number of colors in palette. |
Implements OdGsDevice.
Definition at line 892 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Returns device surface output rectangle.
outputRect | [out] Obtains size of the output rectangle in device coordinates (pixels). |
Implements OdGsDevice.
Definition at line 774 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Returns device surface output rectangle.
outputRect | [out] Obtains size of the output rectangle in device coordinates (pixels). |
Reimplemented from OdGsDevice.
Definition at line 779 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Returns image of current device buffer.
pImage | [out] Pointer for image to return. |
region | [in] Rectangle specifies region to return. |
Implements OdGsDevice.
Definition at line 899 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Returns OdGsUpdateManager associated with current device
createIfNotExist | [in] Creates instance of OdGsUpdateManager if no one associated with device |
Reimplemented from OdGsDevice.
Definition at line 905 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Inserts the specified Viewport object to the specified position in this Device object.
viewIndex | [in] View index. |
pView | [in] Pointer to the OdGsView object. |
Implements OdGsDevice.
Definition at line 839 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Marks for refresh the specified region of the GUI window of this Device object.
screenRect | [in] Rectangular area. |
Implements OdGsDevice.
Definition at line 740 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Implements OdGsDevice.
Definition at line 745 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Checks compatibility between specified OdGsModel and this Device object.
pModel | [in] Model object pointer to check compatibility. |
By default this always returns false. It is must be implemented in inherited classes to enable Model object reuse support. If Device object use overriden Model object it should return false if input Model object doesn't overriden.
Typical way to check compatibility is using of RTTI.
If your metafiles cache doesn't support per-device sharing override and return false.
Reimplemented from OdGsDevice.
Definition at line 819 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Returns true if and only if the GUI window for this Device object is showing the correct image.
Implements OdGsDevice.
Definition at line 750 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Restores device state from filer object.
pFiler | [in] Filer object. |
Reimplemented from OdGsDevice.
Definition at line 832 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Returns the number of views associated with this Device object.
Implements OdGsDevice.
Definition at line 861 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Notification function called whenever the OS screen resolution and/or color depth have changed.
bitsPerPixel | [in] Color depth. |
xPixels | [in] X pixels. |
yPixels | [in] Y pixels. |
Implements OdGsDevice.
Definition at line 795 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Notification function typically called whenever the GUI window for this Device object loses focus.
Implements OdGsDevice.
Definition at line 790 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Implements OdGsDevice.
Definition at line 785 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Notification function called whenever the size of the GUI window for this Device object has changed.
outputRect | [in] New size of the output rectangle in device coordinates (pixels). |
Implements OdGsDevice.
Definition at line 763 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Notification function called whenever the size of the GUI window for this Device object has changed.
outputRect | [in] New size of the output rectangle in device coordinates (pixels). |
Reimplemented from OdGsDevice.
Definition at line 768 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Returns a SmartPointer to the dictionary containing the properties for this Device object.
Implements OdGsDevice.
Definition at line 721 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Stores current device state into filer object.
pFiler | [in] Filer object. |
Reimplemented from OdGsDevice.
Definition at line 826 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Sets the Background Color of the GUI window of this Device object.
backgroundColor | [in] Background color. |
Implements OdGsDevice.
Definition at line 874 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Sets the logical pallete to be used by this Device object.
logicalPalette | [in] Logical palette. |
numColors | [in] Number of colors in palette. |
Implements OdGsDevice.
Definition at line 887 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Associates OdGsUpdateManager with device
pManager | [in] Pointer to the OdGsUpdateManager |
Reimplemented from OdGsDevice.
Definition at line 915 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Sets the User Context object associated with this Device object.
pUserGiContext | [in] Pointer to the User Context. |
Implements OdGsDevice.
Definition at line 734 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Updates the GUI window for this Device object.
pUpdatedRect | [out] Pointer to the a rectangle to receive the region updated by this function. |
Implements OdGsDevice.
Definition at line 757 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Returns the User Context object associated with this Device object.
Implements OdGsDevice.
Definition at line 728 of file GsInterfaceWrappers.h.
|
inlinevirtual |
Returns the specified OdGsView object associated with this Device object.
viewIndex | [in] View index. |
Implements OdGsDevice.
Definition at line 867 of file GsInterfaceWrappers.h.