BRotation Class Reference

#include <BRotation.h>

Inheritance diagram for BRotation:

[legend]

List of all members.

---

Detailed Description

Describes a rotation in three-dimensions.

Public Member Functions
	BRotation (const BRotation &r)
	Copy constructor.
	BRotation (double xy, double yz, double zx)
	Constructs a BRotation with the specified rotation parameters.
	BRotation ()
	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.
double	GetXYAngle (void) const
	Gets the rotation angle in the XY plane.
double	GetYZAngle (void) const
	Gets the rotation angle in the YZ plane.
double	GetZXAngle (void) const
	Gets the rotation angle in the ZX plane.
void	SetXYAngle (double xy)
	Sets the rotation angle in the XY plane.
void	SetYZAngle (double yz)
	Sets the rotation angle in the YZ plane.
void	SetZXAngle (double zx)
	Sets the rotation angle in the ZX plane.
virtual BByteArray	ToByteArray (void) const
	Stores this object in a BByteArray.
Static Public Member Functions
static size_t	SizeOf (void)
	Returns the size of a BRotation in bytes.

---

Constructor & Destructor Documentation

BRotation

(

)

[inline]

Default constructor.

BRotation	(	double	xy,
		double	yz,
		double	zx
	)			[inline]

Constructs a BRotation with the specified rotation parameters.

Parameters:

	xy	The rotation angle in XY plane.
	yz	The rotation angle in YZ plane.
	zx	The rotation angle in ZX plane.

BRotation

(

const BRotation &

r

)

[inline]

Copy constructor.

Parameters:

r

The BRotation object to copy.

---

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
	)			[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.

double GetXYAngle

(

void

)

const [inline]

Gets the rotation angle in the XY plane.

Returns:

xy The rotation angle in the XY plane.

double GetYZAngle

(

void

)

const [inline]

Gets the rotation angle in the YZ plane.

Returns:

yz The rotation angle in the YZ plane.

double GetZXAngle

(

void

)

const [inline]

Gets the rotation angle in the ZX plane.

Returns:

zx The rotation angle in the ZX plane.

void SetXYAngle

(

double

xy

)

[inline]

Sets the rotation angle in the XY plane.

Parameters:

xy

The rotation angle in the XY plane.

void SetYZAngle

(

double

yz

)

[inline]

Sets the rotation angle in the YZ plane.

Parameters:

yz

The rotation angle in the YZ plane.

void SetZXAngle

(

double

zx

)

[inline]

Sets the rotation angle in the ZX plane.

Parameters:

zx

The rotation angle in the ZX plane.

static size_t SizeOf

(

void

)

[inline, static]

Returns the size of a BRotation in bytes.

Returns:

The size of a BRotation in bytes.

virtual BByteArray ToByteArray

(

void

)

const [virtual]

Stores this object in a BByteArray.

Returns:

A BByteArray that stores the contents of this object.

Implements BByteStreamable.

---

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

• BRotation.h

---

GeoTranslate 5.0 From Blue Marble Geographics