RVC::STYLEPATTERN_BASE Class Reference

Base pattern class. More...

#include <rvc/stylepatternbase.h>

Inheritance diagram for RVC::STYLEPATTERN_BASE:

[legend]

List of all members.

Classes
struct	PATTERNHEADER
	Information common to all patterns / symbols. More...
Public Types
enum	SPECIALCOLOR { SPECIALCOLOR_Transparent = 255, SPECIALCOLOR_Variable = 254 }
Public Member Functions
	STYLEPATTERN_BASE ()
virtual	~STYLEPATTERN_BASE ()
ERRVALUE	AppendColor (const COLOR &color)
void	Clear ()
const COLOR &	GetColor (UINT8 idx) const
const COLOR *	GetColors () const
const RVC::OBJECTNAME &	GetName () const
INT32	GetNumColors () const
INT32	GetNumElements () const
PATTERNTYPE	GetPatternType () const
INT32	GetSize () const
bool	IsEmpty () const
bool	IsEqualDef (const STYLEPATTERN_BASE &rhs) const
	operator const void * () const
void	SetColor (UINT8 idx, const COLOR &color)
void	SetName (const OBJECTNAME &name)
ERRVALUE	SetPattern (const void *SrcPattBuff, INT32 PattBuffSize, INT32 PattHdrSize)
Protected Member Functions
	STYLEPATTERN_BASE (const STYLEPATTERN_BASE &rhs)
	STYLEPATTERN_BASE (PATTERNTYPE PattType, int PattHdrSize)
void	DeleteColorSet (const UINT8 *set)
void	DeleteFromBuffer (INT32 offset, INT32 numbytes)
UINT8 *	GetFirstElemPtr ()
const UINT8 *	GetFirstElemPtr () const
UINT8 *	GetPattBuffer ()
const UINT8 *	GetPattBuffer () const
ERRVALUE	InsertIntoBuffer (INT32 offset, INT32 numbytes, const void *data=0)
STYLEPATTERN_BASE &	operator= (const STYLEPATTERN_BASE &rhs)

---

Detailed Description

Base pattern class.

---

Member Enumeration Documentation

enum RVC::STYLEPATTERN_BASE::SPECIALCOLOR

Enumerator:

SPECIALCOLOR_Transparent
SPECIALCOLOR_Variable

---

Constructor & Destructor Documentation

RVC::STYLEPATTERN_BASE::STYLEPATTERN_BASE

(

)

[inline]

Default constructor used by style object.

virtual RVC::STYLEPATTERN_BASE::~STYLEPATTERN_BASE

(

)

[inline, virtual]

Destructor.

RVC::STYLEPATTERN_BASE::STYLEPATTERN_BASE	(	PATTERNTYPE	PattType,
		int	PattHdrSize
	)			[inline, protected]

Constructor used by derived classes.

RVC::STYLEPATTERN_BASE::STYLEPATTERN_BASE

(

const STYLEPATTERN_BASE &

rhs

)

[protected]

Copy constructor.

---

Member Function Documentation

ERRVALUE RVC::STYLEPATTERN_BASE::AppendColor

(

const COLOR &

color

)

Append color to end of palette.

Note, this will invalidate all derived class ITERATORs.

void RVC::STYLEPATTERN_BASE::Clear

(

)

[inline]

Clear pattern contents.

void RVC::STYLEPATTERN_BASE::DeleteColorSet

(

const UINT8 *

set

)

[protected]

Delete colors in specified set.

Parameters:

set

Byte array with entries set to non-zero to delete, zero to retain

void RVC::STYLEPATTERN_BASE::DeleteFromBuffer	(	INT32	offset,
		INT32	numbytes
	)			[protected]

Delete from pattern buffer at specified location.

const COLOR& RVC::STYLEPATTERN_BASE::GetColor

(

UINT8

idx

)

const [inline]

Get color at specified palette index.

const COLOR* RVC::STYLEPATTERN_BASE::GetColors

(

)

const [inline]

Get color palette.

UINT8* RVC::STYLEPATTERN_BASE::GetFirstElemPtr

(

)

[inline, protected]

Get non-const pointer to first pattern 'element'.

const UINT8* RVC::STYLEPATTERN_BASE::GetFirstElemPtr

(

)

const [inline, protected]

Get const pointer to first pattern 'element'.

const RVC::OBJECTNAME& RVC::STYLEPATTERN_BASE::GetName

(

)

const [inline]

Get pattern name.

INT32 RVC::STYLEPATTERN_BASE::GetNumColors

(

)

const [inline]

Get number of user-defined colors in pattern palette.

Note: for RGBA bitmap pattern, GetNumColors() will return -1

INT32 RVC::STYLEPATTERN_BASE::GetNumElements

(

)

const [inline]

Get number of pattern elements.

UINT8* RVC::STYLEPATTERN_BASE::GetPattBuffer

(

)

[inline, protected]

Get non-const pointer to pattern buffer.

const UINT8* RVC::STYLEPATTERN_BASE::GetPattBuffer

(

)

const [inline, protected]

Get const pointer to pattern buffer.

PATTERNTYPE RVC::STYLEPATTERN_BASE::GetPatternType

(

)

const [inline]

Get the pattern type of this pattern.

INT32 RVC::STYLEPATTERN_BASE::GetSize

(

)

const [inline]

Get pattern buffer size.

ERRVALUE RVC::STYLEPATTERN_BASE::InsertIntoBuffer	(	INT32	offset,
		INT32	numbytes,
		const void *	data = 0
	)			[protected]

Insert space into pattern buffer at specified location.

bool RVC::STYLEPATTERN_BASE::IsEmpty

(

)

const [inline]

Determine if the pattern is empty.

Returns:

'True' if the pattern is empty, 'false' if not

bool RVC::STYLEPATTERN_BASE::IsEqualDef

(

const STYLEPATTERN_BASE &

rhs

)

const [inline]

Determine if pattern definitions equal, excluding name.

RVC::STYLEPATTERN_BASE::operator const void *

(

)

const [inline]

To support legacy code, for now.

STYLEPATTERN_BASE& RVC::STYLEPATTERN_BASE::operator=

(

const STYLEPATTERN_BASE &

rhs

)

[protected]

Assignment.

Reimplemented in RVC::STYLEPATTERN_BITMAP, RVC::STYLEPATTERN_HATCH, RVC::STYLEPATTERN_LINE, and RVC::STYLEPATTERN_SYMBOL.

void RVC::STYLEPATTERN_BASE::SetColor	(	UINT8	idx,
		const COLOR &	color
	)			[inline]

Set color at specified palette index.

void RVC::STYLEPATTERN_BASE::SetName

(

const OBJECTNAME &

name

)

[inline]

Set pattern name.

ERRVALUE RVC::STYLEPATTERN_BASE::SetPattern	(	const void *	SrcPattBuff,
		INT32	PattBuffSize,
		INT32	PattHdrSize
	)

This method was added for use only in HATCHPATTERN because it has embedded LINEPATTERN.

---

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

• rvc/stylepatternbase.h