OdGiHatchPattern Class Reference

#include <GiFill.h>

Inheritance diagram for OdGiHatchPattern:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGiHatchPattern)
	OdGiHatchPattern ()
const OdHatchPattern &	patternLines () const
OdHatchPattern &	patternLines ()
void	setPatternLines (const OdHatchPattern &aHatchPattern)
virtual void	copyFrom (const OdRxObject *pSource)
virtual bool	operator== (const OdGiFill &fill) const
virtual bool	operator!= (const OdGiFill &fill) const
virtual void	saveBytes (OdUInt8Array &bytes) const
virtual void	loadBytes (const OdUInt8 *&pBytes)
bool	isDraft () const
void	setDraft (bool draft)
double	patternScale () const
void	setPatternScale (double scale)
bool	isExternal () const
void	setExternal (bool isExt)
OdCmEntityColor	getPatternColor () const
void	setPatternColor (const OdCmEntityColor &color)
OdDb::LineWeight	getPatternLineWeight () const
void	setPatternLineWeight (OdDb::LineWeight lineweight)
OdCmTransparency	getPatternTransparency () const
void	setPatternTransparency (const OdCmTransparency &transparency)
OdSmartPtr< OdGiHatchPattern >	getNext () const
void	setNext (const OdSmartPtr< OdGiHatchPattern > &pNext)
bool	isAlignedToCenter () const
void	setAlignedToCenter (bool aligned)
bool	isEmpty () const
void	setEmpty (bool empty)
bool	isSolid () const
void	setSolid (bool solid)
bool	isDisabledBackgroundFill () const
void	setDisabledBackgroundFill (bool disabled)
bool	isDisabledTransparency () const
void	setDisabledTransparency (bool disabled)
Public Member Functions inherited from OdGiFill
	ODRX_DECLARE_MEMBERS (OdGiFill)
	OdGiFill ()
double	deviation () const
void	setDeviation (double dDeviation)
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 OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Protected Types
enum	Flags {   kDraft = (1 << 0) , kExternal = (1 << 1) , kAlignedToCenter = (1 << 2) , kEmpty = (1 << 3) ,   kSolid = (1 << 4) , kDisabledBackgroundFill = (1 << 5) , kDisabledTransparency = (1 << 6) }

Protected Attributes
OdHatchPattern	m_aHatchPattern
double	m_dPatternScale
OdDb::LineWeight	m_patternLineWeight
OdCmEntityColor	m_patternColor
OdCmTransparency	m_patternTransparency
OdSmartPtr< OdGiHatchPattern >	m_pNext
OdUInt32	m_nFlags
Protected Attributes inherited from OdGiFill
double	m_dDeviation

Additional Inherited Members
Static Public Member Functions inherited from OdGiFill
static OdSmartPtr< OdGiFill >	loadFill (const OdUInt8 *pBytes)
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()
static void	rxInit ()
static void	rxUninit ()
Protected Member Functions inherited from OdGiFill
void	pushDbl (OdUInt8Array &bytes, double dDbl) const
void	pushInt (OdUInt8Array &bytes, OdUInt32 nInt) const
void	popDbl (const OdUInt8 *&pBytes, double &dDbl) const
void	popInt (const OdUInt8 *&pBytes, OdUInt32 &nInt) const

Detailed Description

This class is a specialization of OdGiFill for hatch pattern type of filling.

<group OdGi_Classes>

Definition at line 109 of file GiFill.h.

Member Enumeration Documentation

Flags

enum OdGiHatchPattern::Flags

protected

Enumerator
kDraft
kExternal
kAlignedToCenter
kEmpty
kSolid
kDisabledBackgroundFill
kDisabledTransparency

Definition at line 120 of file GiFill.h.

Constructor & Destructor Documentation

OdGiHatchPattern()

OdGiHatchPattern::OdGiHatchPattern ( )

inline

Default constructor for the OdGiHatchPattern class. Sets the pattern scale to 1.0, pattern flags to 0 and initializes the underlaying fill object.

Definition at line 285 of file GiFill.h.

Member Function Documentation

copyFrom()

virtual void OdGiHatchPattern::copyFrom ( const OdRxObject * pSource )

virtual

details Copies the contents of the specified object into this object.

Parameters

pSource

[in] Pointer to the source object.

Remarks

The default implementation of this function does nothing but throw an eNotApplicable exception.

Throws: eNotApplicable Exception

Reimplemented from OdGiFill.

Reimplemented in OdGiFillHatch.

getNext()

OdGiHatchPatternPtr OdGiHatchPattern::getNext ( ) const

inline

Is used to obtain next pattern in the pattern chain

Returns

Pointer to the next OdGiHatchPattern

Definition at line 385 of file GiFill.h.

getPatternColor()

OdCmEntityColor OdGiHatchPattern::getPatternColor ( ) const

inline

Definition at line 349 of file GiFill.h.

getPatternLineWeight()

OdDb::LineWeight OdGiHatchPattern::getPatternLineWeight ( ) const

inline

Definition at line 361 of file GiFill.h.

getPatternTransparency()

OdCmTransparency OdGiHatchPattern::getPatternTransparency ( ) const

inline

Is used to obtain custom pattern transparency value (Default is 255)

Returns

Pattern transparency value

Definition at line 373 of file GiFill.h.

isAlignedToCenter()

bool OdGiHatchPattern::isAlignedToCenter ( ) const

inline

Is used to obtain 'kAlignedToCenter' flag value (Default is false)

Returns

'kAlignedToCenter' flag value

Definition at line 397 of file GiFill.h.

isDisabledBackgroundFill()

bool OdGiHatchPattern::isDisabledBackgroundFill ( ) const

inline

Is used to obtain 'kDisabledBackgroundFill' flag value (Default is false)

Returns

'kDisabledBackgroundFill' flag value

Definition at line 433 of file GiFill.h.

isDisabledTransparency()

bool OdGiHatchPattern::isDisabledTransparency ( ) const

inline

Is used to obtain 'kDisabledTransparency' flag value (Default is false)

Returns

'kDisabledTransparency' flag value

Definition at line 445 of file GiFill.h.

isDraft()

bool OdGiHatchPattern::isDraft ( ) const

inline

Definition at line 313 of file GiFill.h.

isEmpty()

bool OdGiHatchPattern::isEmpty ( ) const

inline

Is used to obtain 'kEmpty' flag value (Default is false)

Returns

'kEmpty' flag value

Definition at line 409 of file GiFill.h.

isExternal()

bool OdGiHatchPattern::isExternal ( ) const

inline

Definition at line 337 of file GiFill.h.

isSolid()

bool OdGiHatchPattern::isSolid ( ) const

inline

Is used to obtain 'kSolid' flag value (Default is false)

Returns

'kSolid' flag value

Definition at line 421 of file GiFill.h.

loadBytes()

virtual void OdGiHatchPattern::loadBytes ( const OdUInt8 *& pBytes )

virtual

Reimplemented from OdGiFill.

ODRX_DECLARE_MEMBERS()

OdGiHatchPattern::ODRX_DECLARE_MEMBERS

(

OdGiHatchPattern

)

operator!=()

virtual bool OdGiHatchPattern::operator!= ( const OdGiFill & fill ) const

virtual

Reimplemented from OdGiFill.

Reimplemented in OdGiFillHatch.

operator==()

virtual bool OdGiHatchPattern::operator== ( const OdGiFill & fill ) const

virtual

Reimplemented from OdGiFill.

Reimplemented in OdGiFillHatch.

patternLines() [1/2]

OdHatchPattern & OdGiHatchPattern::patternLines ( )

inline

Retrieves lines that compose this pattern.

Returns

a reference to the OdHatchPattern that represents an array of pattern lines.

Definition at line 301 of file GiFill.h.

patternLines() [2/2]

const OdHatchPattern & OdGiHatchPattern::patternLines ( ) const

inline

Retrieves lines that compose this pattern.

Returns

a reference to the OdHatchPattern that represents an array of pattern lines.

Definition at line 295 of file GiFill.h.

patternScale()

double OdGiHatchPattern::patternScale ( ) const

inline

Retrieves scale of this pattern.

Returns

scale of the hatch pattern as a value of double type.

Definition at line 325 of file GiFill.h.

saveBytes()

virtual void OdGiHatchPattern::saveBytes ( OdUInt8Array & bytes ) const

virtual

Reimplemented from OdGiFill.

setAlignedToCenter()

void OdGiHatchPattern::setAlignedToCenter ( bool aligned )

inline

Is used to set 'kAlignedToCenter' flag that forces pattern initial position to the center of the shell

Parameters

aligned

[in] Value to be set

Definition at line 403 of file GiFill.h.

setDisabledBackgroundFill()

void OdGiHatchPattern::setDisabledBackgroundFill ( bool disabled )

inline

Is used to set 'kDisabledBackgroundFill' flag that disables solid bg fill on the same face rendering, so only pattern and edges are drawn

Parameters

disabled

[in] Value to be set

Definition at line 439 of file GiFill.h.

setDisabledTransparency()

void OdGiHatchPattern::setDisabledTransparency ( bool disabled )

inline

Is used to set 'kDisabledTransparency' flag which affects pattern transparency

Parameters

disabled

[in] Value to be set

Definition at line 451 of file GiFill.h.

setDraft()

void OdGiHatchPattern::setDraft ( bool draft )

inline

Definition at line 319 of file GiFill.h.

setEmpty()

void OdGiHatchPattern::setEmpty ( bool empty )

inline

Is used to set 'kEmpty' flag that forces pattern to be skipped on rendering regardless of it content

Parameters

empty

[in] Value to be set

Definition at line 415 of file GiFill.h.

setExternal()

void OdGiHatchPattern::setExternal ( bool isExt )

inline

Definition at line 343 of file GiFill.h.

setNext()

void OdGiHatchPattern::setNext ( const OdSmartPtr< OdGiHatchPattern > & pNext )

inline

Is used to set next pattern in the pattern chain

Parameters

pNext

[in] Pointer to OdGiHatchPattern

Definition at line 391 of file GiFill.h.

setPatternColor()

void OdGiHatchPattern::setPatternColor ( const OdCmEntityColor & color )

inline

Definition at line 355 of file GiFill.h.

setPatternLines()

void OdGiHatchPattern::setPatternLines ( const OdHatchPattern & aHatchPattern )

inline

Specifies pattern lines for this hatch pattern.

Parameters

aHatchPattern

[in] An array of hatch pattern lines.

Definition at line 307 of file GiFill.h.

setPatternLineWeight()

void OdGiHatchPattern::setPatternLineWeight ( OdDb::LineWeight lineweight )

inline

Definition at line 367 of file GiFill.h.

setPatternScale()

void OdGiHatchPattern::setPatternScale ( double scale )

inline

Specifies pattern scale for this hatch pattern.

Parameters

scale

[in] Scale of the pattern.

Definition at line 331 of file GiFill.h.

setPatternTransparency()

void OdGiHatchPattern::setPatternTransparency ( const OdCmTransparency & transparency )

inline

Sets custom pattern transparency value.

Parameters

transparency

[in] Pattern transparency value.

Definition at line 379 of file GiFill.h.

setSolid()

void OdGiHatchPattern::setSolid ( bool solid )

inline

Is used to set 'kSolid' flag that forces using a solid fill instead of pattern while rendering

Parameters

solid

[in] Value to be set

Definition at line 427 of file GiFill.h.

Member Data Documentation

m_aHatchPattern

OdHatchPattern OdGiHatchPattern::m_aHatchPattern

protected

Definition at line 113 of file GiFill.h.

m_dPatternScale

double OdGiHatchPattern::m_dPatternScale

protected

Definition at line 114 of file GiFill.h.

m_nFlags

OdUInt32 OdGiHatchPattern::m_nFlags

protected

Definition at line 122 of file GiFill.h.

m_patternColor

OdCmEntityColor OdGiHatchPattern::m_patternColor

protected

Definition at line 116 of file GiFill.h.

m_patternLineWeight

OdDb::LineWeight OdGiHatchPattern::m_patternLineWeight

protected

Definition at line 115 of file GiFill.h.

m_patternTransparency

OdCmTransparency OdGiHatchPattern::m_patternTransparency

protected

Definition at line 117 of file GiFill.h.

m_pNext

OdSmartPtr< OdGiHatchPattern > OdGiHatchPattern::m_pNext

protected

Definition at line 118 of file GiFill.h.

---

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

• GiFill.h