Public Member Functions | Private Attributes
QwtPointPolar Class Reference

A point in polar coordinates. More...

#include <qwt_point_polar.h>

List of all members.

Public Member Functions

double azimuth () const
 Returns the azimuth.
bool isNull () const
 Returns true if radius() >= 0.0.
bool isValid () const
 Returns true if radius() >= 0.0.
QwtPointPolar normalized () const
bool operator!= (const QwtPointPolar &) const
bool operator== (const QwtPointPolar &) const
 Compare 2 points.
 QwtPointPolar ()
 QwtPointPolar (double azimuth, double radius)
 QwtPointPolar (const QwtPointPolar &)
 QwtPointPolar (const QPointF &)
double radius () const
 Returns the radius.
double & rAzimuth ()
 Returns the azimuth.
double & rRadius ()
 Returns the radius.
void setAzimuth (double)
 Sets the atimuth to atimuth.
void setPoint (const QPointF &)
void setRadius (double)
 Sets the radius to radius.
QPointF toPoint () const

Private Attributes

double d_azimuth
double d_radius

Detailed Description

A point in polar coordinates.

In polar coordinates a point is determined by an angle and a distance. See http://en.wikipedia.org/wiki/Polar_coordinate_system

Definition at line 28 of file qwt_point_polar.h.


Constructor & Destructor Documentation

Constructs a null point, with a radius and azimuth set to 0.0.

See also:
QPointF::isNull()

Definition at line 65 of file qwt_point_polar.h.

QwtPointPolar::QwtPointPolar ( double  azimuth,
double  radius 
) [inline]

Constructs a point with coordinates specified by radius and azimuth.

Parameters:
azimuthAzimuth
radiusRadius

Definition at line 77 of file qwt_point_polar.h.

QwtPointPolar::QwtPointPolar ( const QwtPointPolar other) [inline]

Constructs a point using the values of the point specified.

Parameters:
otherOther point

Definition at line 87 of file qwt_point_polar.h.

QwtPointPolar::QwtPointPolar ( const QPointF &  p)

Convert and assign values from a point in Cartesian coordinates

Parameters:
pPoint in Cartesian coordinates
See also:
setPoint(), toPoint()

Definition at line 22 of file qwt_point_polar.cpp.


Member Function Documentation

double QwtPointPolar::azimuth ( ) const [inline]

Returns the azimuth.

Definition at line 112 of file qwt_point_polar.h.

bool QwtPointPolar::isNull ( ) const [inline]

Returns true if radius() >= 0.0.

Definition at line 100 of file qwt_point_polar.h.

bool QwtPointPolar::isValid ( ) const [inline]

Returns true if radius() >= 0.0.

Definition at line 94 of file qwt_point_polar.h.

Normalize radius and azimuth

When the radius is < 0.0 it is set to 0.0. The azimuth is a value >= 0.0 and < 2 * M_PI.

Returns:
Normalized point

Definition at line 96 of file qwt_point_polar.cpp.

bool QwtPointPolar::operator!= ( const QwtPointPolar other) const

Compare 2 points

Two points are equal to each other if radius and azimuth-coordinates are the same. Points are not equal, when the azimuth differs, but other.azimuth() == azimuth() % (2 * PI).

Returns:
True if the point is not equal to other; otherwise return false.
See also:
normalized()

Definition at line 83 of file qwt_point_polar.cpp.

bool QwtPointPolar::operator== ( const QwtPointPolar other) const

Compare 2 points.

Two points are equal to each other if radius and azimuth-coordinates are the same. Points are not equal, when the azimuth differs, but other.azimuth() == azimuth() % (2 * PI).

Returns:
True if the point is equal to other; otherwise return false.
See also:
normalized()

Definition at line 68 of file qwt_point_polar.cpp.

double QwtPointPolar::radius ( ) const [inline]

Returns the radius.

Definition at line 106 of file qwt_point_polar.h.

double & QwtPointPolar::rAzimuth ( ) [inline]

Returns the azimuth.

Definition at line 124 of file qwt_point_polar.h.

double & QwtPointPolar::rRadius ( ) [inline]

Returns the radius.

Definition at line 118 of file qwt_point_polar.h.

void QwtPointPolar::setAzimuth ( double  azimuth) [inline]

Sets the atimuth to atimuth.

Definition at line 136 of file qwt_point_polar.h.

void QwtPointPolar::setPoint ( const QPointF &  p)

Convert and assign values from a point in Cartesian coordinates

Parameters:
pPoint in Cartesian coordinates

Definition at line 32 of file qwt_point_polar.cpp.

void QwtPointPolar::setRadius ( double  radius) [inline]

Sets the radius to radius.

Definition at line 130 of file qwt_point_polar.h.

QPointF QwtPointPolar::toPoint ( ) const

Convert and return values in Cartesian coordinates

Returns:
Converted point in Cartesian coordinates
Note:
Invalid or null points will be returned as QPointF(0.0, 0.0)
See also:
isValid(), isNull()

Definition at line 46 of file qwt_point_polar.cpp.


Member Data Documentation

double QwtPointPolar::d_azimuth [private]

Definition at line 57 of file qwt_point_polar.h.

double QwtPointPolar::d_radius [private]

Definition at line 58 of file qwt_point_polar.h.


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


plotjuggler
Author(s): Davide Faconti
autogenerated on Fri Sep 1 2017 02:41:58