CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
OdGsBaseVectorizeDevice Class Reference

#include <GsBaseVectorizeDevice.h>

Inheritance diagram for OdGsBaseVectorizeDevice:
OdGsDevice OdRxObject CFxRVTVectorizeDevice

Classes

struct  GsDeviceOverlayData
 
class  GsDeviceOverlayDataContainer
 

Public Member Functions

bool invalid () const
 
void setInvalid (bool bSet)
 
void setValid (bool bFlag)
 
virtual bool supportPartialUpdate () const
 
virtual bool supportPartialScreenUpdate () const
 
void onViewAdded (OdGsView *pView)
 
 ODRX_DECLARE_MEMBERS (OdGsBaseVectorizeDevice)
 
 ~OdGsBaseVectorizeDevice ()
 
OdGiContext * userGiContext () const
 
void setUserGiContext (OdGiContext *pUserGiContext)
 
OdRxDictionaryPtr properties ()
 
 OdGsBaseVectorizeDevice ()
 
int height () const
 
int width () const
 
int hOffset () const
 
int vOffset () const
 
void invalidate ()
 
void invalidate (const OdGsDCRect &screenRect)
 
virtual void invalidate (OdUInt32 nOverlays)
 
virtual void invalidate (OdUInt32 nOverlays, const OdGsDCRect &screenRect)
 
void invalidate (const OdGsViewImpl *pView, const OdGsDCRect &screenRect)
 
void invalidate (const OdGsModel *pModel, const OdGsDCRect &screenRect)
 
void invalidateRegion (const OdGiPathNode &path)
 
const OdGsDCRectArray & invalidRects () const
 
const OdGsDCRectArray * invalidRects (OdGsOverlayId overlayId) const
 
bool isValid () const
 
virtual void update (OdGsDCRect *pUpdatedRect)
 
virtual void updateGeometry ()
 
virtual void updateScreen ()
 
void onSize (const OdGsDCRect &outputRect)
 
const OdGsDCRect & outputRect () const
 
void getSize (OdGsDCRect &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)
 
void insertView (int viewIndex, OdGsView *pView)
 
bool eraseView (OdGsView *pView)
 
int numViews () const
 
OdGsView * viewAt (int viewIndex)
 
const OdGsView * viewAt (int viewIndex) const
 
OdGsViewImpl * viewImplAt (int viewIndex)
 
const OdGsViewImpl * viewImplAt (int viewIndex) const
 
bool eraseView (int viewIndex)
 
void eraseAllViews ()
 
bool setBackgroundColor (ODCOLORREF backgroundColor)
 
ODCOLORREF getBackgroundColor ()
 
void setLogicalPalette (const ODCOLORREF *logicalPalette, int numColors)
 
void getSnapShot (OdGiRasterImagePtr &pImage, const OdGsDCRect &region)
 
ODCOLORREF getColor (OdUInt16 colorIndex) const
 
ODCOLORREF getPaletteBackground () const
 
const ODCOLORREF * getPalette () const
 
const ODCOLORREF * getLogicalPalette (int &numColors) const
 
OdGsModelPtr createModel ()
 
bool isModelCompatible (OdGsModel *pModel) const
 
const OdGsView * rootView () const
 
bool sortRenderTypes () const
 
void setSortRenderTypes (bool flag)
 
virtual OdUInt32 renderTypeWeight (OdGsModel::RenderType renderType) const
 
OdGsModel::RenderType transientRenderType () const
 
void setTransientRenderType (OdGsModel::RenderType renderType)
 
bool supportOverlays () const
 
void setSupportOverlays (bool bFlag)
 
virtual OdGsOverlayId renderTypeOverlay (OdGsModel::RenderType renderType) const
 
OdGsOverlayId gsModelOverlay (const OdGsModel *pModel) const
 
int isOverlayRequireUpdate (OdGsOverlayId overlayId) const
 
bool isSpatialIndexDisabled () const
 
void disableSpatialIndex (bool bSet)
 
bool isCullingVolumeEnabled () const
 
void enableCullingVolume (bool bSet)
 
bool supportHighlightTwoPass () const
 
void setSupportHighlightTwoPass (bool bOn)
 
bool isMtDisplay () const
 
bool supportDynamicHighlight () const
 
bool supportDynamicSubhighlight () const
 
bool supportSelectionStyles () const
 
bool supportBlocks () const
 
bool supportComposition () const
 
bool compositionEnabled () const
 
void enableComposition (bool bSet)
 
bool isDisplayOffLayersEnabled () const
 
void enableDisplayOffLayers (bool bSet)
 
bool isValidViewportId (const OdUInt32 acgiId) const
 
bool useVpLtypeScaleMult () const
 
bool useVpFilterFunction () const
 
virtual OdGiSectionGeometryManager * getSectionGeometryManager ()
 
OdRxObjectPtr getSectionGeometryMap ()
 
void clearSectionGeometryMap ()
 
OdRxObject * mtServices ()
 
OdGiTransientManager * transientManager ()
 
void setTransientManager (OdGiTransientManager *pManager)
 
virtual bool isSupportDeviceStateSaving () const
 
bool saveDeviceState (OdGsFiler *pFiler) const
 
bool loadDeviceState (OdGsFiler *pFiler)
 
virtual bool saveClientDeviceState (OdGsFiler *pFiler) const
 
virtual bool loadClientDeviceState (OdGsFiler *pFiler)
 
virtual bool saveLinkedDeviceState (OdGsFiler *pFiler) const
 
virtual bool loadLinkedDeviceState (OdGsFiler *pFiler)
 
bool supportInteractiveViewMode () const
 
void setSupportInteractiveViewMode (bool bSet)
 
OdGsUpdateManagerPtr getUpdateManager (bool createIfNotExist=false)
 
void setUpdateManager (OdGsUpdateManagerPtr pManager)
 
OdGsUpdateManager * updateManager ()
 
bool isSuppressHide () const
 
OdRxObjectPtr deviceSelfReference ()
 
- Public Member Functions inherited from OdGsDevice
 ODRX_DECLARE_MEMBERS (OdGsDevice)
 
virtual void onSize (const OdGsDCRectDouble &outputRect)
 
virtual void getSize (OdGsDCRectDouble &outputRect) const
 
- 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
 

Public Attributes

GsVectPerformanceData m_vectPerfData
 

Protected Types

enum  {
  kFirstFlag = 1 , kInvalid = kFirstFlag << 0 , kSortRenderTypes = kFirstFlag << 1 , kSpatialIndexDisabled = kFirstFlag << 2 ,
  kDynamicHighlight = kFirstFlag << 3 , kDynamicSubhighlight = kFirstFlag << 4 , kSupportBlocks = kFirstFlag << 5 , kSupportOverlays = kFirstFlag << 6 ,
  kSupportComposition = kFirstFlag << 7 , kEnableComposition = kFirstFlag << 8 , kMtDisplay = kFirstFlag << 9 , kUseSectionGeometryMap = kFirstFlag << 10 ,
  kUseVpLtypeScaleMult = kFirstFlag << 11 , kUseVpFilterFunction = kFirstFlag << 12 , kCullingVolumeEnabled = kFirstFlag << 13 , kDisplayOffLayers = kFirstFlag << 14 ,
  kSupportInteractiveView = kFirstFlag << 15 , kHighlightTwoPass = kFirstFlag << 16 , kSupportSelectionStyles = kFirstFlag << 17 , kSuppressHide = kFirstFlag << 18 ,
  kLastFlag = kSuppressHide
}
 

Protected Member Functions

void registerOverlay (OdGsViewImpl *pView, const OdGsModel *pModel)
 
void unregisterOverlay (OdGsViewImpl *pView, const OdGsModel *pModel)
 
virtual void onOverlayActivated (OdGsOverlayId nOverlay)
 
virtual void onOverlayDeactivated (OdGsOverlayId nOverlay)
 
virtual bool supportParallelDisplay () const
 
void initMtServices ()
 
void viewUpdateScreen (OdGsBaseVectorizeView *pView, bool bUpdate)
 
void collectInvalidRectsFromVports (OdGsOverlayId nOverlay, GsDeviceOverlayData &d) const
 
void getInvalidRectsFromVports (OdUInt32 nOverlays=kGsAllOverlays)
 

Protected Attributes

OdArray< OdGsViewPtr > m_views
 
ODGSPALETTE m_logPalette
 
ODCOLORREF m_Background
 
OdGsDCRect m_outputRect
 
OdSmartPtr< OdGiContext > m_pUserContext
 
OdRxObjectPtr m_sectionGeometryMap
 
OdRxObjectPtr m_sectionManager
 
OdGiTransientManagerPtr m_transientManager
 
OdGsModel::RenderType m_transientRenderType
 
OdGsUpdateManagerPtr m_pUpdateManager
 
OdUInt32 m_flags
 
GsDeviceOverlayDataContainer m_overlayData
 
OdRxObjectPtr m_pDeviceRef
 

Friends

class OdGsViewImpl
 
class OdGsBaseVectorizeView
 
class OdGsBaseModule
 
class DisplayScheduler
 
class OdGsNodeContext
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClass * desc ()
 
static void rxInit ()
 
static void rxUninit ()
 

Detailed Description

This class implements bitmapped GUI display windows.

Remarks
OdGsBaseVectorizeDevice objects own, update, and refresh one or more OdGsView objects.

In addition, they responds to operating system notifications, such as window resize, forwarded by the graphics system client.

Corresponding C++ library: Gs

<group OdGs_Classes>

See also
<link tv_working_with_base_classes_device, Work with Visualize Graphics Devices>

Definition at line 71 of file GsBaseVectorizeDevice.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
kFirstFlag 
kInvalid 
kSortRenderTypes 
kSpatialIndexDisabled 
kDynamicHighlight 
kDynamicSubhighlight 
kSupportBlocks 
kSupportOverlays 
kSupportComposition 
kEnableComposition 
kMtDisplay 
kUseSectionGeometryMap 
kUseVpLtypeScaleMult 
kUseVpFilterFunction 
kCullingVolumeEnabled 
kDisplayOffLayers 
kSupportInteractiveView 
kHighlightTwoPass 
kSupportSelectionStyles 
kSuppressHide 
kLastFlag 

Definition at line 95 of file GsBaseVectorizeDevice.h.

Constructor & Destructor Documentation

◆ ~OdGsBaseVectorizeDevice()

OdGsBaseVectorizeDevice::~OdGsBaseVectorizeDevice ( )

Destructor for the OdGsBaseVectorizeDevice class. Erases all contained view.

◆ OdGsBaseVectorizeDevice()

OdGsBaseVectorizeDevice::OdGsBaseVectorizeDevice ( )

Default constructor for the OdGsBaseVectorizeDevice class. Sets the object with default background color, flags and other properties. The created default device is invalid.

Member Function Documentation

◆ addView()

void OdGsBaseVectorizeDevice::addView ( OdGsView * pView)
virtual

Associates the specified Viewport object with this Device object.

Parameters
pView[in] Pointer to the OdGsView object.

Implements OdGsDevice.

◆ clearSectionGeometryMap()

void OdGsBaseVectorizeDevice::clearSectionGeometryMap ( )

Clears the section geometry map.

◆ collectInvalidRectsFromVports()

void OdGsBaseVectorizeDevice::collectInvalidRectsFromVports ( OdGsOverlayId nOverlay,
GsDeviceOverlayData & d ) const
protected

◆ compositionEnabled()

bool OdGsBaseVectorizeDevice::compositionEnabled ( ) const
inline

Checks whether vectorization modules compositions is enabled for this device.

Returns
true if vectorization modules compositions is enabled for this device, false otherwise.
See also
<link WinComposite, Viewport-Specific Render Modes using WinComposite Vectorization>

Definition at line 925 of file GsBaseVectorizeDevice.h.

◆ createModel()

OdGsModelPtr OdGsBaseVectorizeDevice::createModel ( )
virtual

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

Returns
Returns a SmartPointer to the newly created object.

Implements OdGsDevice.

◆ createView()

OdGsViewPtr OdGsBaseVectorizeDevice::createView ( const OdGsClientViewInfo * pViewInfo = 0,
bool enableLayerVisibilityPerView = false )
virtual

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.

◆ deviceSelfReference()

OdRxObjectPtr OdGsBaseVectorizeDevice::deviceSelfReference ( )
inline

Definition at line 823 of file GsBaseVectorizeDevice.h.

◆ disableSpatialIndex()

void OdGsBaseVectorizeDevice::disableSpatialIndex ( bool bSet)
inline

Disables or enables spatial indexes.

Parameters
bSet[in] Flag that specifies whether to disable spatial indexes. True to disable, false to enable.

Definition at line 870 of file GsBaseVectorizeDevice.h.

◆ enableComposition()

void OdGsBaseVectorizeDevice::enableComposition ( bool bSet)
inline

Enables or disables vectorization modules compositions for this device.

Parameters
bSet[in] Flag that specifies whether to enable vectorization modules compositions.
See also
<link WinComposite, Viewport-Specific Render Modes using WinComposite Vectorization>

Definition at line 930 of file GsBaseVectorizeDevice.h.

◆ enableCullingVolume()

void OdGsBaseVectorizeDevice::enableCullingVolume ( bool bSet)
inline

Enables or disables culling volume usage.

Parameters
bSet[in] Flag that specifies whether to enable culling volume.

Definition at line 880 of file GsBaseVectorizeDevice.h.

◆ enableDisplayOffLayers()

void OdGsBaseVectorizeDevice::enableDisplayOffLayers ( bool bSet)
inline

Enables or disables displaying of off-layers.

Parameters
bSet[in] Flag that specifies whether to enable displaying of off-layers.

Definition at line 940 of file GsBaseVectorizeDevice.h.

◆ eraseAllViews()

void OdGsBaseVectorizeDevice::eraseAllViews ( )
virtual

Erases all views associated with this Device object.

Implements OdGsDevice.

◆ eraseView() [1/2]

bool OdGsBaseVectorizeDevice::eraseView ( int viewIndex)
virtual

Erases the specified View object.

Parameters
viewIndex[in] View index.
Returns
Returns true if and only if successful.

Implements OdGsDevice.

◆ eraseView() [2/2]

bool OdGsBaseVectorizeDevice::eraseView ( OdGsView * pView)
virtual

Erases the specified View object.

Parameters
pView[in] Pointer to the OdGsView object.
Returns
Returns true if and only if successful.

Implements OdGsDevice.

◆ getBackgroundColor()

ODCOLORREF OdGsBaseVectorizeDevice::getBackgroundColor ( )
virtual

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

Implements OdGsDevice.

◆ getColor()

ODCOLORREF OdGsBaseVectorizeDevice::getColor ( OdUInt16 colorIndex) const
inline

Returns the specified color in the logical palette of this Device object.

Parameters
colorIndex[in] Color index.

Definition at line 968 of file GsBaseVectorizeDevice.h.

◆ getInvalidRectsFromVports()

void OdGsBaseVectorizeDevice::getInvalidRectsFromVports ( OdUInt32 nOverlays = kGsAllOverlays)
protected

◆ getLogicalPalette()

const ODCOLORREF * OdGsBaseVectorizeDevice::getLogicalPalette ( int & numColors) const
inlinevirtual

Returns the logical palette of this Device object.

Parameters
numColors[out] Returns number of colors inside logical palette.

Implements OdGsDevice.

Definition at line 980 of file GsBaseVectorizeDevice.h.

◆ getPalette()

const ODCOLORREF * OdGsBaseVectorizeDevice::getPalette ( ) const
inline

Returns the logical palette of this Device object.

Definition at line 974 of file GsBaseVectorizeDevice.h.

◆ getPaletteBackground()

ODCOLORREF OdGsBaseVectorizeDevice::getPaletteBackground ( ) const

Returns background color in the logical palette of this Device object.

◆ getSectionGeometryManager()

virtual OdGiSectionGeometryManager * OdGsBaseVectorizeDevice::getSectionGeometryManager ( )
virtual

Retrieves pointer to the section geometry manager.

◆ getSectionGeometryMap()

OdRxObjectPtr OdGsBaseVectorizeDevice::getSectionGeometryMap ( )

Retrieves smart pointer to the section geometry map.

◆ getSize()

void OdGsBaseVectorizeDevice::getSize ( OdGsDCRect & outputRect) const
inlinevirtual

Retrieves the device output rectangle. The method fills the passed rectangle object with the data of the device output rectangle and returns it to a calling subroutine.

Parameters
outputRect[out] A placeholder for the device's output rectangle object. Size of the rectangle is represented in the device coordinates (pixels).

Implements OdGsDevice.

Definition at line 962 of file GsBaseVectorizeDevice.h.

◆ getSnapShot()

void OdGsBaseVectorizeDevice::getSnapShot ( OdGiRasterImagePtr & pImage,
const OdGsDCRect & region )
virtual

Returns image of current device buffer. Currently not implemented.

Parameters
pImage[out] Pointer for image to return.
region[in] Rectangle specifies region to capture.
Remarks
Implementation can throw eNotImplementedYet exception if current vectorization module doesn't support snap shots.

Implements OdGsDevice.

◆ getUpdateManager()

OdGsUpdateManagerPtr OdGsBaseVectorizeDevice::getUpdateManager ( bool createIfNotExist = false)
virtual

Retrieves smart pointer to an update manager for this device.

Parameters
createIfNotExist[in] Flag that specifies whether to create a new update manager if there is no update for this device.

Reimplemented from OdGsDevice.

◆ gsModelOverlay()

OdGsOverlayId OdGsBaseVectorizeDevice::gsModelOverlay ( const OdGsModel * pModel) const

Returns the overlay identifier (from the OdGsOverlayId enumeration) of the specified model.

Parameters
pModel[in] Pointer to a model.

◆ height()

int OdGsBaseVectorizeDevice::height ( ) const

Returns the height of this Device object output surface in pixels.

Returns
The height of this Device object output surface in pixels.

◆ hOffset()

int OdGsBaseVectorizeDevice::hOffset ( ) const

Returns horizontal offset of this Device object output surface in pixels.

Returns
Horizontal offset of this Device object output surface in pixels.

◆ initMtServices()

void OdGsBaseVectorizeDevice::initMtServices ( )
protected

◆ insertView()

void OdGsBaseVectorizeDevice::insertView ( int viewIndex,
OdGsView * pView )
virtual

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.

◆ invalid()

bool OdGsBaseVectorizeDevice::invalid ( ) const
inline

Returns true in case if device in completely invalid state.

Definition at line 149 of file GsBaseVectorizeDevice.h.

◆ invalidate() [1/6]

void OdGsBaseVectorizeDevice::invalidate ( )
virtual

Marks for refresh the GUI window related to the device.

See also
<EXTLINK https://docs.opendesign.com/tv/tv_working_with_base_classes_device_functionality.html#5">Redrawing Content of a Device</EXTLINK>

Implements OdGsDevice.

◆ invalidate() [2/6]

void OdGsBaseVectorizeDevice::invalidate ( const OdGsDCRect & screenRect)
virtual

Marks for refresh a specified region of the GUI window related to the device.

Parameters
screenRect[in] A rectangle that specifies the window region to be refreshed.
See also
<EXTLINK https://docs.opendesign.com/tv/tv_working_with_base_classes_device_functionality.html#5">Redrawing Content of a Device</EXTLINK>

Implements OdGsDevice.

◆ invalidate() [3/6]

void OdGsBaseVectorizeDevice::invalidate ( const OdGsModel * pModel,
const OdGsDCRect & screenRect )

Marks for refresh a specified region of the GUI window related to the device for a model.

Parameters
pModel[in] Pointer to a model.
screenRect[in] A rectangle that specifies the window region to be refreshed.
See also
<EXTLINK https://docs.opendesign.com/tv/tv_working_with_base_classes_device_functionality.html#5">Redrawing Content of a Device</EXTLINK>

◆ invalidate() [4/6]

void OdGsBaseVectorizeDevice::invalidate ( const OdGsViewImpl * pView,
const OdGsDCRect & screenRect )

Marks for refresh a specified region of the GUI window related to the device for an owned view.

Parameters
pView[in] Pointer to a view.
screenRect[in] A rectangle that specifies the window region to be refreshed.
See also
<EXTLINK https://docs.opendesign.com/tv/tv_working_with_base_classes_device_functionality.html#5">Redrawing Content of a Device</EXTLINK>

◆ invalidate() [5/6]

virtual void OdGsBaseVectorizeDevice::invalidate ( OdUInt32 nOverlays)
virtual

Marks overlays for refresh.

Parameters
nOverlays[in] Number of overlays.
See also
<EXTLINK https://docs.opendesign.com/tv/tv_working_with_base_classes_device_functionality.html#5">Redrawing Content of a Device</EXTLINK>
<link tv_graphSysOverlays, Work with Graphic System Overlays>

◆ invalidate() [6/6]

virtual void OdGsBaseVectorizeDevice::invalidate ( OdUInt32 nOverlays,
const OdGsDCRect & screenRect )
virtual

Marks the specified screen rectangle of overlays for refresh.

Parameters
nOverlays[in] Number of overlays.
See also
<EXTLINK https://docs.opendesign.com/tv/tv_working_with_base_classes_device_functionality.html#5">Redrawing Content of a Device</EXTLINK>
<link tv_graphSysOverlays, Work with Graphic System Overlays>

◆ invalidateRegion()

void OdGsBaseVectorizeDevice::invalidateRegion ( const OdGiPathNode & path)

Marks for refresh a specified path node.

Parameters
path[in] Path to a mode that needs to be invalidated.
See also
<EXTLINK https://docs.opendesign.com/tv/tv_working_with_base_classes_device_functionality.html#5">Redrawing Content of a Device</EXTLINK>

◆ invalidRects() [1/2]

const OdGsDCRectArray & OdGsBaseVectorizeDevice::invalidRects ( ) const

◆ invalidRects() [2/2]

const OdGsDCRectArray * OdGsBaseVectorizeDevice::invalidRects ( OdGsOverlayId overlayId) const

◆ isCullingVolumeEnabled()

bool OdGsBaseVectorizeDevice::isCullingVolumeEnabled ( ) const
inline

Checks whether culling volume is enabled.

Returns
true if culling volume is enabled, false otherwise.

Definition at line 875 of file GsBaseVectorizeDevice.h.

◆ isDisplayOffLayersEnabled()

bool OdGsBaseVectorizeDevice::isDisplayOffLayersEnabled ( ) const
inline

Checks whether off-layers displaying enabled.

Returns
true if off-layers displaying enabled, false otherwise.

Definition at line 935 of file GsBaseVectorizeDevice.h.

◆ isModelCompatible()

bool OdGsBaseVectorizeDevice::isModelCompatible ( OdGsModel * pModel) const
virtual

Checks compatibility between specified OdGsModel and this Device object.

Parameters
pModel[in] Model object pointer to check compatibility.
Returns
true if the provided model is compatible with this device, false otherwise.
Remarks
Use this method to check compatibility of exist Model object and newly created device to be sure the exist Model object could be used with this Device object. 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.

◆ isMtDisplay()

bool OdGsBaseVectorizeDevice::isMtDisplay ( ) const
inline

Checks whether this device displays image in the multi-threaded mode.

Returns
true if this device displays image in the multi-threaded mode, false otherwise.

Definition at line 895 of file GsBaseVectorizeDevice.h.

◆ isOverlayRequireUpdate()

int OdGsBaseVectorizeDevice::isOverlayRequireUpdate ( OdGsOverlayId overlayId) const

Checks whether the specified overlay needs to be updated.

Parameters
overlayId[in] Overlay ID.
Returns
one of the following values: 0 - overlay is completely valid and update is not needed 1 - overlay is partially invalid and update is required 2 - overlay is completely invalid and update is required

◆ isSpatialIndexDisabled()

bool OdGsBaseVectorizeDevice::isSpatialIndexDisabled ( ) const
inline

Checks whether spatial indexes are disable.

Returns
true if spatial indexes are disabled, false otherwise.

Definition at line 865 of file GsBaseVectorizeDevice.h.

◆ isSupportDeviceStateSaving()

virtual bool OdGsBaseVectorizeDevice::isSupportDeviceStateSaving ( ) const
virtual

Checks whether this device supports saving its state.

Returns
true if this device supports state saving, false otherwise.

◆ isSuppressHide()

bool OdGsBaseVectorizeDevice::isSuppressHide ( ) const
inline

Indicates that GS should not skip hidden entities.

Returns
Returns true if device will hide entities by himself, otherwise returns false.

Definition at line 818 of file GsBaseVectorizeDevice.h.

◆ isValid()

bool OdGsBaseVectorizeDevice::isValid ( ) const
virtual

Checks whether this device is valid. Device is considered invalid if it has the kInvalid flag set to true or if one of the owned visible views is invalid.

Returns
true if this device is valid, false otherwise.

Implements OdGsDevice.

◆ isValidViewportId()

bool OdGsBaseVectorizeDevice::isValidViewportId ( const OdUInt32 acgiId) const
inline

Checks whether the passed viewport identifier is valid.

Parameters
acgiId[in] Viewport ID.
Returns
true if the specified viewport identifier is valid, false otherwise.

Definition at line 703 of file GsBaseVectorizeDevice.h.

◆ loadClientDeviceState()

virtual bool OdGsBaseVectorizeDevice::loadClientDeviceState ( OdGsFiler * pFiler)
virtual

Loads data of a client device from the specified filer.

Parameters
pFiler[in] Pointer to a filer from which to read device state.
Returns
true if the state of client device is loaded successfully, false otherwise.

◆ loadDeviceState()

bool OdGsBaseVectorizeDevice::loadDeviceState ( OdGsFiler * pFiler)
virtual

Loads device data from the specified filer.

Parameters
pFiler[in] Pointer to a filer from which to read device state.
Returns
true if the state of this device is loaded successfully, false otherwise.

Reimplemented from OdGsDevice.

◆ loadLinkedDeviceState()

virtual bool OdGsBaseVectorizeDevice::loadLinkedDeviceState ( OdGsFiler * pFiler)
virtual

◆ mtServices()

OdRxObject * OdGsBaseVectorizeDevice::mtServices ( )
inline

Definition at line 725 of file GsBaseVectorizeDevice.h.

◆ numViews()

int OdGsBaseVectorizeDevice::numViews ( ) const
virtual

Returns the number of views associated with this Device object.

Implements OdGsDevice.

◆ ODRX_DECLARE_MEMBERS()

OdGsBaseVectorizeDevice::ODRX_DECLARE_MEMBERS ( OdGsBaseVectorizeDevice )

◆ onDisplayChange()

void OdGsBaseVectorizeDevice::onDisplayChange ( int bitsPerPixel,
int xPixels,
int yPixels )
virtual

The handler for the display settings change event for the device object. The method is called whenever the operating system screen resolution and (or) color depth are changed.

Parameters
bitsPerPixel[in] A new screen color depth.
xPixels[in] A new screen resolution along the X-axis (in pixels).
yPixels[in] A new screen resolution along the Y-axis (in pixels).
Remarks
This method is called after the display settings are changed.
See also
<EXTLINK https://docs.opendesign.com/tv/tv_working_with_base_classes_device_functionality.html#5">Redrawing Content of a Device</EXTLINK>

Implements OdGsDevice.

◆ onOverlayActivated()

virtual void OdGsBaseVectorizeDevice::onOverlayActivated ( OdGsOverlayId nOverlay)
protectedvirtual

◆ onOverlayDeactivated()

virtual void OdGsBaseVectorizeDevice::onOverlayDeactivated ( OdGsOverlayId nOverlay)
protectedvirtual

◆ onRealizeBackgroundPalette()

void OdGsBaseVectorizeDevice::onRealizeBackgroundPalette ( )
virtual

Notification method that tells the device to realize its palette in the background. As a rule this method is called by the client code when the GUI window gets focus.

Implements OdGsDevice.

◆ onRealizeForegroundPalette()

void OdGsBaseVectorizeDevice::onRealizeForegroundPalette ( )
virtual

Notification method that tells the device to realize its palette in the foreground. As a rule this method is called by the client code when the GUI window gets focus.

Implements OdGsDevice.

◆ onSize()

void OdGsBaseVectorizeDevice::onSize ( const OdGsDCRect & outputRect)
virtual

The handler for the resize event for a GUI window associated with the device object. The method is called whenever the size of the GUI window is changed.

Parameters
outputRect[in] A new size of the output rectangle in device coordinates (pixels).
Remarks
This method should not be called if the device object has zero width and (or) height.
See also
<EXTLINK https://docs.opendesign.com/tv/tv_working_with_base_classes_device_functionality.html#5">Redrawing Content of a Device</EXTLINK>

Implements OdGsDevice.

◆ onViewAdded()

void OdGsBaseVectorizeDevice::onViewAdded ( OdGsView * pView)

Notification method that should be called whenever a view is added to this device.

Parameters
pView[in] Pointer to a view that is added.

◆ outputRect()

const OdGsDCRect & OdGsBaseVectorizeDevice::outputRect ( ) const
inline

Retrieves the device output rectangle.

Definition at line 956 of file GsBaseVectorizeDevice.h.

◆ properties()

OdRxDictionaryPtr OdGsBaseVectorizeDevice::properties ( )
virtual

Returns smart pointer to a dictionary that stores device properties.

Implements OdGsDevice.

◆ registerOverlay()

void OdGsBaseVectorizeDevice::registerOverlay ( OdGsViewImpl * pView,
const OdGsModel * pModel )
protected

◆ renderTypeOverlay()

virtual OdGsOverlayId OdGsBaseVectorizeDevice::renderTypeOverlay ( OdGsModel::RenderType renderType) const
virtual

Returns the overlay identifier (from the OdGsOverlayId enumeration) of the specified render type.

Parameters
renderType[in] Render type.

◆ renderTypeWeight()

virtual OdUInt32 OdGsBaseVectorizeDevice::renderTypeWeight ( OdGsModel::RenderType renderType) const
virtual

◆ rootView()

const OdGsView * OdGsBaseVectorizeDevice::rootView ( ) const

Returns pointer to the root view associated with this device.

◆ saveClientDeviceState()

virtual bool OdGsBaseVectorizeDevice::saveClientDeviceState ( OdGsFiler * pFiler) const
virtual

Saves data of a client device to the specified filer.

Parameters
pFiler[in] Pointer to a filer where to save device state.
Returns
true if the state of client device is saved successfully, false otherwise.

◆ saveDeviceState()

bool OdGsBaseVectorizeDevice::saveDeviceState ( OdGsFiler * pFiler) const
virtual

Saves device data to the specified filer.

Parameters
pFiler[in] Pointer to a filer where to save device state.
Returns
true if the state of this device is saved successfully, false otherwise.

Reimplemented from OdGsDevice.

◆ saveLinkedDeviceState()

virtual bool OdGsBaseVectorizeDevice::saveLinkedDeviceState ( OdGsFiler * pFiler) const
virtual

◆ setBackgroundColor()

bool OdGsBaseVectorizeDevice::setBackgroundColor ( ODCOLORREF backgroundColor)
virtual

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

Parameters
backgroundColor[in] Background color.

Implements OdGsDevice.

◆ setInvalid()

void OdGsBaseVectorizeDevice::setInvalid ( bool bSet)
inline

Reset device completely invalid state flag.

Parameters
bSet[in] New device invalid state.

Definition at line 154 of file GsBaseVectorizeDevice.h.

◆ setLogicalPalette()

void OdGsBaseVectorizeDevice::setLogicalPalette ( const ODCOLORREF * logicalPalette,
int numColors )
virtual

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

Implements OdGsDevice.

◆ setSortRenderTypes()

void OdGsBaseVectorizeDevice::setSortRenderTypes ( bool flag)
inline

Definition at line 850 of file GsBaseVectorizeDevice.h.

◆ setSupportHighlightTwoPass()

void OdGsBaseVectorizeDevice::setSupportHighlightTwoPass ( bool bOn)
inline

Enables or disables secondary highlighting rendering pass support.

Parameters
bOn[in] Flag that specifies whether to enable secondary highlighting rendering pass support.

Definition at line 890 of file GsBaseVectorizeDevice.h.

◆ setSupportInteractiveViewMode()

void OdGsBaseVectorizeDevice::setSupportInteractiveViewMode ( bool bSet)
inline

Switches on or off the interactivity mode for owned GS views.

Parameters
bSet[in] Flag that specifies whether to enable interactivity mode.
See also
<link gs_views_interactivity_mode, Work with Interactivity Mode for Views>

Definition at line 795 of file GsBaseVectorizeDevice.h.

◆ setSupportOverlays()

void OdGsBaseVectorizeDevice::setSupportOverlays ( bool bFlag)
inline

Specifies whether graphics system overlays are supported.

Returns
true if overlays are supported by this device, false otherwise.

Definition at line 860 of file GsBaseVectorizeDevice.h.

◆ setTransientManager()

void OdGsBaseVectorizeDevice::setTransientManager ( OdGiTransientManager * pManager)

Sets a transient drawable manager for this device.

Parameters
pManager[in] Pointer to a transient manager.

◆ setTransientRenderType()

void OdGsBaseVectorizeDevice::setTransientRenderType ( OdGsModel::RenderType renderType)
inline

Definition at line 950 of file GsBaseVectorizeDevice.h.

◆ setUpdateManager()

void OdGsBaseVectorizeDevice::setUpdateManager ( OdGsUpdateManagerPtr pManager)
virtual

Sets an update manager for this device.

Parameters
pManager[in] Smart pointer to an update manager for this device.

Reimplemented from OdGsDevice.

◆ setUserGiContext()

void OdGsBaseVectorizeDevice::setUserGiContext ( OdGiContext * pUserGiContext)
virtual

Sets the user context object associated with this device.

Parameters
pUserGiContext[in] Pointer to the user context.

Implements OdGsDevice.

◆ setValid()

void OdGsBaseVectorizeDevice::setValid ( bool bFlag)

Reset all invalidation device state parameters.

Parameters
bFlag[in] New device validity state.

◆ sortRenderTypes()

bool OdGsBaseVectorizeDevice::sortRenderTypes ( ) const
inline

Definition at line 845 of file GsBaseVectorizeDevice.h.

◆ supportBlocks()

bool OdGsBaseVectorizeDevice::supportBlocks ( ) const
inline

Checks whether this device supports blocks.

Returns
true if this device supports dynamic sub-entities highlight, false otherwise.

Definition at line 915 of file GsBaseVectorizeDevice.h.

◆ supportComposition()

bool OdGsBaseVectorizeDevice::supportComposition ( ) const
inline

Checks whether this device supports vectorization modules compositions.

Returns
true if this device supports composition, false otherwise.
See also
<link WinComposite, Viewport-Specific Render Modes using WinComposite Vectorization>

Definition at line 920 of file GsBaseVectorizeDevice.h.

◆ supportDynamicHighlight()

bool OdGsBaseVectorizeDevice::supportDynamicHighlight ( ) const
inline

Checks whether this device supports dynamic entities highlight.

Returns
true if this device supports dynamic entities highlight, false otherwise.

Definition at line 900 of file GsBaseVectorizeDevice.h.

◆ supportDynamicSubhighlight()

bool OdGsBaseVectorizeDevice::supportDynamicSubhighlight ( ) const
inline

Checks whether this device supports dynamic sub-entities highlight.

Returns
true if this device supports dynamic sub-entities highlight, false otherwise.

Definition at line 905 of file GsBaseVectorizeDevice.h.

◆ supportHighlightTwoPass()

bool OdGsBaseVectorizeDevice::supportHighlightTwoPass ( ) const
inline

Checks whether this device supports secondary highlighting rendering pass.

Returns
true if secondary highlighting rendering pass supported, false otherwise.

Definition at line 885 of file GsBaseVectorizeDevice.h.

◆ supportInteractiveViewMode()

bool OdGsBaseVectorizeDevice::supportInteractiveViewMode ( ) const
inline

Checks whether this device supports interactivity mode for owned GS views.

Returns
true if this device supports interactivity mode for its views, false otherwise.
See also
<link gs_views_interactivity_mode, Work with Interactivity Mode for Views>

Definition at line 787 of file GsBaseVectorizeDevice.h.

◆ supportOverlays()

bool OdGsBaseVectorizeDevice::supportOverlays ( ) const
inline

Checks whether overlays are supported by this device.

Returns
true if overlays are supported by this device, false otherwise.

Definition at line 855 of file GsBaseVectorizeDevice.h.

◆ supportParallelDisplay()

virtual bool OdGsBaseVectorizeDevice::supportParallelDisplay ( ) const
inlineprotectedvirtual

Definition at line 828 of file GsBaseVectorizeDevice.h.

◆ supportPartialScreenUpdate()

virtual bool OdGsBaseVectorizeDevice::supportPartialScreenUpdate ( ) const
virtual

Returns true in case if device support partial update of separate viewports.

◆ supportPartialUpdate()

virtual bool OdGsBaseVectorizeDevice::supportPartialUpdate ( ) const
virtual

Checks whether this device supports partial update (of a device surface, i.e. screen).

Returns
true if partial update is supported, false otherwise.
Remarks
Must be overridden to return true in child class to inform base implementation that child class supports partial update.

◆ supportSelectionStyles()

bool OdGsBaseVectorizeDevice::supportSelectionStyles ( ) const
inline

Checks whether this device supports multiple selection (highlighting) styles.

Returns
true if this device supports multiple selection (highlighting) styles.

Definition at line 910 of file GsBaseVectorizeDevice.h.

◆ transientManager()

OdGiTransientManager * OdGsBaseVectorizeDevice::transientManager ( )

Retrieves a pointer to the transient manager.

◆ transientRenderType()

OdGsModel::RenderType OdGsBaseVectorizeDevice::transientRenderType ( ) const
inline

Definition at line 945 of file GsBaseVectorizeDevice.h.

◆ unregisterOverlay()

void OdGsBaseVectorizeDevice::unregisterOverlay ( OdGsViewImpl * pView,
const OdGsModel * pModel )
protected

◆ update()

virtual void OdGsBaseVectorizeDevice::update ( OdGsDCRect * pUpdatedRect)
virtual

Updates the GUI window (or its region) associated with the device object.

Parameters
pUpdatedRect[in] A pointer to the rectangle object that represents the window region to be updated.
bSkipPartialRequest[in] A partial viewing flag value. If equal to true, partial viewing is disabled during the method call.
Remarks
The method affects all OdGsView objects owned by the device object, and so it displays the correct image on the GUI window (or its region). If the pointer to a window region (the pUpdatedRect parameter value) is NULL, the whole window is updated.
See also
<EXTLINK https://docs.opendesign.com/tv/tv_working_with_base_classes_device_functionality.html#5">Redrawing Content of a Device</EXTLINK>

Implements OdGsDevice.

◆ updateGeometry()

virtual void OdGsBaseVectorizeDevice::updateGeometry ( )
virtual

Updates the display of geometry objects viewed by all valid visible views owned by this device.

◆ updateManager()

OdGsUpdateManager * OdGsBaseVectorizeDevice::updateManager ( )
inline

Retrieves a pointer to an update manager for this device.

Definition at line 812 of file GsBaseVectorizeDevice.h.

◆ updateScreen()

virtual void OdGsBaseVectorizeDevice::updateScreen ( )
virtual

◆ userGiContext()

OdGiContext * OdGsBaseVectorizeDevice::userGiContext ( ) const
virtual

Returns the user context object associated with this device.

Implements OdGsDevice.

◆ useVpFilterFunction()

bool OdGsBaseVectorizeDevice::useVpFilterFunction ( ) const
inline

Definition at line 709 of file GsBaseVectorizeDevice.h.

◆ useVpLtypeScaleMult()

bool OdGsBaseVectorizeDevice::useVpLtypeScaleMult ( ) const
inline

Definition at line 708 of file GsBaseVectorizeDevice.h.

◆ viewAt() [1/2]

OdGsView * OdGsBaseVectorizeDevice::viewAt ( int viewIndex)
virtual

Returns the specified OdGsView object associated with this Device object.

Parameters
viewIndex[in] View index.

Implements OdGsDevice.

◆ viewAt() [2/2]

const OdGsView * OdGsBaseVectorizeDevice::viewAt ( int viewIndex) const

Returns the specified OdGsView object associated with this Device object.

Parameters
viewIndex[in] View index.

◆ viewImplAt() [1/2]

OdGsViewImpl * OdGsBaseVectorizeDevice::viewImplAt ( int viewIndex)

Returns the implementation OdGsViewImpl object associated with this Device object.

Parameters
viewIndex[in] View index.

◆ viewImplAt() [2/2]

const OdGsViewImpl * OdGsBaseVectorizeDevice::viewImplAt ( int viewIndex) const

Returns the implementation OdGsViewImpl object associated with this Device object.

Parameters
viewIndex[in] View index.

◆ viewUpdateScreen()

void OdGsBaseVectorizeDevice::viewUpdateScreen ( OdGsBaseVectorizeView * pView,
bool bUpdate )
protected

◆ vOffset()

int OdGsBaseVectorizeDevice::vOffset ( ) const

Returns vertical offset of this Device object output surface in pixels.

Returns
Vertical offset of this Device object output surface in pixels.

◆ width()

int OdGsBaseVectorizeDevice::width ( ) const

Returns the width of this Device object output surface in pixels.

Returns
The width of this Device object output surface in pixels.

Friends And Related Symbol Documentation

◆ DisplayScheduler

friend class DisplayScheduler
friend

Definition at line 826 of file GsBaseVectorizeDevice.h.

◆ OdGsBaseModule

friend class OdGsBaseModule
friend

Definition at line 76 of file GsBaseVectorizeDevice.h.

◆ OdGsBaseVectorizeView

friend class OdGsBaseVectorizeView
friend

Definition at line 74 of file GsBaseVectorizeDevice.h.

◆ OdGsNodeContext

friend class OdGsNodeContext
friend

Definition at line 827 of file GsBaseVectorizeDevice.h.

◆ OdGsViewImpl

friend class OdGsViewImpl
friend

Definition at line 73 of file GsBaseVectorizeDevice.h.

Member Data Documentation

◆ m_Background

ODCOLORREF OdGsBaseVectorizeDevice::m_Background
protected

Definition at line 84 of file GsBaseVectorizeDevice.h.

◆ m_flags

OdUInt32 OdGsBaseVectorizeDevice::m_flags
protected

Definition at line 94 of file GsBaseVectorizeDevice.h.

◆ m_logPalette

ODGSPALETTE OdGsBaseVectorizeDevice::m_logPalette
protected

Definition at line 83 of file GsBaseVectorizeDevice.h.

◆ m_outputRect

OdGsDCRect OdGsBaseVectorizeDevice::m_outputRect
protected

Definition at line 85 of file GsBaseVectorizeDevice.h.

◆ m_overlayData

GsDeviceOverlayDataContainer OdGsBaseVectorizeDevice::m_overlayData
protected

Definition at line 136 of file GsBaseVectorizeDevice.h.

◆ m_pDeviceRef

OdRxObjectPtr OdGsBaseVectorizeDevice::m_pDeviceRef
protected

Definition at line 821 of file GsBaseVectorizeDevice.h.

◆ m_pUpdateManager

OdGsUpdateManagerPtr OdGsBaseVectorizeDevice::m_pUpdateManager
protected

Definition at line 92 of file GsBaseVectorizeDevice.h.

◆ m_pUserContext

OdSmartPtr<OdGiContext> OdGsBaseVectorizeDevice::m_pUserContext
protected

Definition at line 86 of file GsBaseVectorizeDevice.h.

◆ m_sectionGeometryMap

OdRxObjectPtr OdGsBaseVectorizeDevice::m_sectionGeometryMap
protected

Definition at line 87 of file GsBaseVectorizeDevice.h.

◆ m_sectionManager

OdRxObjectPtr OdGsBaseVectorizeDevice::m_sectionManager
protected

Definition at line 88 of file GsBaseVectorizeDevice.h.

◆ m_transientManager

OdGiTransientManagerPtr OdGsBaseVectorizeDevice::m_transientManager
protected

Definition at line 89 of file GsBaseVectorizeDevice.h.

◆ m_transientRenderType

OdGsModel::RenderType OdGsBaseVectorizeDevice::m_transientRenderType
protected

Definition at line 90 of file GsBaseVectorizeDevice.h.

◆ m_vectPerfData

GsVectPerformanceData OdGsBaseVectorizeDevice::m_vectPerfData

Definition at line 835 of file GsBaseVectorizeDevice.h.

◆ m_views

OdArray<OdGsViewPtr> OdGsBaseVectorizeDevice::m_views
protected

Definition at line 82 of file GsBaseVectorizeDevice.h.

The documentation for this class was generated from the following file:
Generated on Tue Apr 15 2025 11:30:32