CFx SDK Documentation 2024 SP0
|
#include <GsBaseVectorizeDevice.h>
Classes | |
struct | GsDeviceOverlayData |
class | GsDeviceOverlayDataContainer |
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) |
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 () |
This class implements bitmapped GUI display windows.
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>
Definition at line 71 of file GsBaseVectorizeDevice.h.
|
protected |
Definition at line 93 of file GsBaseVectorizeDevice.h.
OdGsBaseVectorizeDevice::~OdGsBaseVectorizeDevice | ( | ) |
Destructor for the OdGsBaseVectorizeDevice class. Erases all contained view.
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.
Associates the specified Viewport object with this Device object.
pView | [in] Pointer to the OdGsView object. |
Implements OdGsDevice.
void OdGsBaseVectorizeDevice::clearSectionGeometryMap | ( | ) |
Clears the section geometry map.
|
protected |
|
inline |
Checks whether vectorization modules compositions is enabled for this device.
Definition at line 921 of file GsBaseVectorizeDevice.h.
|
virtual |
Creates a new OdGsModel object, and associates it with this Device object.
Implements OdGsDevice.
|
virtual |
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. |
Implements OdGsDevice.
|
inline |
Definition at line 819 of file GsBaseVectorizeDevice.h.
|
inline |
Disables or enables spatial indexes.
bSet | [in] Flag that specifies whether to disable spatial indexes. True to disable, false to enable. |
Definition at line 866 of file GsBaseVectorizeDevice.h.
|
inline |
Enables or disables vectorization modules compositions for this device.
bSet | [in] Flag that specifies whether to enable vectorization modules compositions. |
Definition at line 926 of file GsBaseVectorizeDevice.h.
|
inline |
Enables or disables culling volume usage.
bSet | [in] Flag that specifies whether to enable culling volume. |
Definition at line 876 of file GsBaseVectorizeDevice.h.
|
inline |
Enables or disables displaying of off-layers.
bSet | [in] Flag that specifies whether to enable displaying of off-layers. |
Definition at line 936 of file GsBaseVectorizeDevice.h.
|
virtual |
Erases all views associated with this Device object.
Implements OdGsDevice.
|
virtual |
Erases the specified View object.
viewIndex | [in] View index. |
Implements OdGsDevice.
|
virtual |
Erases the specified View object.
pView | [in] Pointer to the OdGsView object. |
Implements OdGsDevice.
|
virtual |
Returns the Background Color of the GUI window of this Device object.
Implements OdGsDevice.
|
inline |
Returns the specified color in the logical palette of this Device object.
colorIndex | [in] Color index. |
Definition at line 964 of file GsBaseVectorizeDevice.h.
|
protected |
|
inlinevirtual |
Returns the logical palette of this Device object.
numColors | [out] Returns number of colors inside logical palette. |
Implements OdGsDevice.
Definition at line 976 of file GsBaseVectorizeDevice.h.
|
inline |
Returns the logical palette of this Device object.
Definition at line 970 of file GsBaseVectorizeDevice.h.
ODCOLORREF OdGsBaseVectorizeDevice::getPaletteBackground | ( | ) | const |
Returns background color in the logical palette of this Device object.
|
virtual |
Retrieves pointer to the section geometry manager.
OdRxObjectPtr OdGsBaseVectorizeDevice::getSectionGeometryMap | ( | ) |
Retrieves smart pointer to the section geometry map.
|
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.
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 958 of file GsBaseVectorizeDevice.h.
|
virtual |
Returns image of current device buffer. Currently not implemented.
pImage | [out] Pointer for image to return. |
region | [in] Rectangle specifies region to capture. |
Implements OdGsDevice.
|
virtual |
Retrieves smart pointer to an update manager for this device.
createIfNotExist | [in] Flag that specifies whether to create a new update manager if there is no update for this device. |
Reimplemented from OdGsDevice.
OdGsOverlayId OdGsBaseVectorizeDevice::gsModelOverlay | ( | const OdGsModel * | pModel | ) | const |
Returns the overlay identifier (from the OdGsOverlayId enumeration) of the specified model.
pModel | [in] Pointer to a model. |
int OdGsBaseVectorizeDevice::height | ( | ) | const |
Returns the height of this Device object output surface in pixels.
int OdGsBaseVectorizeDevice::hOffset | ( | ) | const |
Returns horizontal offset of this Device object output surface in pixels.
|
protected |
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.
|
inline |
Returns true in case if device in completely invalid state.
Definition at line 145 of file GsBaseVectorizeDevice.h.
|
virtual |
Marks for refresh the GUI window related to the device.
Implements OdGsDevice.
|
virtual |
Marks for refresh a specified region of the GUI window related to the device.
screenRect | [in] A rectangle that specifies the window region to be refreshed. |
Implements OdGsDevice.
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.
pModel | [in] Pointer to a model. |
screenRect | [in] A rectangle that specifies the window region to be refreshed. |
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.
pView | [in] Pointer to a view. |
screenRect | [in] A rectangle that specifies the window region to be refreshed. |
Marks overlays for refresh.
nOverlays | [in] Number of overlays. |
|
virtual |
Marks the specified screen rectangle of overlays for refresh.
nOverlays | [in] Number of overlays. |
void OdGsBaseVectorizeDevice::invalidateRegion | ( | const OdGiPathNode & | path | ) |
Marks for refresh a specified path node.
path | [in] Path to a mode that needs to be invalidated. |
const OdGsDCRectArray & OdGsBaseVectorizeDevice::invalidRects | ( | ) | const |
const OdGsDCRectArray * OdGsBaseVectorizeDevice::invalidRects | ( | OdGsOverlayId | overlayId | ) | const |
|
inline |
Checks whether culling volume is enabled.
Definition at line 871 of file GsBaseVectorizeDevice.h.
|
inline |
Checks whether off-layers displaying enabled.
Definition at line 931 of file GsBaseVectorizeDevice.h.
|
virtual |
Checks compatibility between specified OdGsModel and this Device object.
pModel | [in] Model object pointer to check compatibility. |
Reimplemented from OdGsDevice.
|
inline |
Checks whether this device displays image in the multi-threaded mode.
Definition at line 891 of file GsBaseVectorizeDevice.h.
int OdGsBaseVectorizeDevice::isOverlayRequireUpdate | ( | OdGsOverlayId | overlayId | ) | const |
Checks whether the specified overlay needs to be updated.
overlayId | [in] Overlay ID. |
|
inline |
Checks whether spatial indexes are disable.
Definition at line 861 of file GsBaseVectorizeDevice.h.
|
virtual |
Checks whether this device supports saving its state.
|
inline |
Indicates that GS should not skip hidden entities.
Definition at line 814 of file GsBaseVectorizeDevice.h.
|
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.
Implements OdGsDevice.
|
inline |
Checks whether the passed viewport identifier is valid.
acgiId | [in] Viewport ID. |
Definition at line 699 of file GsBaseVectorizeDevice.h.
|
virtual |
Loads data of a client device from the specified filer.
pFiler | [in] Pointer to a filer from which to read device state. |
|
virtual |
Loads device data from the specified filer.
pFiler | [in] Pointer to a filer from which to read device state. |
Reimplemented from OdGsDevice.
|
virtual |
|
inline |
Definition at line 721 of file GsBaseVectorizeDevice.h.
|
virtual |
Returns the number of views associated with this Device object.
Implements OdGsDevice.
OdGsBaseVectorizeDevice::ODRX_DECLARE_MEMBERS | ( | OdGsBaseVectorizeDevice | ) |
|
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.
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). |
Implements OdGsDevice.
|
protectedvirtual |
|
protectedvirtual |
|
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.
|
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.
|
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.
outputRect | [in] A new size of the output rectangle in device coordinates (pixels). |
Implements OdGsDevice.
Notification method that should be called whenever a view is added to this device.
pView | [in] Pointer to a view that is added. |
|
inline |
Retrieves the device output rectangle.
Definition at line 952 of file GsBaseVectorizeDevice.h.
|
virtual |
Returns smart pointer to a dictionary that stores device properties.
Implements OdGsDevice.
|
protected |
|
virtual |
Returns the overlay identifier (from the OdGsOverlayId enumeration) of the specified render type.
renderType | [in] Render type. |
|
virtual |
const OdGsView * OdGsBaseVectorizeDevice::rootView | ( | ) | const |
Returns pointer to the root view associated with this device.
|
virtual |
Saves data of a client device to the specified filer.
pFiler | [in] Pointer to a filer where to save device state. |
|
virtual |
Saves device data to the specified filer.
pFiler | [in] Pointer to a filer where to save device state. |
Reimplemented from OdGsDevice.
|
virtual |
|
virtual |
Sets the Background Color of the GUI window of this Device object.
backgroundColor | [in] Background color. |
Implements OdGsDevice.
|
inline |
Reset device completely invalid state flag.
bSet | [in] New device invalid state. |
Definition at line 150 of file GsBaseVectorizeDevice.h.
|
virtual |
Sets the logical palette to be used by this Device object.
logicalPalette | [in] Logical palette. |
numColors | [in] Number of colors in palette. |
Implements OdGsDevice.
|
inline |
Definition at line 846 of file GsBaseVectorizeDevice.h.
|
inline |
Enables or disables secondary highlighting rendering pass support.
bOn | [in] Flag that specifies whether to enable secondary highlighting rendering pass support. |
Definition at line 886 of file GsBaseVectorizeDevice.h.
|
inline |
Switches on or off the interactivity mode for owned GS views.
bSet | [in] Flag that specifies whether to enable interactivity mode. |
Definition at line 791 of file GsBaseVectorizeDevice.h.
|
inline |
Specifies whether graphics system overlays are supported.
Definition at line 856 of file GsBaseVectorizeDevice.h.
void OdGsBaseVectorizeDevice::setTransientManager | ( | OdGiTransientManager * | pManager | ) |
Sets a transient drawable manager for this device.
pManager | [in] Pointer to a transient manager. |
|
inline |
Definition at line 946 of file GsBaseVectorizeDevice.h.
|
virtual |
Sets an update manager for this device.
pManager | [in] Smart pointer to an update manager for this device. |
Reimplemented from OdGsDevice.
|
virtual |
Sets the user context object associated with this device.
pUserGiContext | [in] Pointer to the user context. |
Implements OdGsDevice.
void OdGsBaseVectorizeDevice::setValid | ( | bool | bFlag | ) |
Reset all invalidation device state parameters.
bFlag | [in] New device validity state. |
|
inline |
Definition at line 841 of file GsBaseVectorizeDevice.h.
|
inline |
Checks whether this device supports blocks.
Definition at line 911 of file GsBaseVectorizeDevice.h.
|
inline |
Checks whether this device supports vectorization modules compositions.
Definition at line 916 of file GsBaseVectorizeDevice.h.
|
inline |
Checks whether this device supports dynamic entities highlight.
Definition at line 896 of file GsBaseVectorizeDevice.h.
|
inline |
Checks whether this device supports dynamic sub-entities highlight.
Definition at line 901 of file GsBaseVectorizeDevice.h.
|
inline |
Checks whether this device supports secondary highlighting rendering pass.
Definition at line 881 of file GsBaseVectorizeDevice.h.
|
inline |
Checks whether this device supports interactivity mode for owned GS views.
Definition at line 783 of file GsBaseVectorizeDevice.h.
|
inline |
Checks whether overlays are supported by this device.
Definition at line 851 of file GsBaseVectorizeDevice.h.
|
inlineprotectedvirtual |
Definition at line 824 of file GsBaseVectorizeDevice.h.
|
virtual |
Returns true in case if device support partial update of separate viewports.
|
virtual |
Checks whether this device supports partial update (of a device surface, i.e. screen).
|
inline |
Checks whether this device supports multiple selection (highlighting) styles.
Definition at line 906 of file GsBaseVectorizeDevice.h.
OdGiTransientManager * OdGsBaseVectorizeDevice::transientManager | ( | ) |
Retrieves a pointer to the transient manager.
|
inline |
Definition at line 941 of file GsBaseVectorizeDevice.h.
|
protected |
|
virtual |
Updates the GUI window (or its region) associated with the device object.
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. |
Implements OdGsDevice.
|
virtual |
Updates the display of geometry objects viewed by all valid visible views owned by this device.
|
inline |
Retrieves a pointer to an update manager for this device.
Definition at line 808 of file GsBaseVectorizeDevice.h.
|
virtual |
|
virtual |
Returns the user context object associated with this device.
Implements OdGsDevice.
|
inline |
Definition at line 705 of file GsBaseVectorizeDevice.h.
|
inline |
Definition at line 704 of file GsBaseVectorizeDevice.h.
|
virtual |
Returns the specified OdGsView object associated with this Device object.
viewIndex | [in] View index. |
Implements OdGsDevice.
const OdGsView * OdGsBaseVectorizeDevice::viewAt | ( | int | viewIndex | ) | const |
Returns the specified OdGsView object associated with this Device object.
viewIndex | [in] View index. |
OdGsViewImpl * OdGsBaseVectorizeDevice::viewImplAt | ( | int | viewIndex | ) |
Returns the implementation OdGsViewImpl object associated with this Device object.
viewIndex | [in] View index. |
const OdGsViewImpl * OdGsBaseVectorizeDevice::viewImplAt | ( | int | viewIndex | ) | const |
Returns the implementation OdGsViewImpl object associated with this Device object.
viewIndex | [in] View index. |
|
protected |
int OdGsBaseVectorizeDevice::vOffset | ( | ) | const |
Returns vertical offset of this Device object output surface in pixels.
int OdGsBaseVectorizeDevice::width | ( | ) | const |
Returns the width of this Device object output surface in pixels.
|
friend |
Definition at line 822 of file GsBaseVectorizeDevice.h.
|
friend |
Definition at line 76 of file GsBaseVectorizeDevice.h.
|
friend |
Definition at line 74 of file GsBaseVectorizeDevice.h.
|
friend |
Definition at line 823 of file GsBaseVectorizeDevice.h.
|
friend |
Definition at line 73 of file GsBaseVectorizeDevice.h.
|
protected |
Definition at line 82 of file GsBaseVectorizeDevice.h.
|
protected |
Definition at line 92 of file GsBaseVectorizeDevice.h.
|
protected |
Definition at line 81 of file GsBaseVectorizeDevice.h.
|
protected |
Definition at line 83 of file GsBaseVectorizeDevice.h.
|
protected |
Definition at line 134 of file GsBaseVectorizeDevice.h.
|
protected |
Definition at line 817 of file GsBaseVectorizeDevice.h.
|
protected |
Definition at line 90 of file GsBaseVectorizeDevice.h.
|
protected |
Definition at line 84 of file GsBaseVectorizeDevice.h.
|
protected |
Definition at line 85 of file GsBaseVectorizeDevice.h.
|
protected |
Definition at line 86 of file GsBaseVectorizeDevice.h.
|
protected |
Definition at line 87 of file GsBaseVectorizeDevice.h.
|
protected |
Definition at line 88 of file GsBaseVectorizeDevice.h.
GsVectPerformanceData OdGsBaseVectorizeDevice::m_vectPerfData |
Definition at line 831 of file GsBaseVectorizeDevice.h.
|
protected |
Definition at line 80 of file GsBaseVectorizeDevice.h.