CFx SDK Documentation  2022 SP0
Classes | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
OdGsOverlayDataContainer< OverlayDataType > Class Template Reference

#include <GsOverlayDefs.h>

Classes

struct  Allocator
 
struct  ForEach
 
class  Iterator
 
struct  OverlayData
 

Public Member Functions

 OdGsOverlayDataContainer ()
 
 ~OdGsOverlayDataContainer ()
 
void substituteAllocator (Allocator *pAllocator)
 
void resetAllocator ()
 
bool activateOverlay (OdGsOverlayId id)
 
bool deactivateOverlay (OdGsOverlayId id)
 
OdUInt32 activeOverlays () const
 
bool isOverlayActive (OdGsOverlayId id) const
 
bool isMultipleOverlays () const
 
OverlayDataType * getOverlayData (OdGsOverlayId id, bool bActivate=false)
 
const OverlayDataType * getOverlayData (OdGsOverlayId id, bool bActivate=false) const
 
bool execForEach (ForEach &impl, OdUInt32 nMask=kGsAllOverlays) const
 
Iterator newIterator (OdUInt32 nMask=kGsAllOverlays) const
 
OdUInt32 invalidOverlays () const
 
bool isOverlayInvalid (OdGsOverlayId id) const
 
void setOverlayInvalid (OdGsOverlayId id, bool bSet=true)
 
void setOverlaysInvalid (bool bSet=true)
 
void setOverlaysInvalid (OdUInt32 nOverlays, bool bSet=true)
 
bool isAnyOverlayInvalid () const
 
bool isAllOverlaysIvalid () const
 

Protected Types

typedef OdArray< OverlayDataOverlayDataArray
 

Protected Member Functions

void subAllocator (Allocator *pAllocator)
 
void activate (OdGsOverlayId id) const
 
void deactivate (OdGsOverlayId id)
 

Protected Attributes

OverlayDataArray m_overlaysData
 
Allocator m_defAllocator
 
Allocatorm_pAllocator
 
OdUInt32 m_uActiveOverlays
 
OdUInt32 m_uInvalidOverlays
 

Detailed Description

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
class OdGsOverlayDataContainer< OverlayDataType >

Definition at line 199 of file GsOverlayDefs.h.

Member Typedef Documentation

◆ OverlayDataArray

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
typedef OdArray<OverlayData> OdGsOverlayDataContainer< OverlayDataType >::OverlayDataArray
protected

Definition at line 214 of file GsOverlayDefs.h.

Constructor & Destructor Documentation

◆ OdGsOverlayDataContainer()

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
OdGsOverlayDataContainer< OverlayDataType >::OdGsOverlayDataContainer ( )
inline

Definition at line 269 of file GsOverlayDefs.h.

◆ ~OdGsOverlayDataContainer()

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
OdGsOverlayDataContainer< OverlayDataType >::~OdGsOverlayDataContainer ( )
inline

Definition at line 277 of file GsOverlayDefs.h.

Member Function Documentation

◆ activate()

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
void OdGsOverlayDataContainer< OverlayDataType >::activate ( OdGsOverlayId  id) const
inlineprotected

Definition at line 240 of file GsOverlayDefs.h.

◆ activateOverlay()

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
bool OdGsOverlayDataContainer< OverlayDataType >::activateOverlay ( OdGsOverlayId  id)
inline

Definition at line 297 of file GsOverlayDefs.h.

◆ activeOverlays()

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
OdUInt32 OdGsOverlayDataContainer< OverlayDataType >::activeOverlays ( ) const
inline

Definition at line 310 of file GsOverlayDefs.h.

◆ deactivate()

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
void OdGsOverlayDataContainer< OverlayDataType >::deactivate ( OdGsOverlayId  id)
inlineprotected

Definition at line 250 of file GsOverlayDefs.h.

◆ deactivateOverlay()

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
bool OdGsOverlayDataContainer< OverlayDataType >::deactivateOverlay ( OdGsOverlayId  id)
inline

Definition at line 303 of file GsOverlayDefs.h.

◆ execForEach()

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
bool OdGsOverlayDataContainer< OverlayDataType >::execForEach ( ForEach impl,
OdUInt32  nMask = kGsAllOverlays 
) const
inline

Definition at line 341 of file GsOverlayDefs.h.

◆ getOverlayData() [1/2]

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
OverlayDataType* OdGsOverlayDataContainer< OverlayDataType >::getOverlayData ( OdGsOverlayId  id,
bool  bActivate = false 
)
inline

Definition at line 314 of file GsOverlayDefs.h.

◆ getOverlayData() [2/2]

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
const OverlayDataType* OdGsOverlayDataContainer< OverlayDataType >::getOverlayData ( OdGsOverlayId  id,
bool  bActivate = false 
) const
inline

Definition at line 325 of file GsOverlayDefs.h.

◆ invalidOverlays()

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
OdUInt32 OdGsOverlayDataContainer< OverlayDataType >::invalidOverlays ( ) const
inline

Definition at line 395 of file GsOverlayDefs.h.

◆ isAllOverlaysIvalid()

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
bool OdGsOverlayDataContainer< OverlayDataType >::isAllOverlaysIvalid ( ) const
inline

Definition at line 401 of file GsOverlayDefs.h.

◆ isAnyOverlayInvalid()

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
bool OdGsOverlayDataContainer< OverlayDataType >::isAnyOverlayInvalid ( ) const
inline

Definition at line 400 of file GsOverlayDefs.h.

◆ isMultipleOverlays()

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
bool OdGsOverlayDataContainer< OverlayDataType >::isMultipleOverlays ( ) const
inline

Definition at line 312 of file GsOverlayDefs.h.

◆ isOverlayActive()

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
bool OdGsOverlayDataContainer< OverlayDataType >::isOverlayActive ( OdGsOverlayId  id) const
inline

Definition at line 311 of file GsOverlayDefs.h.

◆ isOverlayInvalid()

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
bool OdGsOverlayDataContainer< OverlayDataType >::isOverlayInvalid ( OdGsOverlayId  id) const
inline

Definition at line 396 of file GsOverlayDefs.h.

◆ newIterator()

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
Iterator OdGsOverlayDataContainer< OverlayDataType >::newIterator ( OdUInt32  nMask = kGsAllOverlays) const
inline

Definition at line 390 of file GsOverlayDefs.h.

◆ resetAllocator()

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
void OdGsOverlayDataContainer< OverlayDataType >::resetAllocator ( )
inline

Definition at line 292 of file GsOverlayDefs.h.

◆ setOverlayInvalid()

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
void OdGsOverlayDataContainer< OverlayDataType >::setOverlayInvalid ( OdGsOverlayId  id,
bool  bSet = true 
)
inline

Definition at line 397 of file GsOverlayDefs.h.

◆ setOverlaysInvalid() [1/2]

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
void OdGsOverlayDataContainer< OverlayDataType >::setOverlaysInvalid ( bool  bSet = true)
inline

Definition at line 398 of file GsOverlayDefs.h.

◆ setOverlaysInvalid() [2/2]

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
void OdGsOverlayDataContainer< OverlayDataType >::setOverlaysInvalid ( OdUInt32  nOverlays,
bool  bSet = true 
)
inline

Definition at line 399 of file GsOverlayDefs.h.

◆ subAllocator()

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
void OdGsOverlayDataContainer< OverlayDataType >::subAllocator ( Allocator pAllocator)
inlineprotected

Definition at line 221 of file GsOverlayDefs.h.

◆ substituteAllocator()

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
void OdGsOverlayDataContainer< OverlayDataType >::substituteAllocator ( Allocator pAllocator)
inline

Definition at line 288 of file GsOverlayDefs.h.

Member Data Documentation

◆ m_defAllocator

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
Allocator OdGsOverlayDataContainer< OverlayDataType >::m_defAllocator
protected

Definition at line 216 of file GsOverlayDefs.h.

◆ m_overlaysData

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
OverlayDataArray OdGsOverlayDataContainer< OverlayDataType >::m_overlaysData
mutableprotected

Definition at line 215 of file GsOverlayDefs.h.

◆ m_pAllocator

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
Allocator* OdGsOverlayDataContainer< OverlayDataType >::m_pAllocator
protected

Definition at line 217 of file GsOverlayDefs.h.

◆ m_uActiveOverlays

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
OdUInt32 OdGsOverlayDataContainer< OverlayDataType >::m_uActiveOverlays
mutableprotected

Definition at line 218 of file GsOverlayDefs.h.

◆ m_uInvalidOverlays

template<typename OverlayDataType = OdGsOverlayDataPlaceholder>
OdUInt32 OdGsOverlayDataContainer< OverlayDataType >::m_uInvalidOverlays
protected

Definition at line 219 of file GsOverlayDefs.h.


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