omni::geometry::PolarVec Struct Reference

polar 3D vector defined by th two angles phi, theta and a radial distance More...

#include <PolarVec.h>

Collaboration diagram for omni::geometry::PolarVec:

Public Member Functions
	PolarVec ()
	default constructor More...
	PolarVec (const QVector3D &)
	Construct from QVector3D. More...
	PolarVec (const QVector4D &)
	Construct from QVector4D. More...
	PolarVec (Angle _longitude, Angle _latitude, qreal _radius)
	Construct from longitude angle, latitude angle and radius. More...
const PolarVec &	operator= (const QVector3D &)
	Assign from QVector3D. More...
	operator QVector3D () const
	QVector3D cast operator. More...
	operator QVector4D () const
	QVector4D cast operator. More...
const PolarVec &	operator+= (const PolarVec &)
	Increase by other PolarVec. More...
qreal	x () const
	Return x value (by converting to QVector3D internally) More...
qreal	y () const
	Return y value (by converting to QVector3D internally) More...
qreal	z () const
	Return z value (by converting to QVector3D internally) More...
QVector3D	vec () const
	Return converted QVector3D. More...
QVector3D	normalized () const
	Returns normalized QVector3D. More...
Angle	longitude () const
	Return longitudinal angle. More...
void	setLongitude (Angle)
	Set longitudinal angle. More...
Angle	latitude () const
	Return latitudinal angle. More...
void	setLatitude (Angle)
	Set latitudinal angle. More...
qreal	radius () const
	Return radius. More...
void	setRadius (qreal)
	Set radius. More...
void	toStream (QDataStream &) const
	Write transformation to stream. More...
void	fromStream (QDataStream &)
	Read transformation from stream. More...

Private Attributes
Angle	longitude_
Angle	latitude_
qreal	radius_

Friends
bool	operator== (PolarVec const &, PolarVec const &)
	Test for equality. More...

Detailed Description

polar 3D vector defined by th two angles phi, theta and a radial distance

Constructor & Destructor Documentation

omni::geometry::PolarVec::PolarVec

(

)

default constructor

    {}

omni::geometry::PolarVec::PolarVec

(

const QVector3D &

_vec

)

Construct from QVector3D.

    {
      operator=(_vec);
    }

omni::geometry::PolarVec::PolarVec

(

const QVector4D &

_vec

)

Construct from QVector4D.

    {
      if (_vec.w() !=
          0.0) operator=(QVector3D(_vec.x() / _vec.w(), _vec.y() / _vec.w(),
                                   _vec.z() / _vec.w()));
      else operator=(QVector3D(_vec.x(), _vec.y(), _vec.z()));
    }

omni::geometry::PolarVec::PolarVec	(	Angle	_longitude,
		Angle	_latitude,
		qreal	_radius
	)

Construct from longitude angle, latitude angle and radius.

                                                                       :
      longitude_(_longitude),
      latitude_(_latitude),
      radius_(_radius)
    {}

Member Function Documentation

void omni::geometry::PolarVec::fromStream

(

QDataStream &

_is

)

Read transformation from stream.

                                              {
      _is >> longitude_ >> latitude_ >> radius_;
    }

Angle omni::geometry::PolarVec::latitude

(

)

const

Return latitudinal angle.

    {
      return latitude_;
    }

Angle omni::geometry::PolarVec::longitude

(

)

const

Return longitudinal angle.

    {
      return longitude_;
    }

QVector3D omni::geometry::PolarVec::normalized

(

)

const

Returns normalized QVector3D.

    {
      return static_cast<QVector3D const&>(*this).normalized();
    }

omni::geometry::PolarVec::operator QVector3D

(

)

const

QVector3D cast operator.

    {
      qreal _phi   = longitude_.radians();
      qreal _theta = latitude_.radians();

      return radius() * QVector3D(
        sin(_theta) * cos(_phi),
        sin(_theta) * sin(_phi),
        cos(_theta));
    }

omni::geometry::PolarVec::operator QVector4D

(

)

const

QVector4D cast operator.

    {
      QVector3D _vec = *this;

      return QVector4D(_vec.x(), _vec.y(), _vec.z(), 1.0);
    }

const PolarVec & omni::geometry::PolarVec::operator+=

(

const PolarVec &

_vec

)

Increase by other PolarVec.

    {
      // add longitude
      longitude_ += _vec.longitude_;

      // add latitude
      latitude_ =
        Angle(std::min<qreal>(179.99,
                              std::max<qreal>(0.01,
                                              latitude_.degrees() +
                                              _vec.latitude_.degrees())));

      // add radius
      radius_ = std::max<qreal>(0.0, radius_ + _vec.radius_);
      return *this;
    }

const PolarVec & omni::geometry::PolarVec::operator=

(

const QVector3D &

_vec

)

Assign from QVector3D.

    {
      radius_    = _vec.length();
      longitude_ = Angle::fromRad(atan2(_vec.y(), _vec.x()));
      latitude_  =
        (radius_ != 0.0) ? Angle::fromRad(acos(_vec.z() / radius_)) : 0.0;
      return *this;
    }

qreal omni::geometry::PolarVec::radius

(

)

const

Return radius.

    {
      return radius_;
    }

void omni::geometry::PolarVec::setLatitude

(

Angle

_latitude

)

Set latitudinal angle.

    {
      latitude_ = _latitude;
    }

void omni::geometry::PolarVec::setLongitude

(

Angle

_longitude

)

Set longitudinal angle.

    {
      longitude_ = _longitude;
    }

void omni::geometry::PolarVec::setRadius

(

qreal

_radius

)

Set radius.

    {
      radius_ = _radius;
    }

void omni::geometry::PolarVec::toStream

(

QDataStream &

_os

)

const

Write transformation to stream.

                                                  {
      _os << longitude_ << latitude_ << radius_;
    }

QVector3D omni::geometry::PolarVec::vec

(

)

const

Return converted QVector3D.

    {
      return static_cast<QVector3D const&>(*this);
    }

qreal omni::geometry::PolarVec::x

(

)

const

Return x value (by converting to QVector3D internally)

    {
      return static_cast<QVector3D const&>(*this).x();
    }

qreal omni::geometry::PolarVec::y

(

)

const

Return y value (by converting to QVector3D internally)

    {
      return static_cast<QVector3D const&>(*this).y();
    }

qreal omni::geometry::PolarVec::z

(

)

const

Return z value (by converting to QVector3D internally)

    {
      return static_cast<QVector3D const&>(*this).z();
    }

Friends And Related Function Documentation

bool operator== ( PolarVec const &  _lhs, PolarVec const &  _rhs  )

friend

Test for equality.

    {
      return
        OMNI_TEST_MEMBER_EQUAL(longitude_) &&
        OMNI_TEST_MEMBER_EQUAL(latitude_) &&
        OMNI_TEST_MEMBER_EQUAL(radius_);
    }

Field Documentation

Angle omni::geometry::PolarVec::latitude_

private

Angle omni::geometry::PolarVec::longitude_

private

qreal omni::geometry::PolarVec::radius_

private

---

The documentation for this struct was generated from the following files:

• include/omni/geometry/PolarVec.h
• src/lib/geometry/PolarVec.cpp