BBlockDef Class Reference

#include <BBlockDef.h>

List of all members.

---

Detailed Description

Encapsulates a collection of BFeature objects referenced by a BBlockRefFeature.

The collection of BFeature objects is treated as a single BFeature by way of the BBlockRefFeature object. The coordinates of the geometry contained in these BFeature objects are offsets from an insertion point rather than absolute coordinate values.

Public Member Functions
	BBlockDef (const BBlockDef &def)
	Copy constructor.
	BBlockDef (const BString &name)
	Constructor.
	BBlockDef ()
	Default constructor.
BFeatures	Explode (const BPoint &refPoint) const
	Resolves the features based on an insertion point.
const BFeatures &	GetFeatures (void) const
	Gets the BFeatures that are contained in this BBlockDef.
BFeatures &	GetFeatures (void)
	Gets the BFeatures that are contained in this BBlockDef.
BString	GetName (void) const
	Gets the name of this BBlockRef.
bool	operator== (const BBlockDef rhs)
	Equality operator.
void	SetFeatures (const BFeatures &feats)
	Sets the BFeatures that define this BBlockDef.
void	SetName (const BString &name)
	Sets the name of this BBlockRef.
virtual	~BBlockDef ()
	Destructor.

---

Constructor & Destructor Documentation

BBlockDef

(

)

[inline]

Default constructor.

This constructor will create a BBlockDef that does not contain any BFeature objects.

BBlockDef

(

const BString &

name

)

[inline]

Constructor.

This constructor will create a BBlockDef with the specified name, which will not contain any BFeature objects.

Parameters:

name

The name for this BBlockRef.

BBlockDef

(

const BBlockDef &

def

)

[inline]

Copy constructor.

Parameters:

def

The BBlockDef to copy.

virtual ~BBlockDef

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

BFeatures Explode

(

const BPoint &

refPoint

)

const

Resolves the features based on an insertion point.

Parameters:

refPoint

The insertion point for the BFeature objects in this BBlockDef.

Returns:

A BFeatures collection containing BFeature objects that have absolue coordinates.

const BFeatures& GetFeatures

(

void

)

const [inline]

Gets the BFeatures that are contained in this BBlockDef.

Returns:

The BFeatures that define this BBlockDef. Coordinates in these features are given as offsets from an insertion point rather then absolute coordinate values.

BFeatures& GetFeatures

(

void

)

[inline]

Gets the BFeatures that are contained in this BBlockDef.

Returns:

The BFeatures that define this BBlockDef. Coordinates in these features are given as offsets from an insertion point rather then absolute coordinate values.

BString GetName

(

void

)

const [inline]

Gets the name of this BBlockRef.

Returns:

The name of this BBlockRef.

bool operator==

(

const BBlockDef

rhs

)

[inline]

Equality operator.

Parameters:

rhs

The BBlockDef to be compared to this one.

Returns:

True if the specified BBlockDef have the same name and false otherwise.

void SetFeatures

(

const BFeatures &

feats

)

[inline]

Sets the BFeatures that define this BBlockDef.

Parameters:

feats

The BFeatures that define the block. Coordinates in these BFeature objects are assumed to be offsets from an insertion point rather than absolute coordinate values.

void SetName

(

const BString &

name

)

[inline]

Sets the name of this BBlockRef.

Parameters:

name

The new name.

---

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

• BBlockDef.h

---

GeoTranslate 5.0 From Blue Marble Geographics