RVC::STYLEPATTERN_LINE Class Reference

Line pattern class. More...

#include <rvc/stylepatternline.h>

Inheritance diagram for RVC::STYLEPATTERN_LINE:

[legend]

List of all members.

Classes
class	ELEMENT
	Pattern element. More...
class	ELEMENT_SHARED
	Pattern element referencing shared memory buffer. More...
class	ITERATOR
	Iterator to process pattern elements. More...
Public Types
enum	ELEMENT_TYPE {   ELEMENT_TYPE_Line = 0, ELEMENT_TYPE_CrossLine = 1, ELEMENT_TYPE_Circle = 2, ELEMENT_TYPE_Polyline = 3,   ELEMENT_TYPE_Polygon = 4, ELEMENT_TYPE_Text = 5, ELEMENT_TYPE_Symbol = 6, ELEMENT_TYPE_COUNT }
Public Member Functions
	STYLEPATTERN_LINE (const STYLEPATTERN_LINE &rhs)
	STYLEPATTERN_LINE (const void *buf, INT32 NumBytes)
	STYLEPATTERN_LINE ()
virtual	~STYLEPATTERN_LINE ()
ITERATOR	Begin () const
ERRVALUE	DeleteElement (unsigned idx)
void	DeleteUnusedColors ()
ITERATOR	End () const
ELEMENT	GetElement (unsigned idx) const
INT16	GetExtentLeft () const
INT16	GetExtentRight () const
INT32	GetWidth () const
ERRVALUE	InsertElement (unsigned idx, const ELEMENT &element)
STYLEPATTERN_LINE &	operator= (const STYLEPATTERN_LINE &rhs)
ERRVALUE	SetElement (unsigned idx, const ELEMENT &element)

---

Detailed Description

Line pattern class.

---

Member Enumeration Documentation

enum RVC::STYLEPATTERN_LINE::ELEMENT_TYPE

Enumerator:

ELEMENT_TYPE_Line
ELEMENT_TYPE_CrossLine
ELEMENT_TYPE_Circle
ELEMENT_TYPE_Polyline
ELEMENT_TYPE_Polygon
ELEMENT_TYPE_Text
ELEMENT_TYPE_Symbol
ELEMENT_TYPE_COUNT

---

Constructor & Destructor Documentation

RVC::STYLEPATTERN_LINE::STYLEPATTERN_LINE

(

)

[inline]

Default constructor.

RVC::STYLEPATTERN_LINE::STYLEPATTERN_LINE	(	const void *	buf,
		INT32	NumBytes
	)			[inline]

Constructor from raw pattern data.

RVC::STYLEPATTERN_LINE::STYLEPATTERN_LINE

(

const STYLEPATTERN_LINE &

rhs

)

[inline]

Copy constructor.

virtual RVC::STYLEPATTERN_LINE::~STYLEPATTERN_LINE

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

ITERATOR RVC::STYLEPATTERN_LINE::Begin

(

)

const [inline]

Get iterator for beginning element.

ERRVALUE RVC::STYLEPATTERN_LINE::DeleteElement

(

unsigned

idx

)

Delete element at specified index.

This will invalidate all ITERATORs.

void RVC::STYLEPATTERN_LINE::DeleteUnusedColors

(

)

Delete unused colors from pattern palette.

This will invalidate all ITERATORs.

ITERATOR RVC::STYLEPATTERN_LINE::End

(

)

const [inline]

Get iterator for end comparison.

ELEMENT RVC::STYLEPATTERN_LINE::GetElement

(

unsigned

idx

)

const

Get element at specified index.

Note, this is less efficient than using iterator.

INT16 RVC::STYLEPATTERN_LINE::GetExtentLeft

(

)

const [inline]

Get extent of pattern to 'left' as drawn (not including 'crossing' elements).

INT16 RVC::STYLEPATTERN_LINE::GetExtentRight

(

)

const [inline]

Get extent of pattern to 'right' as drawn (not including 'crossing' elements).

INT32 RVC::STYLEPATTERN_LINE::GetWidth

(

)

const

GetWidth - Return width if line pattern in 1/100th of a mm.

ERRVALUE RVC::STYLEPATTERN_LINE::InsertElement	(	unsigned	idx,
		const ELEMENT &	element
	)

Insert element at specified index.

This will invalidate all ITERATORs.

STYLEPATTERN_LINE& RVC::STYLEPATTERN_LINE::operator=

(

const STYLEPATTERN_LINE &

rhs

)

[inline]

Assignment.

Reimplemented from RVC::STYLEPATTERN_BASE.

ERRVALUE RVC::STYLEPATTERN_LINE::SetElement	(	unsigned	idx,
		const ELEMENT &	element
	)

Set (replace) element at specified index.

If element size changes this will invalidate all ITERATORs.

---

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

• rvc/stylepatternline.h