BRendition Class Reference

#include <BRendition.h>

Inheritance diagram for BRendition:

[legend]

List of all members.

---

Detailed Description

Encapsulates the display properties for a feature.

Public Member Functions
	BRendition (const BRendition &rend)
	Copy constructor.
	BRendition (const BLineStyle &ls, const BFillStyle &fs)
	Constructor.
	BRendition ()
	Default constructor.
virtual size_t	ComputeSize (void) const
	Computes the size of the BByteArray required to store this object.
virtual void	FromByteArray (const BByteArray &bytes, size_t &startPos)
	Initializes an instance of this object from a BByteArray.
BFillStyle	GetFillStyle (void) const
	Gets the BFillStyle that describes how closed areas should be filled.
BLineStyle	GetLineStyle (void) const
	Gets the BLineStyle that describes how lines should be drawn.
BRendition &	operator= (const BRendition &rend)
	Assignment operator.
void	SetFillStyle (const BFillStyle &fs)
	Set the BFillStyle that describes how closed areas should be filled.
void	SetLineStyle (const BLineStyle &ls)
	Set the BLineStyle that describes how lines should be drawn.
void	SetUsingFillStyle (bool val)
	Sets the indicator of whether or not the fill style is being used.
void	SetUsingLineStyle (bool val)
	Sets the indicator of whether or not the line style is being used.
virtual BByteArray	ToByteArray (void) const
	Stores this object in a BByteArray.
bool	UsingFillStyle (void) const
	Indicates if the fill style is being used.
bool	UsingLineStyle (void) const
	Indicates if the line style is being used.
virtual	~BRendition ()
	Destructor.

---

Constructor & Destructor Documentation

BRendition

(

)

[inline]

Default constructor.

BRendition	(	const BLineStyle &	ls,
		const BFillStyle &	fs
	)			[inline]

Constructor.

Parameters:

	ls	The BLineStyle that describes how lines should be displayed.
	fs	The BFillStyle that describes how closed areas should be filled.

BRendition

(

const BRendition &

rend

)

[inline]

Copy constructor.

Parameters:

rend

The Rendition object to copy.

virtual ~BRendition

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

virtual size_t ComputeSize

(

void

)

const [inline, virtual]

Computes the size of the BByteArray required to store this object.

Returns:

The size of the BByteArray.

Implements BByteStreamable.

virtual void FromByteArray	(	const BByteArray &	bytes,
		size_t &	startPos
	)			[inline, virtual]

Initializes an instance of this object from a BByteArray.

Parameters:

	bytes	The BByteArray containing the byte representation of the object.
	startPos	The position in the BByteArray where the byte representation begins. This value will be updated to point to the byte past the end of this object in the byte array.

Implements BByteStreamable.

BFillStyle GetFillStyle

(

void

)

const [inline]

Gets the BFillStyle that describes how closed areas should be filled.

Returns:

The BFillStyle that describes how closed areas should be filled.

BLineStyle GetLineStyle

(

void

)

const [inline]

Gets the BLineStyle that describes how lines should be drawn.

Returns:

The BLineStyle that describes how lines should be drawn.

BRendition& operator=

(

const BRendition &

rend

)

[inline]

Assignment operator.

Parameters:

rend

The BRendition whose value will be copied into this one.

Returns:

A reference to this BRendition.

void SetFillStyle

(

const BFillStyle &

fs

)

[inline]

Set the BFillStyle that describes how closed areas should be filled.

Parameters:

fs

The new BFillStyle.

void SetLineStyle

(

const BLineStyle &

ls

)

[inline]

Set the BLineStyle that describes how lines should be drawn.

Parameters:

ls

The new BLineStyle.

void SetUsingFillStyle

(

bool

val

)

[inline]

Sets the indicator of whether or not the fill style is being used.

Parameters:

val

True if the fill style is being used and false otherwise.

void SetUsingLineStyle

(

bool

val

)

[inline]

Sets the indicator of whether or not the line style is being used.

Parameters:

val

True if the line style is being used and false otherwise.

virtual BByteArray ToByteArray

(

void

)

const [inline, virtual]

Stores this object in a BByteArray.

Returns:

A BByteArray that stores the contents of this object.

Implements BByteStreamable.

bool UsingFillStyle

(

void

)

const [inline]

Indicates if the fill style is being used.

Returns:

True if the fill style is being used and false otherwise.

bool UsingLineStyle

(

void

)

const [inline]

Indicates if the line style is being used.

Returns:

True if the line style is being used and false otherwise.

---

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

• BRendition.h

---

GeoTranslate 5.0 From Blue Marble Geographics