BExternalRefFeature Class Reference

#include <BExternalRefFeature.h>

Inheritance diagram for BExternalRefFeature:

Inheritance graph
[legend]

List of all members.


Detailed Description

The BExternalRefFeature class represents a reference to an external file that contains the geometry.

The geometry associated with this feature must be a BPointGeo object, representing the insertion point for the reference.

Public Member Functions

 BExternalRefFeature (const BExternalRefFeature &feat)
 Copy constructor.
 BExternalRefFeature ()
 Default constructor.
virtual BFeatureClone (void) const
 Creates a deep-copy of this object.
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.
const BStringGetFileName (void) const
 Gets the file name for the external file that contains the geometry for this feature.
double GetRotationAngle (void) const
 Gets the rotation angle that will be applied to the external geometry.
double GetScale (void) const
 Gets the scale factor that will be applied to the external geometry.
void SetFileName (const BString &fileName)
 Set the file name for the external file that contains the geometry for this feature.
virtual void SetGeometry (const BGeometryPtr &geo)
 Sets the insertion point for the external geometry.
void SetRotationAngle (double angle)
 Sets the rotation angle to be applied to the external geometry.
void SetScale (double scale)
 Sets the scale factor to be applied to the external geometry.
virtual BByteArray ToByteArray (void) const
 Stores this object in a BByteArray.


Constructor & Destructor Documentation

BExternalRefFeature (  )  [inline]

Default constructor.

BExternalRefFeature ( const BExternalRefFeature feat  )  [inline]

Copy constructor.

Parameters:
feat The BExternalRefFeature to copy.


Member Function Documentation

virtual BFeature* Clone ( void   )  const [inline, virtual]

Creates a deep-copy of this object.

Returns:
A deep-copy of this object.

Reimplemented from BFeature.

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.

Reimplemented from BFeature.

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

Initializes an instance of this object from a BByteArray.

Parameters:
bytes The BByteArray containing the byte representation for this 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.

Reimplemented from BFeature.

const BString& GetFileName ( void   )  const [inline]

Gets the file name for the external file that contains the geometry for this feature.

Returns:
The external file name.

double GetRotationAngle ( void   )  const [inline]

Gets the rotation angle that will be applied to the external geometry.

Returns:
The rotation angle, in radians.

double GetScale ( void   )  const [inline]

Gets the scale factor that will be applied to the external geometry.

Returns:
The scale factor.

void SetFileName ( const BString fileName  )  [inline]

Set the file name for the external file that contains the geometry for this feature.

Parameters:
fileName The external file name.

virtual void SetGeometry ( const BGeometryPtr geo  )  [virtual]

Sets the insertion point for the external geometry.

Note that the geometry for a BExternalRefFeature must always be a BPointGeo that gives the insertion point for the external geometry.

Parameters:
geo The insertion point.

Reimplemented from BFeature.

void SetRotationAngle ( double  angle  )  [inline]

Sets the rotation angle to be applied to the external geometry.

Parameters:
angle The rotation angle, in radians.

void SetScale ( double  scale  )  [inline]

Sets the scale factor to be applied to the external geometry.

Parameters:
scale The scale factor.

virtual BByteArray ToByteArray ( void   )  const [virtual]

Stores this object in a BByteArray.

Returns:
A BByteArray that stores the contents of this object.

Reimplemented from BFeature.


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

GeoTranslate 5.0 From Blue Marble Geographics