/////////////////////////////////////////////////////////////////////////////// // Copyright (C) 2002-2019, Open Design Alliance (the "Alliance"). // All rights reserved. // // This software and its documentation and related materials are owned by // the Alliance. The software may only be incorporated into application // programs owned by members of the Alliance, subject to a signed // Membership Agreement and Supplemental Software License Agreement with the // Alliance. The structure and organization of this software are the valuable // trade secrets of the Alliance and its suppliers. The software is also // protected by copyright law and international treaty provisions. Application // programs incorporating this software must include the following statement // with their copyright notices: // // This application incorporates Open Design Alliance software pursuant to a license // agreement with Open Design Alliance. // Open Design Alliance Copyright (C) 2002-2019 by Open Design Alliance. // All rights reserved. // // By use of this software, its documentation or related materials, you // acknowledge and accept the above terms. /////////////////////////////////////////////////////////////////////////////// // Multithreaded protection rendition redirection interface #ifndef ODTRVISRENDITIONMT #define ODTRVISRENDITIONMT #include "TD_PackPush.h" #include "TrVisRenditionRecorder.h" #include "StaticRxObject.h" #include "ThreadsCounter.h" /** \details */ class OdTrVisRenditionMt : public OdTrVisRenditionRedir { protected: struct DataTypeEntry { MtHandlerType m_handler; OdTrVisRendition *m_pRendition; OdMutexPtr m_ownMutex; OdMutexPtr *m_pMutex[4]; void resetMutexes(OdMutexPtr *pMutex1 = NULL, OdMutexPtr *pMutex2 = NULL, OdMutexPtr *pMutex3 = NULL, OdMutexPtr *pMutex4 = NULL) { m_pMutex[3] = pMutex4; m_pMutex[2] = pMutex3; m_pMutex[1] = pMutex2; m_pMutex[0] = pMutex1; } void cleaningMutex(OdMutexPtr *pMutex) { for (int nMutex = 0; nMutex < 4; nMutex++) { if (m_pMutex[nMutex] == pMutex) { m_pMutex[nMutex] = NULL; } } } DataTypeEntry() : m_handler(kMtSkip), m_pRendition(NULL) { resetMutexes(); } } m_dataTypes[kNDataTypes]; OdMutexPtr m_pGlobalMutex; OdMutexPtr m_pRecordMutex; OdStaticRxObject m_skipRenditionHandler; OdStaticRxObject m_recordRenditionHandler; ClientSettings m_cliSets; protected: mutable struct IdRegistratorMt : public IdRegistrator { mutable OdMutexPtr m_pMutex[kNGenericDataTypes]; IdRegistrator *m_pBaseRegistrator; IdRegistratorMt() : m_pBaseRegistrator(NULL) { } virtual void reg(DataType type, OdTrVisId id, OdDbStub *pPersId); virtual void reg(DataType type, OdTrVisId id, const OdGiDrawable *pTransId); virtual void reg(DataType type, OdTrVisId id, const OdTrVisUniqueID &uId); virtual void kill(DataType type, OdTrVisId id); virtual OdTrVisUniqueID *get(DataType type, OdTrVisId id, bool bKill = false) const; void getset(IdRegistrator *pBaseRegistrator) { m_pBaseRegistrator = pBaseRegistrator; } IdRegistrator *setget() { return (m_pBaseRegistrator) ? this : NULL; } } m_mtRegistrator; public: OdTrVisRenditionMt(); ~OdTrVisRenditionMt(); // Initialize Mt rendition void init(OdTrVisRendition *pRendition); // Check does rendition is ready for Mt bool isMt() const; // High-level callbacks // Called on starting vectorizer update. virtual void onDeviceUpdateBegin(OdTrVisRenderClient *pDevice); // Called on ending vectorizer update. virtual void onDeviceUpdateEnd(OdTrVisRenderClient *pDevice); // Returns Id registrator, or NULL if no registration supported virtual IdRegistrator *idRegistrator() const; // Returns true if metafile streams accessible directly, returns stream by Id virtual bool queryMetafileStream(OdTrVisDisplayId displayId, const OdTrVisFlatMetafileContainer **pStream) const; // Returns non-kTrVisNegativeId in case if vectorizer supports ProgramID's embedded into metafile stream virtual OdTrVisProgramId queryProgramId(OdGsView::RenderMode mode, OdTrVisVisualStyleId vsId = kTrVisNegativeId, OdTrVisGeomType geomType = OdTrVisGeomType_Default, OdUInt32 shadingFlags = 0) const; // Mid-level callbacks // Client information virtual void obtainClientSettings(ClientSettings &clientSets); // Surface virtual void onSurfaceChanged(const OdTrVisSurfaceDef &pDef); // Overlays // Called when new overlay added into device. virtual void onOverlayAdded(OdTrVisOverlayId overlayId, const OdTrVisOverlayDef &pDef); // Called when exist overlay removed from device. virtual void onOverlayDeleted(OdTrVisOverlayId overlayId); // Called when overlay visibility changed. virtual void onOverlayVisibilityChanged(OdTrVisOverlayId overlayId, bool bVisibility); // Called when overlay rendering order changed. virtual void onOverlayRenderOrderChanged(OdTrVisOverlayId overlayId, OdInt16 nRenderOrder); // Viewports // Called when new viewport added into device. virtual void onViewportAdded(OdTrVisViewportId viewportId, const OdTrVisViewportDef &pDef); // Called when viewport inserted in list with some index. virtual void onViewportInserted(OdTrVisViewportId viewportId, int nIndex, const OdTrVisViewportDef &pDef); // Called when viewport removed from device. virtual void onViewportDeleted(OdTrVisViewportId viewportId); // Called when viewport visibility changed. virtual void onViewportVisibilityChanged(OdTrVisViewportId viewportId, bool bVisibility); // Primary viewports configuration // Called when viewport view parameters is modified. virtual void onViewportViewParamsModified(OdTrVisViewportId viewportId, const OdTrVisViewParamsDef &pDef); // Called when viewport linestyle settings is modified. virtual void onViewportLineStylesModified(OdTrVisViewportId viewportId, const OdTrVisViewportLineStyleDef &pDef); // Called when viewport fading settings is modified. virtual void onViewportFadingModified(OdTrVisViewportId viewportId, const OdTrVisViewportFadingDef &pDef); // Called when viewport lineweight settings is modified. virtual void onViewportLineweightsModified(OdTrVisViewportId viewportId, const OdTrVisViewportLineweightsDef &pDef); // Called when viewport rendering mode is modified. virtual void onViewportShadingModified(OdTrVisViewportId viewportId, const OdTrVisViewportShadingDef &pDef); // Called when viewport clipping region is modified. virtual void onViewportClipModified(OdTrVisViewportId viewportId, const OdTrVisViewportClipDef &pDef, bool bNrcClipModified = true, bool bBorderModified = true); // Extended viewports configuration // Called when lights list in viewport is changed. virtual void onViewportLightsListChanged(OdTrVisViewportId viewportId, float ambientLight[4], bool bDefaultLightsOn, const OdTrVisLightDef *pList, OdUInt32 nEntries); // Called when background stream in viewport is changed. virtual void onViewportBackgroundChanged(OdTrVisViewportId viewportId, OdTrVisFlatMetafileContainerPtr pStream, OdTrVisProgramId baseProgramId = kTrVisNegativeId); // Called when viewport fog changed. virtual void onViewportFogChanged(OdTrVisViewportId viewportId, const OdTrVisFogDef &pDef = OdTrVisFogDef()); // Called when viewport sectioning modified. virtual void onViewportSectioningChanged(OdTrVisViewportId viewportId, const OdTrVisSectionDef &pDef = OdTrVisSectionDef()); // Per-overlay viewport overrides // Called when viewport needs override view parameters for specific overlay. virtual void onOverlayViewParamsOverride(OdTrVisViewportId viewportId, OdTrVisOverlayId overlayId, bool bOverride, const OdTrVisViewParamsDef &pDef = OdTrVisViewParamsDef()); // Called when viewport extents changed. virtual void onOverlayExtentsOverride(OdTrVisViewportId viewportId, OdTrVisOverlayId overlayId, const OdTrVisExtentsDef &pDef); // Viewports ordering lists // Called when order of metafiles in viewport is changed. virtual void onMetafileOrderChanged(OdTrVisViewportId viewportId, OdTrVisOverlayId overlayId, const OdTrVisDisplayId *pList, OdUInt32 nEntries); // Called when order of metafiles in viewport is changed (for obtain modified part of list by renderer). virtual void onMetafileOrderChanged(OdTrVisViewportId viewportId, OdTrVisOverlayId overlayId, OdUInt32 nInvalidFrom, OdUInt32 nInvalidLen, const OdTrVisDisplayId *pValidFrom, OdUInt32 nValidLen); // Called when order of metafiles can be inherit from other source. virtual void onMetafileOrderInheritance( OdTrVisViewportId viewportId1, OdTrVisOverlayId overlayId1, OdTrVisViewportId viewportId2 ); // Metafiles // Called when new metafile added (returns visualId, equal to metafileId by default). virtual OdTrVisDisplayId onMetafileAdded(OdTrVisMetafileId metafileId, const OdTrVisMetafileDef &pDef); // Called when exist metafile deleted. virtual void onMetafileDeleted(OdTrVisMetafileId metafileId); // Called when exist metafile changed. //virtual void onMetafileModified(OdTrVisMetafileId metafileId, const OdTrVisMetafileDef &pDef); // Called when exist metafile visibility changed. virtual void onMetafileVisibilityChanged(OdTrVisMetafileId metafileId, bool bVisibility); // Called when exist metafile highlighting changed. virtual void onMetafileHighlightingChanged(OdTrVisMetafileId metafileId, bool bHighlight); // Called when exist metafile fading changed. virtual void onMetafileFadingChanged(OdTrVisMetafileId metafileId, bool bFade); // Highlighting // Called when new highlighting branch added. virtual void onHlBranchAdded(OdTrVisHlBranchId hlBranchId, const OdTrVisHlBranchDef &pDef); // Called when exist highlighting branch modified. virtual void onHlBranchModified(OdTrVisHlBranchId hlBranchId, const OdTrVisHlBranchDef &pDef, bool bChildsModified, bool bMarkersModified); // Called when exist highlighting branch deleted. virtual void onHlBranchDeleted(OdTrVisHlBranchId hlBranchId); // Textures // Called when new texture added. virtual void onTextureAdded(OdTrVisTextureId textureId, const OdTrVisTextureDef &pDef); // Called when exist texture deleted. virtual void onTextureDeleted(OdTrVisTextureId textureId); // Materials // Called when new material added. virtual void onMaterialAdded(OdTrVisMaterialId materialId, const OdTrVisMaterialDef &pDef); // Called when exist material deleted. virtual void onMaterialDeleted(OdTrVisMaterialId materialId); // Visual Styles // Called when new visual style added. virtual void onVisualStyleAdded(OdTrVisVisualStyleId visualStyleId, const OdTrVisVisualStyle &pDef); // Called when exist visual style modified. virtual void onVisualStyleModified(OdTrVisVisualStyleId visualStyleId, const OdTrVisVisualStyle &pDef); // Called when exist visual style deleted. virtual void onVisualStyleDeleted(OdTrVisVisualStyleId visualStyleId); // Layers // Called when new layer added. virtual void onLayerAdded(OdTrVisLayerId layerId, const OdTrVisLayerDef &pDef); // Called when exist layer modified. //virtual void onLayerModified(OdTrVisLayerId layerId, const OdTrVisLayerDef &pDef); // Called when exist layer deleted. virtual void onLayerDeleted(OdTrVisLayerId layerId); // Called when exist layer visibility changed. virtual void onLayerVisibilityChanged(OdTrVisLayerId layerId, bool bVisibility); // Called when exist layer fading changed. virtual void onLayerFadingChanged(OdTrVisLayerId layerId, bool bFade); // Called when layer viewport-dependent properties changed. virtual void onLayerVpDepPropsOverride(OdTrVisLayerId layerId, OdTrVisViewportId viewportId, bool bOverride, const OdTrVisLayerProps &pProps = OdTrVisLayerProps()); // Groups // Called when new group added. virtual void onGroupAdded(OdTrVisGroupId groupId); // Called when exist group deleted. virtual void onGroupDeleted(OdTrVisGroupId groupId); // Called to attach metafiles to group. virtual void onGroupMetafilesAttached(OdTrVisGroupId groupId, const OdTrVisMetafileId *pMetafilesList, OdUInt32 nMetafiles); // Called to detach metafiles from group (if no metafiles specified - clear entire list of groupped metafiles). virtual void onGroupMetafilesDetached(OdTrVisGroupId groupId, const OdTrVisMetafileId *pMetafilesList, OdUInt32 nMetafiles); // Called to delete all groupped metafiles from graphics scene. //virtual void onGroupMetafilesDeleted(OdTrVisGroupId groupId); // Called to change visibility state for all groupped metafiles. virtual void onGroupMetafilesVisibilityChanged(OdTrVisGroupId groupId, bool bVisibility); // Called to change highlighting state for all groupped metafiles. virtual void onGroupMetafilesHighlightingChanged(OdTrVisGroupId groupId, bool bHighlight); // Called to change fading state for all groupped metafiles. virtual void onGroupMetafilesFadingChanged(OdTrVisGroupId groupId, bool bFade); // Properties // Metafile-related properties. // Called to attach property to metafile. virtual void onMetafilePropertyAttached(OdTrVisMetafileId metafileId, const OdTrVisPropertyDef &propDef); // Called to detach property from metafile. virtual void onMetafilePropertyDetached(OdTrVisMetafileId metafileId, OdTrVisPropertyDef::PropertyType propType); // Group-related properties. // Called to attach property to group. virtual void onGroupPropertyAttached(OdTrVisGroupId groupId, const OdTrVisPropertyDef &propDef); // Called to detach property from group. virtual void onGroupPropertyDetached(OdTrVisGroupId groupId, OdTrVisPropertyDef::PropertyType propType); // Layer-related properties. // Called to attach property to layer. virtual void onLayerPropertyAttached(OdTrVisLayerId layerId, const OdTrVisPropertyDef &propDef); // Called to detach property from layer. virtual void onLayerPropertyDetached(OdTrVisLayerId layerId, OdTrVisPropertyDef::PropertyType propType); // VisualStyle-related properties. // Called to attach property to visual style. virtual void onVisualStylePropertyAttached(OdTrVisVisualStyleId visualStyleId, const OdTrVisPropertyDef &propDef); // Called to detach property from visual style. virtual void onVisualStylePropertyDetached(OdTrVisVisualStyleId visualStyleId, OdTrVisPropertyDef::PropertyType propType); // Material-related properties. // Called to attach property to material. virtual void onMaterialPropertyAttached(OdTrVisMaterialId materialId, const OdTrVisPropertyDef &propDef); // Called to detach property from material. virtual void onMaterialPropertyDetached(OdTrVisMaterialId materialId, OdTrVisPropertyDef::PropertyType propType); // Texture-related properties. // Called to attach property to texture. virtual void onTexturePropertyAttached(OdTrVisTextureId textureId, const OdTrVisPropertyDef &propDef); // Called to detach property from texture. virtual void onTexturePropertyDetached(OdTrVisTextureId textureId, OdTrVisPropertyDef::PropertyType propType); // HlBranch-related properties. // Called to attach property to highlighting branch. virtual void onHlBranchPropertyAttached(OdTrVisHlBranchId hlBranchId, const OdTrVisPropertyDef &propDef); // Called to detach property from highlighting branch. virtual void onHlBranchPropertyDetached(OdTrVisHlBranchId hlBranchId, OdTrVisPropertyDef::PropertyType propType); // Viewport-related properties. // Called to attach property to viewport. virtual void onViewportPropertyAttached(OdTrVisViewportId viewportId, const OdTrVisPropertyDef &propDef); // Called to detach property from viewport. virtual void onViewportPropertyDetached(OdTrVisViewportId viewportId, OdTrVisPropertyDef::PropertyType propType); // Overlay-related properties. // Called to attach property to overlay. virtual void onOverlayPropertyAttached(OdTrVisOverlayId overlayId, const OdTrVisPropertyDef &propDef); // Called to detach property from overlay. virtual void onOverlayPropertyDetached(OdTrVisOverlayId overlayId, OdTrVisPropertyDef::PropertyType propType); }; #include "TD_PackPop.h" #endif // ODTRVISRENDITIONMT