rwlogo

Rogue Wave Views
Charts Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros
List of all members | Public Member Functions
IlvZoomCoordinateTransformer Class Reference

Class for computing the graduations of a scale. More...

#include <ilviews/charts/scaledis.h>

Inheritance diagram for IlvZoomCoordinateTransformer:
IlvCoordinateTransformer

Public Member Functions

 IlvZoomCoordinateTransformer (const IlvCoordInterval &zoomWindow, IlDouble zoomFactor, IlBoolean continuous=IlTrue)
 Constructor. More...
 
void getTransformedWindow (IlvCoordInterval &itv) const
 Applies the zoom factor to the interval of data that is displayed as zoomed. More...
 
IlDouble getZoomFactor () const
 Returns the zoom factor. More...
 
const IlvCoordIntervalgetZoomWindow () const
 Returns the interval of data that is displayed as zoomed. More...
 
virtual IlBoolean inverseTransformPoints (IlUInt pointsCount, IlvDoublePoint *points) const
 Applies the inverse transformation to points. More...
 
virtual IlBoolean inverseTransformValue (IlDouble &value) const
 Applies the inverse transformation to a value. More...
 
IlBoolean isContinuous () const
 Indicates whether the transition between the zoomed data and the nonzoomed data is continuous. More...
 
void setContinuous (IlBoolean continuous)
 Specifies whether the transition between the zoomed data and the nonzoomed data is continuous. More...
 
IlBoolean setZoomFactor (IlDouble zoomFactor)
 Sets the zoom factor. More...
 
IlBoolean setZoomWindow (const IlvCoordInterval &window)
 Sets the interval of data that is displayed as zoomed. More...
 
IlBoolean setZoomWindow (IlDouble start, IlDouble end)
 Sets the interval of data that is displayed as zoomed. More...
 
virtual IlBoolean transformPoints (IlUInt pointsCount, IlvDoublePoint *points) const
 Applies a transformation to data points. More...
 
virtual IlBoolean transformValue (IlDouble &value) const
 Applies a transformation to a data value. More...
 
virtual IlBoolean validateInterval (IlvCoordInterval &interval) const
 Validates an interval. More...
 
- Public Member Functions inherited from IlvCoordinateTransformer
virtual ~IlvCoordinateTransformer ()
 Destructor. More...
 
virtual IlvCoordinateTransformercopy () const =0
 Virtual copy constructor. More...
 
const IlvCoordinateInfogetOwner () const
 Returns the coordinate information that owns the current object. More...
 
virtual IlBoolean inverseTransformInterval (IlvCoordInterval &itvl) const
 Applies the inverse transformation to an interval. More...
 
virtual IlBoolean inverseTransformValues (IlUInt valuesCount, IlDouble *values) const
 Applies the inverse transformation to values. More...
 
IlvOutputFilesave (IlvOutputFile &file) const
 Writes a complete description of the current object in a file. More...
 
virtual IlBoolean transformInterval (IlvCoordInterval &itvl) const
 Applies a transformation to an interval. More...
 
virtual IlBoolean transformValues (IlUInt valuesCount, IlDouble *values) const
 Applies a transformation to data values. More...
 
virtual void write (IlvOutputFile &file) const
 Writes the attributes of the current object in a file. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvCoordinateTransformer
static IlvCoordinateTransformerLoad (IlvInputFile &file)
 Reads a coordinate transformer object from a file. More...
 
- Protected Member Functions inherited from IlvCoordinateTransformer
 IlvCoordinateTransformer ()
 Constructor. More...
 
 IlvCoordinateTransformer (const IlvCoordinateTransformer &transfo)
 Constructor. More...
 
 IlvCoordinateTransformer (IlvInputFile &file)
 Constructor. More...
 

Detailed Description

Class for computing the graduations of a scale.

Library: ilvcharts

IlvZoomCoordinateTransformer is a subclass of IlvCoordinateTransformer that allows you to define a transformation that is applied locally to a part of the data. This allows you to display these data as zoomed.

Warning
If a zoom coordinate transformer is set on a given coordinate, a zoom scale steps updater (an instance of the IlvZoomScaleStepsUpdater class) must also be set on the scale representing this coordinate in order to compute the corresponding graduations for the scale.
See Also
IlvCoordinateTransformer.

Constructor & Destructor Documentation

IlvZoomCoordinateTransformer::IlvZoomCoordinateTransformer ( const IlvCoordInterval zoomWindow,
IlDouble  zoomFactor,
IlBoolean  continuous = IlTrue 
)

Constructor.

Initializes a new IlvZoomCoordinateTransformer object.

Parameters
zoomWindowThe interval on which the data are displayed as zoomed.
zoomFactorThe zoom factor that is applied to the data belonging to the interval zoomWindow.
continuousA Boolean indicating whether the transition between the zoomed area and the nonzoomed area is continuous.

Member Function Documentation

void IlvZoomCoordinateTransformer::getTransformedWindow ( IlvCoordInterval itv) const

Applies the zoom factor to the interval of data that is displayed as zoomed.

Parameters
itvReturns the interval of data that is displayed as zoomed, once it has been transformed by the zoom factor.
IlDouble IlvZoomCoordinateTransformer::getZoomFactor ( ) const

Returns the zoom factor.

Returns
The zoom factor that is applied to the data that are displayed as zoomed.
const IlvCoordInterval& IlvZoomCoordinateTransformer::getZoomWindow ( ) const

Returns the interval of data that is displayed as zoomed.

Returns
The interval for which the data are displayed as zoomed.
virtual IlBoolean IlvZoomCoordinateTransformer::inverseTransformPoints ( IlUInt  pointsCount,
IlvDoublePoint points 
) const
virtual

Applies the inverse transformation to points.

Parameters
pointsCountThe number of points to which the inverse transformation is applied.
pointsThis parameter stores the points to transform inversely and is also used to return the points once they have been inversely transformed.
Returns
IlTrue if the inverse transformation has been successfully applied and IlFalse otherwise.
Note
The inverse transformation is applied only to one coordinate of the points since the transformation is defined for one coordinate (x, y, theta, or rho) represented by a given scale.

Reimplemented from IlvCoordinateTransformer.

virtual IlBoolean IlvZoomCoordinateTransformer::inverseTransformValue ( IlDouble val) const
virtual

Applies the inverse transformation to a value.

Parameters
valThis parameter stores the value to transform inversely and is also used to return the value once it has been inversely transformed.
Returns
IlTrue if the inverse transformation has been successfully applied and IlFalse otherwise.

Implements IlvCoordinateTransformer.

IlBoolean IlvZoomCoordinateTransformer::isContinuous ( ) const

Indicates whether the transition between the zoomed data and the nonzoomed data is continuous.

Returns
IlTrue if the transition between the zoomed data and the nonzoomed data is continuous and IlFalse otherwise.
void IlvZoomCoordinateTransformer::setContinuous ( IlBoolean  continuous)

Specifies whether the transition between the zoomed data and the nonzoomed data is continuous.

Parameters
continuousThe new value of the flag indicating whether the transition between the zoomed data and the nonzoomed data is continuous.
IlBoolean IlvZoomCoordinateTransformer::setZoomFactor ( IlDouble  zoomFactor)

Sets the zoom factor.

Parameters
zoomFactorThe new zoom factor that is applied to the data that are displayed as zoomed.
IlBoolean IlvZoomCoordinateTransformer::setZoomWindow ( const IlvCoordInterval window)

Sets the interval of data that is displayed as zoomed.

Parameters
windowThe new interval for which the data are displayed as zoomed.
IlBoolean IlvZoomCoordinateTransformer::setZoomWindow ( IlDouble  start,
IlDouble  end 
)

Sets the interval of data that is displayed as zoomed.

Parameters
startThe beginning of the interval for which the data are displayed as zoomed.
endThe end of the interval for which the data are displayed as zoomed.
virtual IlBoolean IlvZoomCoordinateTransformer::transformPoints ( IlUInt  pointsCount,
IlvDoublePoint points 
) const
virtual

Applies a transformation to data points.

Parameters
pointsCountThe number of points to which the transformation is applied.
pointsThis parameter stores the points to transform and is also used to return the transformed points.
Returns
IlTrue if the transformation has been successfully applied and IlFalse otherwise.
Note
The transformation is applied only to one coordinate of the points, since the transformation is defined for one coordinate (x, y, theta or rho) represented by a given scale.

Reimplemented from IlvCoordinateTransformer.

virtual IlBoolean IlvZoomCoordinateTransformer::transformValue ( IlDouble value) const
virtual

Applies a transformation to a data value.

Parameters
valueThis parameter stores the value to transform and is also used to return the transformed value.
Returns
IlTrue if the transformation has been successfully applied and IlFalse otherwise.

Implements IlvCoordinateTransformer.

virtual IlBoolean IlvZoomCoordinateTransformer::validateInterval ( IlvCoordInterval interval) const
virtual

Validates an interval.

Changes the interval interval so that it becomes consistent with the definition domain of the transformer. The default implementation does nothing and returns IlFalse, which indicates that the interval has not been modified.

Parameters
intervalThe interval to validate.
Returns
A Boolean value indicating whether the interval has been modified.

Reimplemented from IlvCoordinateTransformer.


© Copyright 2015, 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.