BTransform Class Reference

#include <BTransform.h>

Inheritance diagram for BTransform:

[legend]

List of all members.

---

Detailed Description

An abstract base class for objects that transform geometric data.

Public Member Functions
	BTransform (const BTransform &rhs)
	Copy Constructor.
	BTransform (bool optimizeFor2D)
	Constructs a BTransform that may or may not be optimized to perform two-dimensional transformations.
virtual bool	ConvertSourceToTarget (double &x, double &y) const =0
	Performs this BTransform in the forward direction.
virtual BPoint	ConvertSourceToTarget (const BPoint &inPt) const =0
	Performs this BTransform in the forward direction.
virtual bool	ConvertTargetToSource (double &x, double &y) const =0
	Performs the inverse of this BTransform.
virtual BPoint	ConvertTargetToSource (const BPoint &inPt) const =0
	Performs the inverse of this BTransform.
virtual double	ConvertXDistance (double dist, const BPoint &refPt) const
	Converts a distance parallel to the x-axis, relative to the specified point, according to this BTransform.
virtual double	ConvertXDistanceReverse (double dist, const BPoint &refPt) const
	Converts a distance parallel to the x-axis, relative to the specified point, according to the inverse of this BTransform.
virtual double	ConvertYDistance (double dist, const BPoint &refPt) const
	Converts a distance parallel to the y-axis, relative to the specified point, according to this BTransform.
virtual double	ConvertYDistanceReverse (double dist, const BPoint &refPt) const
	Converts a distance parallel to the y-axis, relative to the specified point, according to the inverse of this BTransform.
virtual bool	GetOptimizeFor2D () const
	Indicates whether this BTransform is optimized for two-dimensional transformations or not.
virtual ETransformType	GetType () const =0
	Indicates the type of this BTransform.
virtual bool	IsValid (void) const =0
	Indicates whether or not the BTransform object is valid.
virtual	~BTransform ()
	Destructor.

---

Constructor & Destructor Documentation

BTransform

(

bool

optimizeFor2D

)

[inline]

Constructs a BTransform that may or may not be optimized to perform two-dimensional transformations.

Parameters:

optimizeFor2D

Indicates if this BTransform will be optimized to perform two-dimensional transformations.

BTransform

(

const BTransform &

rhs

)

[inline]

Copy Constructor.

Parameters:

rhs

The BTransform to copy.

virtual ~BTransform

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

virtual bool ConvertSourceToTarget	(	double &	x,
		double &	y
	)			const [pure virtual]

Performs this BTransform in the forward direction.

Parameters:

	x	The x-coordinate of the input point. When this method returns, this will hold the x-coordinate of the transformed point.
	y	The y-coordinate of the input point. When this method returns, this will hold the y-coordinate of the transformed point.

Returns:

True if this method is successful and false otherwise.

Implemented in BCoordTransform.

virtual BPoint ConvertSourceToTarget

(

const BPoint &

inPt

)

const [pure virtual]

Performs this BTransform in the forward direction.

Parameters:

inPt

The input point.

Returns:

The transformed point.

Implemented in BCoordTransform.

virtual bool ConvertTargetToSource	(	double &	x,
		double &	y
	)			const [pure virtual]

Performs the inverse of this BTransform.

Parameters:

	x	The x-coordinate of the input point. When this method returns, this will hold the x-coordinate of the transformed point.
	y	The y-coordinate of the input point. When this method returns, this will hold the y-coordinate of the transformed point.

Returns:

True if this method is successful and false otherwise.

Implemented in BCoordTransform.

virtual BPoint ConvertTargetToSource

(

const BPoint &

inPt

)

const [pure virtual]

Performs the inverse of this BTransform.

Parameters:

inPt

The input point.

Returns:

The transformed point.

Implemented in BCoordTransform.

virtual double ConvertXDistance	(	double	dist,
		const BPoint &	refPt
	)			const [inline, virtual]

Converts a distance parallel to the x-axis, relative to the specified point, according to this BTransform.

Parameters:

	dist	The distance value to be converted.
	refPt	The reference point.

Returns:

The transformed distance.

virtual double ConvertXDistanceReverse	(	double	dist,
		const BPoint &	refPt
	)			const [inline, virtual]

Converts a distance parallel to the x-axis, relative to the specified point, according to the inverse of this BTransform.

Parameters:

	dist	The distance value to be converted.
	refPt	The reference point.

Returns:

The transformed distance.

virtual double ConvertYDistance	(	double	dist,
		const BPoint &	refPt
	)			const [inline, virtual]

Converts a distance parallel to the y-axis, relative to the specified point, according to this BTransform.

Parameters:

	dist	The distance value to be converted.
	refPt	The reference point.

Returns:

The transformed distance.

virtual double ConvertYDistanceReverse	(	double	dist,
		const BPoint &	refPt
	)			const [inline, virtual]

Converts a distance parallel to the y-axis, relative to the specified point, according to the inverse of this BTransform.

Parameters:

	dist	The distance value to be converted.
	refPt	The reference point.

Returns:

The transformed distance.

virtual bool GetOptimizeFor2D

(

)

const [inline, virtual]

Indicates whether this BTransform is optimized for two-dimensional transformations or not.

Returns:

True if this is optimized for two-dimensional transformations and flase otherwise.

virtual ETransformType GetType

(

)

const [pure virtual]

Indicates the type of this BTransform.

Returns:

The type of this BTransform.

Implemented in BCoordTransform.

virtual bool IsValid

(

void

)

const [pure virtual]

Indicates whether or not the BTransform object is valid.

Returns:

True if the coordinate transform object is valid and alse otherwise.

Implemented in BCoordTransform.

---

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

• BTransform.h

---

GeoTranslate 5.0 From Blue Marble Geographics