OdGiTransientManager Class Reference

#include <GiTransientManager.h>

Inheritance diagram for OdGiTransientManager:

Public Types
enum	OdGiTransientDrawingMode {   kOdGiMain = 0 , kOdGiSprite , kOdGiDirectShortTerm , kOdGiHighlight ,   kOdGiDirectTopmost , kOdGiContrast , kOdGiDrawingModeCount }

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGiTransientManager)
virtual bool	addTransient (OdGiDrawable *pDrawable, OdGiTransientDrawingMode mode, OdInt32 subMode, const OdUInt32Array &viewportIds)=0
virtual bool	eraseTransient (OdGiDrawable *pDrawable, const OdUInt32Array &viewportIds)=0
virtual bool	eraseTransients (OdGiTransientDrawingMode mode, OdInt32 subMode, const OdUInt32Array &viewportIds)=0
virtual void	updateTransient (OdGiDrawable *pDrawable, const OdUInt32Array &viewportIds) const =0
virtual bool	addChildTransient (OdGiDrawable *pDrawable, OdGiDrawable *pParent)=0
virtual bool	eraseChildTransient (OdGiDrawable *pDrawable, OdGiDrawable *pParent)=0
virtual void	updateChildTransient (OdGiDrawable *pDrawable, OdGiDrawable *pParent) const =0
virtual OdInt32	getFreeSubDrawingMode (OdGiTransientDrawingMode mode, OdInt32 &subMode, const OdUInt32Array &viewportIds) const =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 provides transient drawables manager functionality.

<group OdGi_Classes>

Definition at line 40 of file GiTransientManager.h.

Member Enumeration Documentation

OdGiTransientDrawingMode

enum OdGiTransientManager::OdGiTransientDrawingMode

Enumerator
kOdGiMain
kOdGiSprite
kOdGiDirectShortTerm
kOdGiHighlight
kOdGiDirectTopmost
kOdGiContrast
kOdGiDrawingModeCount

Definition at line 45 of file GiTransientManager.h.

Member Function Documentation

addChildTransient()

virtual bool OdGiTransientManager::addChildTransient ( OdGiDrawable *  pDrawable, OdGiDrawable *  pParent  )

pure virtual

Appends child drawable to parent drawable in the transient drawables manager.

Parameters

pDrawable	[in] Drawable pointer.
pParent	[in] Parent drawable pointer.

addTransient()

virtual bool OdGiTransientManager::addTransient ( OdGiDrawable *  pDrawable, OdGiTransientDrawingMode  mode, OdInt32  subMode, const OdUInt32Array &  viewportIds  )

pure virtual

Adds new drawable into transient drawables manager.

Parameters

pDrawable	[in] Drawable pointer.
mode	[in] Transient drawable mode.
subMode	[in] Draw order index.
viewportIds	[in] List of viewport indices.

eraseChildTransient()

virtual bool OdGiTransientManager::eraseChildTransient ( OdGiDrawable *  pDrawable, OdGiDrawable *  pParent  )

pure virtual

Erases child drawable from parent drawable in the transient drawables manager.

Parameters

pDrawable	[in] Drawable pointer.
pParent	[in] Parent drawable pointer.

eraseTransient()

virtual bool OdGiTransientManager::eraseTransient ( OdGiDrawable *  pDrawable, const OdUInt32Array &  viewportIds  )

pure virtual

Erases drawable from transient drawables manager.

Parameters

pDrawable	[in] Drawable pointer.
viewportIds	[in] List of viewport indices.

eraseTransients()

virtual bool OdGiTransientManager::eraseTransients ( OdGiTransientDrawingMode  mode, OdInt32  subMode, const OdUInt32Array &  viewportIds  )

pure virtual

Erases all drawables from specified drawable mode and order.

Parameters

mode	[in] Transient drawable mode.
subMode	[in] Draw order index.
viewportIds	[in] List of viewport indices.

getFreeSubDrawingMode()

virtual OdInt32 OdGiTransientManager::getFreeSubDrawingMode ( OdGiTransientDrawingMode  mode, OdInt32 &  subMode, const OdUInt32Array &  viewportIds  ) const

pure virtual

Finds free order for specified drawable mode.

Parameters

mode	[in] Transient drawable mode.
subMode	[out] Draw order index.
viewportIds	[in] List of viewport indices.

Returns

Returns 0 if specified input draw order isn't free and transient manager couldn't find free draw order. Returns 1 if specified input draw order is free. Returns 2 if specified input draw order isn't free but transient manager found free draw order.

ODRX_DECLARE_MEMBERS()

OdGiTransientManager::ODRX_DECLARE_MEMBERS

(

OdGiTransientManager

)

updateChildTransient()

virtual void OdGiTransientManager::updateChildTransient ( OdGiDrawable *  pDrawable, OdGiDrawable *  pParent  ) const

pure virtual

Updates child drawable of parent drawable in the transient drawables manager.

Parameters

pDrawable	[in] Drawable pointer.
pParent	[in] Parent drawable pointer.

updateTransient()

virtual void OdGiTransientManager::updateTransient ( OdGiDrawable *  pDrawable, const OdUInt32Array &  viewportIds  ) const

pure virtual

Updates drawable in the transient drawables manager.

Parameters

pDrawable	[in] Drawable pointer.
viewportIds	[in] List of viewport indices.

---

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

• GiTransientManager.h