BFeatures Class Reference

#include <BFeatures.h>

Inheritance diagram for BFeatures:

Detailed Description

A BFeatureCollection that exists in memory.


Public Member Functions
virtual void	Add (const BFeatureCollection &features)
	Appends the BFeature objects in the specified collection to this collection.
virtual void	Add (const BFeaturePtr &feature)
	Adds a BFeature to this collection.
virtual void	Add (const BFeature &feature)
	Copies the specified BFeature and adds it to this collection.
	BFeatures (const BFeatures &feats)
	Copy constructor.
	BFeatures ()
	Default constructor.
virtual void	Clear (void)
	Removes all BFeature objects from this collection.
virtual const BFeaturePtr	GetAt (size_t index, bool inclCachedAttrs=true) const
	Gets the BFeature at the specified index in this collection.
virtual BFeaturePtr	GetAt (size_t index, bool inclCachedAttrs=true)
	Gets the BFeature at the specified index in this collection.
virtual size_t	GetCount (void) const
	Gets the number of BFeature objects in this collection.
virtual void	Release (size_t index)
	Releases the memory associated with a BFeature.
virtual void	Remove (size_t index)
	Removes a BFeature from this collection.
virtual void	Reserve (size_t size)
	Reserves space for the requested number of elements in this collection.
virtual void	Transform (const BTransform &cst)
	Transforms the geometry of each BFeature in this collection to a different coordinate system.
virtual void	TransformReverse (const BTransform &cst)
	Transforms the geometry of each BFeature in this collection to a different coordinate system using the "reverse" of the BTransform.
virtual	~BFeatures ()
	Destructor.
Protected Member Functions
BRect	ComputeMBR (void) const
	Computes the current minimum bounding rectangle for all BFeature objects in this collection.
Protected Attributes
BFeaturePtrVector	m_features
	The feature collection.

Constructor & Destructor Documentation

BFeatures ( ) [inline]

Default constructor.

This constructor will create an empty collection.

BFeatures ( const BFeatures & feats )

Copy constructor.

Parameters:

feats

The BFeatures object to copy

virtual ~BFeatures ( ) [inline, virtual]

Destructor.

Member Function Documentation

virtual void Add ( const BFeatureCollection & features ) [virtual]

Appends the BFeature objects in the specified collection to this collection.

Parameters:

features

The collection of BFeature objects to be added.

Exceptions:

BUnknownGeometryException

This exception will be thrown if the geometry associated with the specified feature is not of the correct class.

Implements BFeatureCollection.

virtual void Add ( const BFeaturePtr & feature ) [virtual]

Adds a BFeature to this collection.

Parameters:

feature

Pointer to the feature to be added.

Exceptions:

BUnknownGeometryException

This exception will be thrown if the geometry associated with the specified feature is not of the correct class.

Implements BFeatureCollection.

virtual void Add ( const BFeature & feature ) [virtual]

Copies the specified BFeature and adds it to this collection.

Parameters:

feature

The BFeature to be copied and added to this collection.

Exceptions:

BUnknownGeometryException

This exception will be thrown if the geometry associated with the specified feature is not of the correct class.

Implements BFeatureCollection.

virtual void Clear ( void ) [inline, virtual]

Removes all BFeature objects from this collection.

Derived classes should call Clear method in the base class implementation.

Reimplemented from BFeatureCollection.

BRect ComputeMBR ( void ) const [protected, virtual]

Computes the current minimum bounding rectangle for all BFeature objects in this collection.

Returns:: The minimum bounding rectangle.

Implements BFeatureCollection.

virtual const BFeaturePtr GetAt	(	size_t	index,
		bool	inclCachedAttrs = `true`
	)			const `[inline, virtual]`

Gets the BFeature at the specified index in this collection.

Parameters:

	index	The zero-based index of the desired BFeature.
	inclCachedAttrs	Indicates whether the returned feature will contain attributes. This applies only when the features are stored in a disk cache, and can be used to improve performance in applications where attributes are not needed. If the features are stored in memory, this has no effect.

Returns:: The BFeature at the specified index.

Exceptions:

BIndexOutOfBoundsException

This exception will be thrown if the specified index does not correspond to a BFeature in this collection.

Implements BFeatureCollection.

virtual BFeaturePtr GetAt	(	size_t	index,
		bool	inclCachedAttrs = `true`
	)			`[inline, virtual]`

Gets the BFeature at the specified index in this collection.

Parameters:

	index	The zero-based index of the desired BFeature.
	inclCachedAttrs	Indicates whether the returned feature will contain attributes. This applies only when the features are stored in a disk cache, and can be used to improve performance in applications where attributes are not needed. If the features are stored in memory, this has no effect.