Rogue Wave Views 5.6
Rogue Wave Views
Charts Package API Reference Guide
Rogue Wave Views
Documentation Home
Rogue Wave Views 5.6 |
Rogue Wave Views |
Rogue Wave Views Documentation Home |
Class for computing the graduations of a scale. More...
#include <ilviews/charts/scaledis.h>
Public Member Functions | |
| IlvZoomCoordinateTransformer (const IlvCoordInterval &zoomWindow, IlDouble zoomFactor, IlBoolean continuous=IlTrue) | |
| Constructor. | |
| virtual IlvCoordinateTransformer * | copy () const |
| Virtual copy constructor. | |
| void | getTransformedWindow (IlvCoordInterval &itv) const |
| Applies the zoom factor to the interval of data that is displayed as zoomed. | |
| IlDouble | getZoomFactor () const |
| Returns the zoom factor. | |
| const IlvCoordInterval & | getZoomWindow () const |
| Returns the interval of data that is displayed as zoomed. | |
| virtual IlBoolean | inverseTransformPoints (IlUInt pointsCount, IlvDoublePoint *points) const |
| Applies the inverse transformation to points. | |
| virtual IlBoolean | inverseTransformValue (IlDouble &value) const |
| Applies the inverse transformation to a value. | |
| IlBoolean | isContinuous () const |
| Indicates whether the transition between the zoomed data and the nonzoomed data is continuous. | |
| void | setContinuous (IlBoolean continuous) |
| Specifies whether the transition between the zoomed data and the nonzoomed data is continuous. | |
| IlBoolean | setZoomFactor (IlDouble zoomFactor) |
| Sets the zoom factor. | |
| IlBoolean | setZoomWindow (IlDouble start, IlDouble end) |
| Sets the interval of data that is displayed as zoomed. | |
| IlBoolean | setZoomWindow (const IlvCoordInterval &window) |
| Sets the interval of data that is displayed as zoomed. | |
| virtual IlBoolean | transformPoints (IlUInt pointsCount, IlvDoublePoint *points) const |
| Applies a transformation to data points. | |
| virtual IlBoolean | transformValue (IlDouble &value) const |
| Applies a transformation to a data value. | |
| virtual IlBoolean | validateInterval (IlvCoordInterval &interval) const |
| Validates an interval. | |
| virtual void | write (IlvOutputFile &) const |
| Writes the attributes of the current object in a file. | |
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.
IlvZoomScaleStepsUpdater class) must also be set on the scale representing this coordinate in order to compute the corresponding graduations for the scale.IlvCoordinateTransformer. | IlvZoomCoordinateTransformer::IlvZoomCoordinateTransformer | ( | const IlvCoordInterval & | zoomWindow, | |
| IlDouble | zoomFactor, | |||
| IlBoolean | continuous = IlTrue | |||
| ) |
Constructor.
Initializes a new IlvZoomCoordinateTransformer object.
| zoomWindow | The interval on which the data are displayed as zoomed. | |
| zoomFactor | The zoom factor that is applied to the data belonging to the interval zoomWindow. | |
| continuous | A Boolean indicating whether the transition between the zoomed area and the nonzoomed area is continuous. |
| virtual IlvCoordinateTransformer* IlvZoomCoordinateTransformer::copy | ( | ) | const [virtual] |
Virtual copy constructor.
Creates and returns a copy of the current object. This method must be overloaded in subclasses. It is automatically declared by the DeclareCoordinateTransformerTypeInfo macro. The IlvPredefinedCoordinateTransformerIOMembers macro lets you define a default implementation, which returns an instance initialized with the copy constructor.
Implements IlvCoordinateTransformer.
| void IlvZoomCoordinateTransformer::getTransformedWindow | ( | IlvCoordInterval & | itv | ) | const |
Applies the zoom factor to the interval of data that is displayed as zoomed.
| itv | Returns 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.
| const IlvCoordInterval& IlvZoomCoordinateTransformer::getZoomWindow | ( | ) | const |
Returns the interval of data that is displayed as zoomed.
| virtual IlBoolean IlvZoomCoordinateTransformer::inverseTransformPoints | ( | IlUInt | pointsCount, | |
| IlvDoublePoint * | points | |||
| ) | const [virtual] |
Applies the inverse transformation to points.
| pointsCount | The number of points to which the inverse transformation is applied. | |
| points | This parameter stores the points to transform inversely and is also used to return the points once they have been inversely transformed. |
IlTrue if the inverse transformation has been successfully applied and IlFalse otherwise.Reimplemented from IlvCoordinateTransformer.
| virtual IlBoolean IlvZoomCoordinateTransformer::inverseTransformValue | ( | IlDouble & | val | ) | const [virtual] |
Applies the inverse transformation to a value.
| val | This parameter stores the value to transform inversely and is also used to return the value once it has been inversely transformed. |
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.
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.
| continuous | The new value of the flag indicating whether the transition between the zoomed data and the nonzoomed data is continuous. |
Sets the zoom factor.
| zoomFactor | The new zoom factor that is applied to the data that are displayed as zoomed. |
Sets the interval of data that is displayed as zoomed.
| start | The beginning of the interval for which the data are displayed as zoomed. | |
| end | The end of the interval for which the data are displayed as zoomed. |
| IlBoolean IlvZoomCoordinateTransformer::setZoomWindow | ( | const IlvCoordInterval & | window | ) |
Sets the interval of data that is displayed as zoomed.
| window | The new 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.
| pointsCount | The number of points to which the transformation is applied. | |
| points | This parameter stores the points to transform and is also used to return the transformed points. |
IlTrue if the transformation has been successfully applied and IlFalse otherwise.Reimplemented from IlvCoordinateTransformer.
Applies a transformation to a data value.
| value | This parameter stores the value to transform and is also used to return the transformed value. |
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.
| interval | The interval to validate. |
Reimplemented from IlvCoordinateTransformer.
| virtual void IlvZoomCoordinateTransformer::write | ( | IlvOutputFile & | file | ) | const [virtual] |
Writes the attributes of the current object in a file.
Called by the IlvCoordinateTransformer::save method. This method can be overloaded in subclasses that define new attributes. The information written by the write method is read by the IO constructor, which takes an IlvInputFile as its only argument. Both this method and the IO constructor can be automatically declared by using the DeclareCoordinateTransformerTypeInfo macro within the class declaration.
| file | The file where the attributes of the current object are written. |
Reimplemented from IlvCoordinateTransformer.
© Copyright 2012, 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.