Rogue Wave Views Charts Package API Reference Guide |
Rogue Wave Views Documentation Home |
Class for projection of data expressed in a polar system of coordinates. More...
#include <ilviews/charts/common.h>
Public Member Functions | |
IlvPolarProjector (IlDouble startingAngle=0.0, IlBoolean orientedClockwise=IlFalse) | |
Constructor. More... | |
IlvPolarProjector (IlDouble startingAngle, IlDouble range, IlBoolean orientedClockwise) | |
Constructor. More... | |
IlBoolean | getOrientedClockwise () const |
Indicates whether the polar system of coordinates is oriented clockwise. More... | |
IlDouble | getRange () const |
Returns the angle range. More... | |
IlDouble | getStartingAngle () const |
Returns the starting angle. More... | |
void | setOrientedClockwise (IlBoolean b) |
Specifies whether the polar system of coordinates is oriented clockwise. More... | |
void | setRange (IlDouble range) |
Sets the angle range. More... | |
void | setStartingAngle (IlDouble angle) |
Sets the starting angle. More... | |
Public Member Functions inherited from IlvAbstractProjector | |
virtual IlvAbstractProjector * | copy () const =0 |
Virtual copy constructor. More... | |
void | lock () |
Locks the current IlvAbstractProjector object. More... | |
IlvOutputFile & | save (IlvOutputFile &file) const |
Writes a complete description of the current object in a file. More... | |
void | unLock () |
Unlocks the current IlvAbstractProjector object. More... | |
virtual void | write (IlvOutputFile &file) const =0 |
Writes the attributes of the current object in a file. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from IlvAbstractProjector | |
static IlvAbstractProjector * | Load (IlvInputFile &file) |
Reads a projector object from a file. More... | |
Protected Member Functions inherited from IlvAbstractProjector | |
IlvAbstractProjector () | |
Constructor. More... | |
IlvAbstractProjector (const IlvAbstractProjector &projector) | |
Constructor. More... | |
IlvAbstractProjector (IlvInputFile &file) | |
Constructor. More... | |
Class for projection of data expressed in a polar system of coordinates.
Library: ilvcharts
This class is a subclass of IlvAbstractProjector
that handles the projection into screen coordinates for data expressed in a polar system of coordinates (theta, rho). Such a projector allows you to display data in a circular way. The abscissa values theta are mapped along a circular scale. The ordinate scale (or scales), which represent the rho values, are rectangular and are displayed radially. The polar system of coordinates can be oriented clockwise or counterclockwise.
Two constructors are provided:
IlvPolarProjector::IlvPolarProjector(IlDouble, IlBoolean)
.) IlvPolarProjector::IlvPolarProjector(IlDouble, IlDouble, IlBoolean)
.) IlvAbstractProjector
. IlvPolarProjector::IlvPolarProjector | ( | IlDouble | startingAngle = 0.0 , |
IlBoolean | orientedClockwise = IlFalse |
||
) |
Constructor.
Initializes a new IlvPolarProjector
object allowing to project in a circular way data with their abscissa values that are expressed in degrees.
startingAngle | The angle at which the data item with the minimum abscissa value will be displayed. This angle must be expressed in degrees. The other data items will be then displayed at the angle corresponding to their abscissa values, taking into account the fact that the angle corresponding to the minimum abscissa value is displayed at the angle startingAngle. |
orientedClockwise | A Boolean indicating whether the polar system of coordinates is oriented clockwise. |
0
by default and should be let to 0
, otherwise the projector will behave as if it was initialized to project data with their abscissa values that are not expressed in degrees (see the constructor IlvPolarProjector::IlvPolarProjector(IlDouble, IlDouble, IlBoolean)
). IlvPolarProjector::IlvPolarProjector | ( | IlDouble | startingAngle, |
IlDouble | range, | ||
IlBoolean | orientedClockwise | ||
) |
Constructor.
Initializes a new IlvPolarProjector
object allowing to project in a circular way data with their abscissa values that are not expressed in degrees.
startingAngle | The angle at which the minimum data that will be represented will be displayed. This angle must be expressed in degrees. |
range | The angle range within which the data will be displayed. This range must be expressed in degrees. |
orientedClockwise | Indicates whether the the polar system of coordinates is oriented clockwise. |
IlvPolarProjector::IlvPolarProjector(IlDouble, IlBoolean)
allows you to initialize such a projector. IlBoolean IlvPolarProjector::getOrientedClockwise | ( | ) | const |
Indicates whether the polar system of coordinates is oriented clockwise.
IlTrue
if the polar system of coordinates is oriented clockwise and IlFalse
if it is oriented counterclockwise. setOrientedClockwise()
. IlDouble IlvPolarProjector::getRange | ( | ) | const |
Returns the angle range.
IlvPolarProjector::IlvPolarProjector(IlDouble, IlDouble, IlBoolean)
for more details.) Otherwise, the range is set to 0
by default and so the returned value is 0
.setRange()
. IlDouble IlvPolarProjector::getStartingAngle | ( | ) | const |
Returns the starting angle.
IlvPolarProjector::IlvPolarProjector(IlDouble, IlBoolean)
and IlvPolarProjector::IlvPolarProjector(IlDouble, IlDouble, IlBoolean)
for more details.setStartingAngle()
. void IlvPolarProjector::setOrientedClockwise | ( | IlBoolean | b | ) |
Specifies whether the polar system of coordinates is oriented clockwise.
b | The new value of the Boolean indicating whether the polar system of coordinates is oriented clockwise. If b is equal to IlTrue , the polar system will be oriented clockwise. If b is equal to IlFalse , the polar system of coordinates will be oriented counterclockwise. |
void IlvPolarProjector::setRange | ( | IlDouble | range | ) |
Sets the angle range.
range | The new angle range. This range must be expressed in degrees. |
IlvPolarProjector::IlvPolarProjector(IlDouble, IlDouble, IlBoolean)
for more details.) So, this method must not be used if the data have their abscissa that are expressed in degrees. Otherwise, the data will be displayed as if their abscissa were not expressed in degrees. void IlvPolarProjector::setStartingAngle | ( | IlDouble | angle | ) |
Sets the starting angle.
angle | The new starting angle. This angle must be expressed in degrees. |
IlvPolarProjector::IlvPolarProjector(IlDouble, IlBoolean)
and IlvPolarProjector::IlvPolarProjector(IlDouble, IlDouble, IlBoolean)
for more details. © Copyright 2018, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.