OdGsEntityNode::MetafileHolder Class Reference

#include <GsEntityNode.h>

Public Types
enum	{   kArray = 1 , kVpDependent = 2 , kAwareFlagsRegenType = 4 , kRegenTypeStandard = 8 ,   kRegenTypeHideOrShade = 16 , kRegenTypeRenderCommand = 32 , kRegenTypeMask = kRegenTypeStandard | kRegenTypeHideOrShade | kRegenTypeRenderCommand , kDependentGeometry = 64 ,   kLayerDependent = 128 }

Public Member Functions
	MetafileHolder ()
	MetafileHolder (const MetafileHolder &c)
	~MetafileHolder ()
bool	isValid () const
bool	isArray () const
bool	isVpDependent () const
void	setVpDependent (bool bOn)
bool	isAwareFlagsRegenType () const
bool	isRegenTypeDependent () const
void	setDependentGeometry (bool bSet)
bool	isDependentGeometry () const
void	setLayerDependent (bool bSet)
bool	isLayerDependent () const
Metafile *	get ()
const Metafile *	get () const
MetafilePtrArray &	getArray ()
const MetafilePtrArray &	getArray () const
void	set (Metafile *pMf)
void	setAtRegenType (Metafile *pMf, OdGiRegenType eRegenType)
Metafile *	getAtRegenType (OdGiRegenType &eRegenType)
void	allocateArray ()
void	destroy ()
int	checkValid ()
void	moveTo (MetafileHolder &c, int &n)
OdUInt32	awareFlags (OdUInt32 nVpID) const
void	setAt (int n, Metafile *pMf)

Protected Member Functions
int	flags () const
void *	rawPtr ()
const void *	rawPtr () const
bool	isValidMf (const Metafile &mf) const
void	setAwareFlagsRegenType (bool bOn)

Protected Attributes
OdUInt8	m_flags
OdUInt8	m_data [odmax(sizeof(MetafilePtrArray), sizeof(OdRxObject *))]

Detailed Description

MetafileHolder helper class.

Corresponding C++ library: TD_Gs <group OdGs_Classes>

Definition at line 345 of file GsEntityNode.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
kArray
kVpDependent
kAwareFlagsRegenType
kRegenTypeStandard
kRegenTypeHideOrShade
kRegenTypeRenderCommand
kRegenTypeMask
kDependentGeometry
kLayerDependent

Definition at line 348 of file GsEntityNode.h.

Constructor & Destructor Documentation

MetafileHolder() [1/2]

OdGsEntityNode::MetafileHolder::MetafileHolder ( )

inline

Default constructor for the MetafileHolder class. Initializes flags to 0.

Definition at line 366 of file GsEntityNode.h.

MetafileHolder() [2/2]

OdGsEntityNode::MetafileHolder::MetafileHolder ( const MetafileHolder &  c )

inline

Copy constructor for the MetafileHolder class. Copies the passed metafile holder. If passed metafile holder is not copied if it is invalid.

Parameters

c	[in] Metafile holder to copy.

Definition at line 376 of file GsEntityNode.h.

~MetafileHolder()

OdGsEntityNode::MetafileHolder::~MetafileHolder ( )

inline

Destructor for the MetafileHolder class.

Definition at line 397 of file GsEntityNode.h.

Member Function Documentation

allocateArray()

void OdGsEntityNode::MetafileHolder::allocateArray

(

)

Allocates memory for an array to store metafiles.

awareFlags()

OdUInt32 OdGsEntityNode::MetafileHolder::awareFlags ( OdUInt32  nVpID ) const

inline

Definition at line 542 of file GsEntityNode.h.

checkValid()

int OdGsEntityNode::MetafileHolder::checkValid

(

)

Checks whether this metafile holder is valid.

Returns

a number of valid metafiles if this object stores an array of metafiles or 1 if it stores only one metafile which is valid. If this object contains an array with no valid metafiles or one metafile which is not valid, this method returns 0.

destroy()

void OdGsEntityNode::MetafileHolder::destroy

(

)

Removes metafile or an entire array of metafiles for this holder.

flags()

int OdGsEntityNode::MetafileHolder::flags ( ) const

inlineprotected

Definition at line 570 of file GsEntityNode.h.

get() [1/2]

Metafile * OdGsEntityNode::MetafileHolder::get ( )

inline

Retrieves a pointer to a metafile stored by this holder.

Definition at line 449 of file GsEntityNode.h.

get() [2/2]

const Metafile * OdGsEntityNode::MetafileHolder::get ( ) const

inline

Retrieves a pointer to a metafile stored by this holder.

Definition at line 458 of file GsEntityNode.h.

getArray() [1/2]

MetafilePtrArray & OdGsEntityNode::MetafileHolder::getArray ( )

inline

Retrieves a dynamic array of metafiles.

Definition at line 467 of file GsEntityNode.h.

getArray() [2/2]

const MetafilePtrArray & OdGsEntityNode::MetafileHolder::getArray ( ) const

inline

Retrieves a dynamic array of metafiles.

Definition at line 476 of file GsEntityNode.h.

getAtRegenType()

Metafile * OdGsEntityNode::MetafileHolder::getAtRegenType ( OdGiRegenType &  eRegenType )

inline

Retrieves a pointer to metafile for the specified regeneration type.

Parameters

eRegenType

[in] Regeneration type.

Definition at line 505 of file GsEntityNode.h.

isArray()

bool OdGsEntityNode::MetafileHolder::isArray ( ) const

inline

Checks whether this metafile holder has the kArray flag set to true.

Returns

true if kArray flag of this metafile holder is set to true, false otherwise.

Definition at line 414 of file GsEntityNode.h.

isAwareFlagsRegenType()

bool OdGsEntityNode::MetafileHolder::isAwareFlagsRegenType ( ) const

inline

Definition at line 437 of file GsEntityNode.h.

isDependentGeometry()

bool OdGsEntityNode::MetafileHolder::isDependentGeometry ( ) const

inline

Definition at line 441 of file GsEntityNode.h.

isLayerDependent()

bool OdGsEntityNode::MetafileHolder::isLayerDependent ( ) const

inline

Definition at line 444 of file GsEntityNode.h.

isRegenTypeDependent()

bool OdGsEntityNode::MetafileHolder::isRegenTypeDependent ( ) const

inline

Definition at line 438 of file GsEntityNode.h.

isValid()

bool OdGsEntityNode::MetafileHolder::isValid ( ) const

inline

Checks whether this metafile holder is valid.

Returns

true if this metafile holder is valid, false otherwise.

Definition at line 407 of file GsEntityNode.h.

isValidMf()

bool OdGsEntityNode::MetafileHolder::isValidMf ( const Metafile &  mf ) const

protected

isVpDependent()

bool OdGsEntityNode::MetafileHolder::isVpDependent ( ) const

inline

Checks whether this metafile holder is viewport-dependent.

Returns

true if this metafile holder is viewport-dependent, false otherwise.

Definition at line 421 of file GsEntityNode.h.

moveTo()

void OdGsEntityNode::MetafileHolder::moveTo	(	MetafileHolder &	c,
		int &	n
	)

Copies data of this object to the specified object.

Parameters

c	[in] Metafile holder where to copy data.
n	[out] Receives a number of valid metafiles of the copied metafile holder. See checkValid() method.

rawPtr() [1/2]

void * OdGsEntityNode::MetafileHolder::rawPtr ( )

inlineprotected

Definition at line 571 of file GsEntityNode.h.

rawPtr() [2/2]

const void * OdGsEntityNode::MetafileHolder::rawPtr ( ) const

inlineprotected

Definition at line 572 of file GsEntityNode.h.

set()

void OdGsEntityNode::MetafileHolder::set ( Metafile *  pMf )

inline

Sets a metafile for this metafile holder. Existing metafile or an array of metafiles are erased from this holder.

Parameters

pMf	[in] Pointer to a metafile to set.

Definition at line 486 of file GsEntityNode.h.

setAt()

void OdGsEntityNode::MetafileHolder::setAt ( int  n, Metafile *  pMf  )

inline

Sets a metafile at the specified index of array. Works only if the matafile holder stores an array of metafiles.

Parameters

n	[in] Insertion index.
pMf	[in] Pointer to a metafile to set.

Definition at line 561 of file GsEntityNode.h.

setAtRegenType()

void OdGsEntityNode::MetafileHolder::setAtRegenType	(	Metafile *	pMf,
		OdGiRegenType	eRegenType
	)

Sets a metafile and specifies a regeneration type if metafile holder depends on a regeneration type.

Parameters

pMf	[in] Pointer to a metafile to set.
eRegenType	[in] Regeneration type.

setAwareFlagsRegenType()

void OdGsEntityNode::MetafileHolder::setAwareFlagsRegenType ( bool  bOn )

inlineprotected

Definition at line 574 of file GsEntityNode.h.

setDependentGeometry()

void OdGsEntityNode::MetafileHolder::setDependentGeometry ( bool  bSet )

inline

Definition at line 440 of file GsEntityNode.h.

setLayerDependent()

void OdGsEntityNode::MetafileHolder::setLayerDependent ( bool  bSet )

inline

Definition at line 443 of file GsEntityNode.h.

setVpDependent()

void OdGsEntityNode::MetafileHolder::setVpDependent ( bool  bOn )

inline

Specifies whether this metafile holder is viewport-dependent.

Parameters

bOn	[in] Flag that specifies whether this metafile holder is viewport-dependent.

Definition at line 427 of file GsEntityNode.h.

Member Data Documentation

m_data

OdUInt8 OdGsEntityNode::MetafileHolder::m_data[odmax(sizeof(MetafilePtrArray), sizeof(OdRxObject *))]

protected

Definition at line 581 of file GsEntityNode.h.

m_flags

OdUInt8 OdGsEntityNode::MetafileHolder::m_flags

protected

Definition at line 577 of file GsEntityNode.h.

---

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

• GsEntityNode.h