CFx SDK Documentation  2023 SP0
Classes | Public Types | Public Member Functions | List of all members
OdTrVisRendition Class Referenceabstract

#include <TrVisRendition.h>

Inheritance diagram for OdTrVisRendition:
OdRxObject OdTrVisRenditionDef OdTrVisRenditionRedir OdStaticRxObject< OdTrVisRenditionDef > OdTrVisRenditionRecorder OdTrVisRenditionMt OdStaticRxObject< OdTrVisRenditionRecorder >

Classes

struct  ClientInfo
 
struct  ClientSettings
 
struct  IdRegistrator
 

Public Types

enum  KindOfViewportModification {
  kViewportModVisibility = OdTrVisViewportDef::kViewportModVisibility , kViewportModOrientation = OdTrVisViewportDef::kViewportModOrientation , kViewportModPersistent = OdTrVisViewportDef::kViewportModPersistent , kViewportModContextual = OdTrVisViewportDef::kViewportModContextual ,
  kViewportModRect = OdTrVisViewportDef::kViewportModRect , kViewportModNrcClip = OdTrVisViewportDef::kViewportModNrcClip , kViewportModLineweights = OdTrVisViewportDef::kViewportModLineweights , kViewportModShader = OdTrVisViewportDef::kViewportModShader ,
  kViewportModBorder = OdTrVisViewportDef::kViewportModBorder , kViewportModAll = OdTrVisViewportDef::kViewportModAll
}
 
enum  DataType {
  kSurfaceData = 0 , kViewportData , kViewportPropsData , kOrderData ,
  kLightsData , kBackgroundData , kExtentsData , kMetafileData ,
  kMetafilePropsData , kHlBranchData , kTextureData , kMaterialData ,
  kProgramData , kVisualStyleData , kLayerData , kOverlayData ,
  kOverlayPropsData , kNDataTypes
}
 
enum  MtHandlerType {
  kMtSkip = 0 , kMtRedirect , kMtGlobal , kMtCompete ,
  kMtRecord
}
 
enum  DisplayIdCodes {
  kDisplayCodeZero = 0 , kDisplayCodeHighlight = 1 , kDisplayCodeUnhighlight = 2 , kDisplayCodePushMatrix = 3 ,
  kDisplayCodePopMatrix = 4 , kDisplayCodeSelMarkers = 5 , kDisplayCodeRange = 0x10
}
 
enum  RenditionFlags {
  kSupportPartialUpdate = (1 << 0) , kSupportSnapshotQueries = (1 << 1) , kSupportCompositeMetafiles = (1 << 2) , kSupportVisualStyles = (1 << 3) ,
  kSupportGsStateSaving = (1 << 4) , kSupportOverlayBuffers = (1 << 5) , kUpdateClientSectionOnly = (1 << 6) , kUpdateShareableSectionOnly = (1 << 7)
}
 

Public Member Functions

 ODRX_USING_HEAP_OPERATORS (OdRxObject)
 
 OdTrVisRendition ()
 
 ~OdTrVisRendition ()
 
virtual void onDeviceUpdateBegin (OdTrVisRenderClient *pDevice)=0
 
virtual void onDeviceUpdateEnd (OdTrVisRenderClient *pDevice)=0
 
virtual OdUInt32 queryRenditionCaps (OdUInt32 requestFor=0xFFFFFFFF) const =0
 
bool isSupportPartialUpdate () const
 
bool isSupportSnapshotQueries () const
 
bool isSupportCompositeMetafiles () const
 
bool isSupportVisualStyles () const
 
bool isSupportGsStateSaving () const
 
bool isSupportOverlayBuffers () const
 
bool updateClientDependentSectionOnly () const
 
bool updateShareableSectionOnly () const
 
virtual void onPartialUpdateInvalidRects (OdTrVisOverlayId overlayId, const OdGsDCRectArray &invalidRects, bool bOverlayInvalid=false)=0
 
virtual void onPartialUpdateList (OdTrVisViewportId viewportId, OdTrVisOverlayId overlayId, const OdTrVisDisplayId *pList, OdUInt32 nEntries)=0
 
virtual void querySnapshot (OdUInt8 *pScanlines, long minX, long minY, long nWidth, long nHeight)=0
 
virtual OdTrVisSharingProviderClientPtr createSharingProvider ()=0
 
virtual MtHandlerType mtDataTypeProcessing (DataType &type) const =0
 
virtual IdRegistratoridRegistrator () const =0
 
virtual bool queryMetafileStream (OdTrVisDisplayId displayId, const OdTrVisFlatMetafileContainer **pStream) const =0
 
virtual OdTrVisProgramId queryProgramId (OdGsView::RenderMode mode, OdTrVisVisualStyleId vsId=kTrVisNegativeId, OdTrVisGeomType geomType=OdTrVisGeomType_Default, OdUInt32 shadingFlags=0) const =0
 
virtual bool saveRenditionState (OdGsFiler *pFiler) const =0
 
virtual bool loadRenditionState (OdGsFiler *pFiler, OdTrVisIdMap *pIdMap)=0
 
virtual void obtainClientSettings (ClientSettings &clientSets)=0
 
virtual void onSurfaceChanged (const OdTrVisSurfaceDef &pDef)=0
 
virtual void onOverlayAdded (OdTrVisOverlayId overlayId, const OdTrVisOverlayDef &pDef)=0
 
virtual void onOverlayDeleted (OdTrVisOverlayId overlayId)=0
 
virtual void onOverlayVisibilityChanged (OdTrVisOverlayId overlayId, bool bVisibility)=0
 
virtual void onOverlayRenderOrderChanged (OdTrVisOverlayId overlayId, OdInt16 nRenderOrder)=0
 
virtual void onViewportAdded (OdTrVisViewportId viewportId)=0
 
virtual void onViewportDeleted (OdTrVisViewportId viewportId)=0
 
virtual void onViewportInserted (OdTrVisViewportId viewportId, int nIndex)=0
 
virtual void onViewportModified (OdTrVisViewportId viewportId, const OdTrVisViewportDef &pDef, OdUInt32 kindOfMod=kViewportModAll)=0
 
virtual void onMetafileOrderChanged (OdTrVisViewportId viewportId, OdTrVisOverlayId overlayId, const OdTrVisDisplayId *pList, OdUInt32 nEntries)=0
 
virtual void onMetafileOrderChanged (OdTrVisViewportId viewportId, OdTrVisOverlayId overlayId, OdUInt32 nInvalidFrom, OdUInt32 nInvalidLen, const OdTrVisDisplayId *pValidFrom, OdUInt32 nValidLen)=0
 
virtual void onLightsListChanged (OdTrVisViewportId viewportId, float ambientLight[4], bool bDefaultLightsOn, const OdTrVisLightDef *pList, OdUInt32 nEntries)=0
 
virtual void onBackgroundChanged (OdTrVisViewportId viewportId, OdTrVisFlatMetafileContainerPtr pStream, OdTrVisProgramId baseProgramId=kTrVisNegativeId)=0
 
virtual void onExtentsChanged (OdTrVisViewportId viewportId, OdTrVisOverlayId overlayId, const OdTrVisExtentsDef &pDef)=0
 
virtual void onOverlayViewParamsOverride (OdTrVisViewportId viewportId, OdTrVisOverlayId overlayId, bool bOverride, const OdTrVisViewParamsDef &pDef=OdTrVisViewParamsDef())=0
 
virtual OdTrVisDisplayId onMetafileAdded (OdTrVisMetafileId metafileId, const OdTrVisMetafileDef &pDef)=0
 
virtual void onMetafileDeleted (OdTrVisMetafileId metafileId)=0
 
virtual void onMetafileVisibilityChanged (OdTrVisMetafileId metafileId, bool bVisibility)=0
 
virtual void onMetafileHighlightingChanged (OdTrVisMetafileId metafileId, bool bHighlight)=0
 
virtual void onMetafileFadingChanged (OdTrVisMetafileId metafileId, bool bFade)=0
 
virtual void onMetafileHlBranchAttached (OdTrVisMetafileId metafileId, OdTrVisHlBranchId hlBranchId)=0
 
virtual void onMetafileHlBranchDetached (OdTrVisMetafileId metafileId)=0
 
virtual void onHlBranchAdded (OdTrVisHlBranchId hlBranchId, const OdTrVisHlBranchDef &pDef)=0
 
virtual void onHlBranchModified (OdTrVisHlBranchId hlBranchId, const OdTrVisHlBranchDef &pDef, bool bChildsModified, bool bMarkersModified)=0
 
virtual void onHlBranchDeleted (OdTrVisHlBranchId hlBranchId)=0
 
virtual void onTextureAdded (OdTrVisTextureId textureId, const OdTrVisTextureDef &pDef)=0
 
virtual void onTextureDeleted (OdTrVisTextureId textureId)=0
 
virtual void onMaterialAdded (OdTrVisMaterialId materialId, const OdTrVisMaterialDef &pDef)=0
 
virtual void onMaterialDeleted (OdTrVisMaterialId materialId)=0
 
virtual void onVisualStyleAdded (OdTrVisVisualStyleId visualStyleId, const OdTrVisVisualStyle &pDef)=0
 
virtual void onVisualStyleModified (OdTrVisVisualStyleId visualStyleId, const OdTrVisVisualStyle &pDef)=0
 
virtual void onVisualStyleDeleted (OdTrVisVisualStyleId visualStyleId)=0
 
virtual void onLayerAdded (OdTrVisLayerId layerId, const OdTrVisLayerDef &pDef)=0
 
virtual void onLayerModified (OdTrVisLayerId layerId, const OdTrVisLayerDef &pDef)=0
 
virtual void onLayerDeleted (OdTrVisLayerId layerId)=0
 
virtual void onLayerViewportPropsOverride (OdTrVisViewportId viewportId, OdTrVisLayerId layerId, bool bOverride, const OdTrVisLayerProps &pProps=OdTrVisLayerProps())=0
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () 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
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

<group ExRender_Windows_Classes>

Definition at line 60 of file TrVisRendition.h.

Member Enumeration Documentation

◆ DataType

Enumerator
kSurfaceData 
kViewportData 
kViewportPropsData 
kOrderData 
kLightsData 
kBackgroundData 
kExtentsData 
kMetafileData 
kMetafilePropsData 
kHlBranchData 
kTextureData 
kMaterialData 
kProgramData 
kVisualStyleData 
kLayerData 
kOverlayData 
kOverlayPropsData 
kNDataTypes 

Definition at line 88 of file TrVisRendition.h.

◆ DisplayIdCodes

Enumerator
kDisplayCodeZero 
kDisplayCodeHighlight 
kDisplayCodeUnhighlight 
kDisplayCodePushMatrix 
kDisplayCodePopMatrix 
kDisplayCodeSelMarkers 
kDisplayCodeRange 

Definition at line 113 of file TrVisRendition.h.

◆ KindOfViewportModification

Enumerator
kViewportModVisibility 
kViewportModOrientation 
kViewportModPersistent 
kViewportModContextual 
kViewportModRect 
kViewportModNrcClip 
kViewportModLineweights 
kViewportModShader 
kViewportModBorder 
kViewportModAll 

Definition at line 64 of file TrVisRendition.h.

◆ MtHandlerType

Enumerator
kMtSkip 
kMtRedirect 
kMtGlobal 
kMtCompete 
kMtRecord 

Definition at line 104 of file TrVisRendition.h.

◆ RenditionFlags

Enumerator
kSupportPartialUpdate 
kSupportSnapshotQueries 
kSupportCompositeMetafiles 
kSupportVisualStyles 
kSupportGsStateSaving 
kSupportOverlayBuffers 
kUpdateClientSectionOnly 
kUpdateShareableSectionOnly 

Definition at line 125 of file TrVisRendition.h.

Constructor & Destructor Documentation

◆ OdTrVisRendition()

OdTrVisRendition::OdTrVisRendition ( )
inline

Definition at line 248 of file TrVisRendition.h.

◆ ~OdTrVisRendition()

OdTrVisRendition::~OdTrVisRendition ( )
inline

Definition at line 249 of file TrVisRendition.h.

Member Function Documentation

◆ createSharingProvider()

virtual OdTrVisSharingProviderClientPtr OdTrVisRendition::createSharingProvider ( )
pure virtual

◆ idRegistrator()

virtual IdRegistrator* OdTrVisRendition::idRegistrator ( ) const
pure virtual

◆ isSupportCompositeMetafiles()

bool OdTrVisRendition::isSupportCompositeMetafiles ( ) const
inline

Definition at line 266 of file TrVisRendition.h.

◆ isSupportGsStateSaving()

bool OdTrVisRendition::isSupportGsStateSaving ( ) const
inline

Definition at line 270 of file TrVisRendition.h.

◆ isSupportOverlayBuffers()

bool OdTrVisRendition::isSupportOverlayBuffers ( ) const
inline

Definition at line 272 of file TrVisRendition.h.

◆ isSupportPartialUpdate()

bool OdTrVisRendition::isSupportPartialUpdate ( ) const
inline

Definition at line 262 of file TrVisRendition.h.

◆ isSupportSnapshotQueries()

bool OdTrVisRendition::isSupportSnapshotQueries ( ) const
inline

Definition at line 264 of file TrVisRendition.h.

◆ isSupportVisualStyles()

bool OdTrVisRendition::isSupportVisualStyles ( ) const
inline

Definition at line 268 of file TrVisRendition.h.

◆ loadRenditionState()

virtual bool OdTrVisRendition::loadRenditionState ( OdGsFiler pFiler,
OdTrVisIdMap pIdMap 
)
pure virtual

◆ mtDataTypeProcessing()

virtual MtHandlerType OdTrVisRendition::mtDataTypeProcessing ( DataType type) const
pure virtual

◆ obtainClientSettings()

virtual void OdTrVisRendition::obtainClientSettings ( ClientSettings clientSets)
pure virtual

◆ ODRX_USING_HEAP_OPERATORS()

OdTrVisRendition::ODRX_USING_HEAP_OPERATORS ( OdRxObject  )

◆ onBackgroundChanged()

virtual void OdTrVisRendition::onBackgroundChanged ( OdTrVisViewportId  viewportId,
OdTrVisFlatMetafileContainerPtr  pStream,
OdTrVisProgramId  baseProgramId = kTrVisNegativeId 
)
pure virtual

◆ onDeviceUpdateBegin()

virtual void OdTrVisRendition::onDeviceUpdateBegin ( OdTrVisRenderClient pDevice)
pure virtual

◆ onDeviceUpdateEnd()

virtual void OdTrVisRendition::onDeviceUpdateEnd ( OdTrVisRenderClient pDevice)
pure virtual

◆ onExtentsChanged()

virtual void OdTrVisRendition::onExtentsChanged ( OdTrVisViewportId  viewportId,
OdTrVisOverlayId  overlayId,
const OdTrVisExtentsDef pDef 
)
pure virtual

◆ onHlBranchAdded()

virtual void OdTrVisRendition::onHlBranchAdded ( OdTrVisHlBranchId  hlBranchId,
const OdTrVisHlBranchDef pDef 
)
pure virtual

◆ onHlBranchDeleted()

virtual void OdTrVisRendition::onHlBranchDeleted ( OdTrVisHlBranchId  hlBranchId)
pure virtual

◆ onHlBranchModified()

virtual void OdTrVisRendition::onHlBranchModified ( OdTrVisHlBranchId  hlBranchId,
const OdTrVisHlBranchDef pDef,
bool  bChildsModified,
bool  bMarkersModified 
)
pure virtual

◆ onLayerAdded()

virtual void OdTrVisRendition::onLayerAdded ( OdTrVisLayerId  layerId,
const OdTrVisLayerDef pDef 
)
pure virtual

◆ onLayerDeleted()

virtual void OdTrVisRendition::onLayerDeleted ( OdTrVisLayerId  layerId)
pure virtual

◆ onLayerModified()

virtual void OdTrVisRendition::onLayerModified ( OdTrVisLayerId  layerId,
const OdTrVisLayerDef pDef 
)
pure virtual

◆ onLayerViewportPropsOverride()

virtual void OdTrVisRendition::onLayerViewportPropsOverride ( OdTrVisViewportId  viewportId,
OdTrVisLayerId  layerId,
bool  bOverride,
const OdTrVisLayerProps pProps = OdTrVisLayerProps() 
)
pure virtual

◆ onLightsListChanged()

virtual void OdTrVisRendition::onLightsListChanged ( OdTrVisViewportId  viewportId,
float  ambientLight[4],
bool  bDefaultLightsOn,
const OdTrVisLightDef pList,
OdUInt32  nEntries 
)
pure virtual

◆ onMaterialAdded()

virtual void OdTrVisRendition::onMaterialAdded ( OdTrVisMaterialId  materialId,
const OdTrVisMaterialDef pDef 
)
pure virtual

◆ onMaterialDeleted()

virtual void OdTrVisRendition::onMaterialDeleted ( OdTrVisMaterialId  materialId)
pure virtual

◆ onMetafileAdded()

virtual OdTrVisDisplayId OdTrVisRendition::onMetafileAdded ( OdTrVisMetafileId  metafileId,
const OdTrVisMetafileDef pDef 
)
pure virtual

◆ onMetafileDeleted()

virtual void OdTrVisRendition::onMetafileDeleted ( OdTrVisMetafileId  metafileId)
pure virtual

◆ onMetafileFadingChanged()

virtual void OdTrVisRendition::onMetafileFadingChanged ( OdTrVisMetafileId  metafileId,
bool  bFade 
)
pure virtual

◆ onMetafileHighlightingChanged()

virtual void OdTrVisRendition::onMetafileHighlightingChanged ( OdTrVisMetafileId  metafileId,
bool  bHighlight 
)
pure virtual

◆ onMetafileHlBranchAttached()

virtual void OdTrVisRendition::onMetafileHlBranchAttached ( OdTrVisMetafileId  metafileId,
OdTrVisHlBranchId  hlBranchId 
)
pure virtual

◆ onMetafileHlBranchDetached()

virtual void OdTrVisRendition::onMetafileHlBranchDetached ( OdTrVisMetafileId  metafileId)
pure virtual

◆ onMetafileOrderChanged() [1/2]

virtual void OdTrVisRendition::onMetafileOrderChanged ( OdTrVisViewportId  viewportId,
OdTrVisOverlayId  overlayId,
const OdTrVisDisplayId pList,
OdUInt32  nEntries 
)
pure virtual

◆ onMetafileOrderChanged() [2/2]

virtual void OdTrVisRendition::onMetafileOrderChanged ( OdTrVisViewportId  viewportId,
OdTrVisOverlayId  overlayId,
OdUInt32  nInvalidFrom,
OdUInt32  nInvalidLen,
const OdTrVisDisplayId pValidFrom,
OdUInt32  nValidLen 
)
pure virtual

◆ onMetafileVisibilityChanged()

virtual void OdTrVisRendition::onMetafileVisibilityChanged ( OdTrVisMetafileId  metafileId,
bool  bVisibility 
)
pure virtual

◆ onOverlayAdded()

virtual void OdTrVisRendition::onOverlayAdded ( OdTrVisOverlayId  overlayId,
const OdTrVisOverlayDef pDef 
)
pure virtual

◆ onOverlayDeleted()

virtual void OdTrVisRendition::onOverlayDeleted ( OdTrVisOverlayId  overlayId)
pure virtual

◆ onOverlayRenderOrderChanged()

virtual void OdTrVisRendition::onOverlayRenderOrderChanged ( OdTrVisOverlayId  overlayId,
OdInt16  nRenderOrder 
)
pure virtual

◆ onOverlayViewParamsOverride()

virtual void OdTrVisRendition::onOverlayViewParamsOverride ( OdTrVisViewportId  viewportId,
OdTrVisOverlayId  overlayId,
bool  bOverride,
const OdTrVisViewParamsDef pDef = OdTrVisViewParamsDef() 
)
pure virtual

◆ onOverlayVisibilityChanged()

virtual void OdTrVisRendition::onOverlayVisibilityChanged ( OdTrVisOverlayId  overlayId,
bool  bVisibility 
)
pure virtual

◆ onPartialUpdateInvalidRects()

virtual void OdTrVisRendition::onPartialUpdateInvalidRects ( OdTrVisOverlayId  overlayId,
const OdGsDCRectArray invalidRects,
bool  bOverlayInvalid = false 
)
pure virtual

◆ onPartialUpdateList()

virtual void OdTrVisRendition::onPartialUpdateList ( OdTrVisViewportId  viewportId,
OdTrVisOverlayId  overlayId,
const OdTrVisDisplayId pList,
OdUInt32  nEntries 
)
pure virtual

◆ onSurfaceChanged()

virtual void OdTrVisRendition::onSurfaceChanged ( const OdTrVisSurfaceDef pDef)
pure virtual

◆ onTextureAdded()

virtual void OdTrVisRendition::onTextureAdded ( OdTrVisTextureId  textureId,
const OdTrVisTextureDef pDef 
)
pure virtual

◆ onTextureDeleted()

virtual void OdTrVisRendition::onTextureDeleted ( OdTrVisTextureId  textureId)
pure virtual

◆ onViewportAdded()

virtual void OdTrVisRendition::onViewportAdded ( OdTrVisViewportId  viewportId)
pure virtual

◆ onViewportDeleted()

virtual void OdTrVisRendition::onViewportDeleted ( OdTrVisViewportId  viewportId)
pure virtual

◆ onViewportInserted()

virtual void OdTrVisRendition::onViewportInserted ( OdTrVisViewportId  viewportId,
int  nIndex 
)
pure virtual

◆ onViewportModified()

virtual void OdTrVisRendition::onViewportModified ( OdTrVisViewportId  viewportId,
const OdTrVisViewportDef pDef,
OdUInt32  kindOfMod = kViewportModAll 
)
pure virtual

◆ onVisualStyleAdded()

virtual void OdTrVisRendition::onVisualStyleAdded ( OdTrVisVisualStyleId  visualStyleId,
const OdTrVisVisualStyle pDef 
)
pure virtual

◆ onVisualStyleDeleted()

virtual void OdTrVisRendition::onVisualStyleDeleted ( OdTrVisVisualStyleId  visualStyleId)
pure virtual

◆ onVisualStyleModified()

virtual void OdTrVisRendition::onVisualStyleModified ( OdTrVisVisualStyleId  visualStyleId,
const OdTrVisVisualStyle pDef 
)
pure virtual

◆ queryMetafileStream()

virtual bool OdTrVisRendition::queryMetafileStream ( OdTrVisDisplayId  displayId,
const OdTrVisFlatMetafileContainer **  pStream 
) const
pure virtual

◆ queryProgramId()

virtual OdTrVisProgramId OdTrVisRendition::queryProgramId ( OdGsView::RenderMode  mode,
OdTrVisVisualStyleId  vsId = kTrVisNegativeId,
OdTrVisGeomType  geomType = OdTrVisGeomType_Default,
OdUInt32  shadingFlags = 0 
) const
pure virtual

◆ queryRenditionCaps()

virtual OdUInt32 OdTrVisRendition::queryRenditionCaps ( OdUInt32  requestFor = 0xFFFFFFFF) const
pure virtual

◆ querySnapshot()

virtual void OdTrVisRendition::querySnapshot ( OdUInt8 pScanlines,
long  minX,
long  minY,
long  nWidth,
long  nHeight 
)
pure virtual

◆ saveRenditionState()

virtual bool OdTrVisRendition::saveRenditionState ( OdGsFiler pFiler) const
pure virtual

◆ updateClientDependentSectionOnly()

bool OdTrVisRendition::updateClientDependentSectionOnly ( ) const
inline

Definition at line 274 of file TrVisRendition.h.

◆ updateShareableSectionOnly()

bool OdTrVisRendition::updateShareableSectionOnly ( ) const
inline

Definition at line 276 of file TrVisRendition.h.


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