OdGsUpdateManager Class Reference

#include <GsUpdateManager.h>

Inheritance diagram for OdGsUpdateManager:

Classes
class	OdGsUpdateManagerElement
struct	UpdateManagerSettings

Public Types
enum	FiltrationType { kKeepDrawOrder = 0 , kFilterByLimit = (1 << 0) }
enum	Action { kAdd , kRemove , kNoChanges }
typedef void(*	UpdateManagerProcessCallback) (Action action, OdUInt32 viewportId, OdDbStub *drawableId, OdGsEntityNode *pNode, OdGsUpdateManagerElement *pElement)

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGsUpdateManager)
virtual UpdateManagerSettings	settings () const =0
virtual void	setSettings (const UpdateManagerSettings &)=0
virtual void	addElement (OdUInt32 viewportId, OdGsEntityNode *pNode, OdGsUpdateManagerElement *pElement)=0
virtual void	addElement (OdUInt32 viewportId, OdGsEntityNode *pNode, OdGsUpdateManagerElement *pElement, OdUInt64 nLength, OdGsViewImpl *pView, const OdGeExtents3d &extents, bool bSetZeroWeight=false)=0
virtual void	addPriorityElement (OdUInt32 viewportId, OdGsEntityNode *pNode, OdGsUpdateManagerElement *pElement, OdUInt64 nLength)=0
virtual void	setProcessCallback (UpdateManagerProcessCallback)=0
virtual void	process ()=0
virtual void	reset ()=0
virtual void	removeElement (OdUInt32 viewportId, OdGsEntityNode *pNode, OdGsUpdateManagerElement *pElement)=0
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

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

This class represents interface of the Update Manager for Gs and Cloud purposes

Corresponding C++ library: TD_Gs <group OdGs_Classes>

Definition at line 44 of file GsUpdateManager.h.

Member Typedef Documentation

UpdateManagerProcessCallback

typedef void(* OdGsUpdateManager::UpdateManagerProcessCallback) (Action action, OdUInt32 viewportId, OdDbStub *drawableId, OdGsEntityNode *pNode, OdGsUpdateManagerElement *pElement)

Process callback for processing procedure

Parameters

action	[in] Current action
viewportId	[in] Viewport ID of the viewport required data
drawableId	[in] Drawable ID of the drawable object
pNode	[in] Pointer to the OdGsEntityNode
pElement	[in] Pointer to the OdGsUpdateManagerElement

Definition at line 99 of file GsUpdateManager.h.

Member Enumeration Documentation

Action

enum OdGsUpdateManager::Action

Action type for process callback

Enumerator
kAdd
kRemove
kNoChanges

Definition at line 61 of file GsUpdateManager.h.

FiltrationType

enum OdGsUpdateManager::FiltrationType

Filtration type

Enumerator
kKeepDrawOrder
kFilterByLimit

Definition at line 52 of file GsUpdateManager.h.

Member Function Documentation

addElement() [1/2]

virtual void OdGsUpdateManager::addElement ( OdUInt32  viewportId, OdGsEntityNode *  pNode, OdGsUpdateManagerElement *  pElement  )

pure virtual

Adds element to the Update Manager in no limit mode

Parameters

viewportId	[in] Viewport ID
pNode	[in] Pointer to the OdGsEntityNode
pMetafile	[in] Pointer to the metafile

addElement() [2/2]

virtual void OdGsUpdateManager::addElement ( OdUInt32  viewportId, OdGsEntityNode *  pNode, OdGsUpdateManagerElement *  pElement, OdUInt64  nLength, OdGsViewImpl *  pView, const OdGeExtents3d &  extents, bool  bSetZeroWeight = false  )

pure virtual

Adds element to the Update Manager in memory limit

Parameters

viewportId	[in] Viewport ID
pNode	[in] Pointer to the OdGsEntityNode
pElement	[in] Pointer to the OdGsUpdateManagerElement
nLength	[in] Length of the metafile
pView	[in] Pointer to the view
extents	[in] Extents of cache
bSetZeroWeight	[in] If true visual weight will be zero

addPriorityElement()

virtual void OdGsUpdateManager::addPriorityElement ( OdUInt32  viewportId, OdGsEntityNode *  pNode, OdGsUpdateManagerElement *  pElement, OdUInt64  nLength  )

pure virtual

Add priority element to the Update Manager in memory limit mode

ODRX_DECLARE_MEMBERS()

OdGsUpdateManager::ODRX_DECLARE_MEMBERS

(

OdGsUpdateManager

)

process()

virtual void OdGsUpdateManager::process ( )

pure virtual

Process added elements

removeElement()

virtual void OdGsUpdateManager::removeElement ( OdUInt32  viewportId, OdGsEntityNode *  pNode, OdGsUpdateManagerElement *  pElement  )

pure virtual

Removes element added by addElement

Remarks

Right now only pMetafile is used

reset()

virtual void OdGsUpdateManager::reset ( )

pure virtual

Resets saved data (map, lists) but do not reset settings

setProcessCallback()

virtual void OdGsUpdateManager::setProcessCallback ( UpdateManagerProcessCallback  )

pure virtual

Sets processing callback

setSettings()

virtual void OdGsUpdateManager::setSettings ( const UpdateManagerSettings &  )

pure virtual

Sets settings

settings()

virtual UpdateManagerSettings OdGsUpdateManager::settings ( ) const

pure virtual

Retrives current manager settings

---

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

• GsUpdateManager.h