CFx SDK Documentation  2023 SP0
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
OdTrVisRenditionRecorder Class Reference

#include <TrVisRendition.h>

Inheritance diagram for OdTrVisRenditionRecorder:
OdTrVisRenditionDef OdTrVisRendition::IdRegistrator OdTrVisRendition OdRxObject OdStaticRxObject< OdTrVisRenditionRecorder >

Classes

struct  CallRecord
 

Public Member Functions

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

Protected Member Functions

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
 
- Protected Member Functions inherited from OdTrVisRendition::IdRegistrator
void reg (DataType type, OdTrVisId id, OdDbStub *pPersId, const void *pTransId)
 

Protected Attributes

CallRecord * m_pFirstRecord
 
CallRecord * m_pLastRecord
 
- Protected Attributes inherited from OdTrVisRenditionDef
OdTrVisRenditionDef::IdRegistratorStub m_IdRegistratorStub
 

Additional Inherited Members

- Public Types inherited from OdTrVisRendition
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)
}
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClass * desc ()
 

Detailed Description

<group ExRender_Windows_Classes>

Definition at line 1078 of file TrVisRendition.h.

Constructor & Destructor Documentation

◆ OdTrVisRenditionRecorder()

OdTrVisRenditionRecorder::OdTrVisRenditionRecorder ( )

◆ ~OdTrVisRenditionRecorder()

OdTrVisRenditionRecorder::~OdTrVisRenditionRecorder ( )

Member Function Documentation

◆ appendRecord()

void OdTrVisRenditionRecorder::appendRecord ( CallRecord *  pRecord)

◆ clearRecords()

void OdTrVisRenditionRecorder::clearRecords ( )

◆ get()

virtual OdTrVisUniqueID* OdTrVisRenditionRecorder::get ( DataType  type,
OdTrVisId  id,
bool  bKill = false 
) const
protectedvirtual

Implements OdTrVisRendition::IdRegistrator.

◆ hasRecords()

bool OdTrVisRenditionRecorder::hasRecords ( ) const
inline

Definition at line 1098 of file TrVisRendition.h.

◆ idRegistrator()

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

Reimplemented from OdTrVisRenditionDef.

◆ kill()

virtual void OdTrVisRenditionRecorder::kill ( DataType  type,
OdTrVisId  id 
)
protectedvirtual

Implements OdTrVisRendition::IdRegistrator.

◆ mtDataTypeProcessing()

virtual MtHandlerType OdTrVisRenditionRecorder::mtDataTypeProcessing ( DataType &  ) const
inlinevirtual

Reimplemented from OdTrVisRenditionDef.

Definition at line 1103 of file TrVisRendition.h.

◆ onBackgroundChanged()

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

Reimplemented from OdTrVisRenditionDef.

◆ onExtentsChanged()

virtual void OdTrVisRenditionRecorder::onExtentsChanged ( OdTrVisViewportId  viewportId,
OdTrVisOverlayId  overlayId,
const OdTrVisExtentsDef &  pDef 
)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onHlBranchAdded()

virtual void OdTrVisRenditionRecorder::onHlBranchAdded ( OdTrVisHlBranchId  hlBranchId,
const OdTrVisHlBranchDef &  pDef 
)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onHlBranchDeleted()

virtual void OdTrVisRenditionRecorder::onHlBranchDeleted ( OdTrVisHlBranchId  hlBranchId)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onHlBranchModified()

virtual void OdTrVisRenditionRecorder::onHlBranchModified ( OdTrVisHlBranchId  hlBranchId,
const OdTrVisHlBranchDef &  pDef,
bool  bChildsModified,
bool  bMarkersModified 
)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onLayerAdded()

virtual void OdTrVisRenditionRecorder::onLayerAdded ( OdTrVisLayerId  layerId,
const OdTrVisLayerDef &  pDef 
)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onLayerDeleted()

virtual void OdTrVisRenditionRecorder::onLayerDeleted ( OdTrVisLayerId  layerId)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onLayerModified()

virtual void OdTrVisRenditionRecorder::onLayerModified ( OdTrVisLayerId  layerId,
const OdTrVisLayerDef &  pDef 
)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onLayerViewportPropsOverride()

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

Reimplemented from OdTrVisRenditionDef.

◆ onLightsListChanged()

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

Reimplemented from OdTrVisRenditionDef.

◆ onMaterialAdded()

virtual void OdTrVisRenditionRecorder::onMaterialAdded ( OdTrVisMaterialId  materialId,
const OdTrVisMaterialDef &  pDef 
)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onMaterialDeleted()

virtual void OdTrVisRenditionRecorder::onMaterialDeleted ( OdTrVisMaterialId  materialId)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onMetafileAdded()

virtual OdTrVisDisplayId OdTrVisRenditionRecorder::onMetafileAdded ( OdTrVisMetafileId  metafileId,
const OdTrVisMetafileDef &  pDef 
)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onMetafileDeleted()

virtual void OdTrVisRenditionRecorder::onMetafileDeleted ( OdTrVisMetafileId  metafileId)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onMetafileFadingChanged()

virtual void OdTrVisRenditionRecorder::onMetafileFadingChanged ( OdTrVisMetafileId  metafileId,
bool  bFade 
)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onMetafileHighlightingChanged()

virtual void OdTrVisRenditionRecorder::onMetafileHighlightingChanged ( OdTrVisMetafileId  metafileId,
bool  bHighlight 
)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onMetafileHlBranchAttached()

virtual void OdTrVisRenditionRecorder::onMetafileHlBranchAttached ( OdTrVisMetafileId  metafileId,
OdTrVisHlBranchId  hlBranchId 
)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onMetafileHlBranchDetached()

virtual void OdTrVisRenditionRecorder::onMetafileHlBranchDetached ( OdTrVisMetafileId  metafileId)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onMetafileOrderChanged() [1/2]

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

Reimplemented from OdTrVisRenditionDef.

◆ onMetafileOrderChanged() [2/2]

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

Reimplemented from OdTrVisRenditionDef.

◆ onMetafileVisibilityChanged()

virtual void OdTrVisRenditionRecorder::onMetafileVisibilityChanged ( OdTrVisMetafileId  metafileId,
bool  bVisibility 
)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onOverlayAdded()

virtual void OdTrVisRenditionRecorder::onOverlayAdded ( OdTrVisOverlayId  overlayId,
const OdTrVisOverlayDef &  pDef 
)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onOverlayDeleted()

virtual void OdTrVisRenditionRecorder::onOverlayDeleted ( OdTrVisOverlayId  overlayId)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onOverlayRenderOrderChanged()

virtual void OdTrVisRenditionRecorder::onOverlayRenderOrderChanged ( OdTrVisOverlayId  overlayId,
OdInt16  nRenderOrder 
)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onOverlayViewParamsOverride()

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

Reimplemented from OdTrVisRenditionDef.

◆ onOverlayVisibilityChanged()

virtual void OdTrVisRenditionRecorder::onOverlayVisibilityChanged ( OdTrVisOverlayId  overlayId,
bool  bVisibility 
)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onSurfaceChanged()

virtual void OdTrVisRenditionRecorder::onSurfaceChanged ( const OdTrVisSurfaceDef &  pDef)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onTextureAdded()

virtual void OdTrVisRenditionRecorder::onTextureAdded ( OdTrVisTextureId  textureId,
const OdTrVisTextureDef &  pDef 
)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onTextureDeleted()

virtual void OdTrVisRenditionRecorder::onTextureDeleted ( OdTrVisTextureId  textureId)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onViewportAdded()

virtual void OdTrVisRenditionRecorder::onViewportAdded ( OdTrVisViewportId  viewportId)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onViewportDeleted()

virtual void OdTrVisRenditionRecorder::onViewportDeleted ( OdTrVisViewportId  viewportId)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onViewportInserted()

virtual void OdTrVisRenditionRecorder::onViewportInserted ( OdTrVisViewportId  viewportId,
int  nIndex 
)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onViewportModified()

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

Reimplemented from OdTrVisRenditionDef.

◆ onVisualStyleAdded()

virtual void OdTrVisRenditionRecorder::onVisualStyleAdded ( OdTrVisVisualStyleId  visualStyleId,
const OdTrVisVisualStyle &  pDef 
)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onVisualStyleDeleted()

virtual void OdTrVisRenditionRecorder::onVisualStyleDeleted ( OdTrVisVisualStyleId  visualStyleId)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ onVisualStyleModified()

virtual void OdTrVisRenditionRecorder::onVisualStyleModified ( OdTrVisVisualStyleId  visualStyleId,
const OdTrVisVisualStyle &  pDef 
)
virtual

Reimplemented from OdTrVisRenditionDef.

◆ playRecords()

void OdTrVisRenditionRecorder::playRecords ( OdTrVisRendition *  pRendition,
bool  bClear = false 
)

◆ reg() [1/3]

virtual void OdTrVisRenditionRecorder::reg ( DataType  type,
OdTrVisId  id,
const OdGiDrawable *  pTransId 
)
protectedvirtual

Implements OdTrVisRendition::IdRegistrator.

◆ reg() [2/3]

virtual void OdTrVisRenditionRecorder::reg ( DataType  type,
OdTrVisId  id,
const OdTrVisUniqueID &  uId 
)
protectedvirtual

Implements OdTrVisRendition::IdRegistrator.

◆ reg() [3/3]

virtual void OdTrVisRenditionRecorder::reg ( DataType  type,
OdTrVisId  id,
OdDbStub *  pPersId 
)
protectedvirtual

Implements OdTrVisRendition::IdRegistrator.

Member Data Documentation

◆ m_pFirstRecord

CallRecord* OdTrVisRenditionRecorder::m_pFirstRecord
protected

Definition at line 1089 of file TrVisRendition.h.

◆ m_pLastRecord

CallRecord* OdTrVisRenditionRecorder::m_pLastRecord
protected

Definition at line 1090 of file TrVisRendition.h.

The documentation for this class was generated from the following file:
Generated on Thu Feb 24 2022 15:11:12