Views
Charts Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IlvPolarProjector Class Reference

Class for projection of data expressed in a polar system of coordinates. More...

#include <ilviews/charts/common.h>

Inheritance diagram for IlvPolarProjector:
IlvAbstractProjector

Public Member Functions

 IlvPolarProjector (IlDouble startingAngle, IlDouble range, IlBoolean orientedClockwise)
 Constructor. More...
 
 IlvPolarProjector (IlDouble startingAngle=0.0, IlBoolean orientedClockwise=IlFalse)
 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 IlvAbstractProjectorcopy () const =0
 Virtual copy constructor. More...
 
void lock ()
 Locks the current IlvAbstractProjector object. More...
 
IlvOutputFilesave (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 IlvAbstractProjectorLoad (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...
 

Detailed Description

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:

See also
IlvAbstractProjector.

Constructor & Destructor Documentation

◆ IlvPolarProjector() [1/2]

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.

Parameters
startingAngleThe 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.
orientedClockwiseA Boolean indicating whether the polar system of coordinates is oriented clockwise.
Note
The range of the projector is meaningless when the projector is initialized so that to be able to project data with their abscissa values expressed in degrees. It is set to 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() [2/2]

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.

Parameters
startingAngleThe angle at which the minimum data that will be represented will be displayed. This angle must be expressed in degrees.
rangeThe angle range within which the data will be displayed. This range must be expressed in degrees.
orientedClockwiseIndicates whether the the polar system of coordinates is oriented clockwise.
Note
It is possible to define a polar projector that allows you to project in a circular way data with their abscissa values that are expressed in degrees. The constructor IlvPolarProjector::IlvPolarProjector(IlDouble, IlBoolean) allows you to initialize such a projector.

Member Function Documentation

◆ getOrientedClockwise()

IlBoolean IlvPolarProjector::getOrientedClockwise ( ) const

Indicates whether the polar system of coordinates is oriented clockwise.

Returns
IlTrue if the polar system of coordinates is oriented clockwise and IlFalse if it is oriented counterclockwise.
See also
setOrientedClockwise().

◆ getRange()

IlDouble IlvPolarProjector::getRange ( ) const

Returns the angle range.

Returns
The angle range.
Note
The angle range is meaningful only for a projector used to project in a circular way data with their abscissa that are not expressed in degrees. (See the constructor IlvPolarProjector::IlvPolarProjector(IlDouble, IlDouble, IlBoolean) for more details.) Otherwise, the range is set to 0 by default and so the returned value is 0.
See also
setRange().

◆ getStartingAngle()

IlDouble IlvPolarProjector::getStartingAngle ( ) const

Returns the starting angle.

Returns
The starting angle.
Note
See the constructors IlvPolarProjector::IlvPolarProjector(IlDouble, IlBoolean) and IlvPolarProjector::IlvPolarProjector(IlDouble, IlDouble, IlBoolean) for more details.
See also
setStartingAngle().

◆ setOrientedClockwise()

void IlvPolarProjector::setOrientedClockwise ( IlBoolean  b)

Specifies whether the polar system of coordinates is oriented clockwise.

Parameters
bThe 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.

◆ setRange()

void IlvPolarProjector::setRange ( IlDouble  range)

Sets the angle range.

Parameters
rangeThe new angle range. This range must be expressed in degrees.
Note
The angle range is meaningful only for a projector used to project in a circular way data with their abscissa that are not expressed in degrees. (See the constructor 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.

◆ setStartingAngle()

void IlvPolarProjector::setStartingAngle ( IlDouble  angle)

Sets the starting angle.

Parameters
angleThe new starting angle. This angle must be expressed in degrees.
Note
See the constructors IlvPolarProjector::IlvPolarProjector(IlDouble, IlBoolean) and IlvPolarProjector::IlvPolarProjector(IlDouble, IlDouble, IlBoolean) for more details.