IlvSimpleChartTransformer Class Reference

Class defining a transformation made of a logarithmic transformation to be applied to a coordinate. More...

#include <ilviews/charts/common.h>

Inheritance diagram for IlvSimpleChartTransformer:

Public Member Functions
	IlvSimpleChartTransformer (IlUInt logBase=0)
	Constructor. More...
virtual void	applyElementaryTransfo (IlDouble &val) const
	Applies the elementary transformation to a value. More...
virtual void	applyInverseElementaryTransfo (IlDouble &val) const
	Applies the inverse of the elementary transformation to a value. More...
virtual IlBoolean	condToApplyElementaryTransfo () const
	Indicates whether the elementary transformation can be applied. More...
virtual IlBoolean	condToApplyInverseElementaryTransfo () const
	Indicates whether the inverse of the elementary transformation can be applied. More...
Public Member Functions inherited from IlvChartCoordinateTransformer
void	applyInverseLogTransfo (IlDouble &val) const
	Applies the inverse of the logarithmic transformation. More...
void	applyLogTransfo (IlDouble &val) const
	Applies the logarithmic transformation to a value. More...
IlUInt	getLogBase () const
	Returns the logarithmic base. More...
virtual IlBoolean	inverseTransformPoints (IlUInt pointsCount, IlvDoublePoint *points) const
	Applies the inverse transformation to points. More...
virtual IlBoolean	inverseTransformValue (IlDouble &val) const
	Applies the inverse transformation to a value. More...
virtual IlBoolean	inverseTransformValues (IlUInt valuesCount, IlDouble *values) const
	Applies the inverse transformation to values. More...
void	setLogBase (IlUInt base)
	Sets the logarithmic base. More...
virtual IlBoolean	transformPoints (IlUInt pointsCount, IlvDoublePoint *points) const
	Applies a transformation to data points. More...
virtual IlBoolean	transformValue (IlDouble &val) const
	Applies a transformation to a data value. More...
virtual IlBoolean	transformValues (IlUInt valuesCount, IlDouble *values) const
	Applies a transformation to data values. More...
virtual IlBoolean	validateInterval (IlvCoordInterval &interval) const
	Validates an interval. More...
virtual void	write (IlvOutputFile &file) const
	Writes the attributes of the current object in a file. More...
Public Member Functions inherited from IlvCoordinateTransformer
virtual	~IlvCoordinateTransformer ()
	Destructor. More...
virtual IlvCoordinateTransformer *	copy () const =0
	Virtual copy constructor. More...
const IlvCoordinateInfo *	getOwner () 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...
IlvOutputFile &	save (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...

Additional Inherited Members
Static Public Member Functions inherited from IlvCoordinateTransformer
static IlvCoordinateTransformer *	Load (IlvInputFile &file)
	Reads a coordinate transformer object from a file. More...
Protected Member Functions inherited from IlvChartCoordinateTransformer
	IlvChartCoordinateTransformer (const IlvChartCoordinateTransformer &t)
	Constructor. More...
	IlvChartCoordinateTransformer (IlUInt logBase)
	Constructor. More...
	IlvChartCoordinateTransformer (IlvInputFile &file)
	Constructor. More...
Protected Member Functions inherited from IlvCoordinateTransformer
	IlvCoordinateTransformer ()
	Constructor. More...
	IlvCoordinateTransformer (const IlvCoordinateTransformer &transfo)
	Constructor. More...
	IlvCoordinateTransformer (IlvInputFile &file)
	Constructor. More...

Detailed Description

Class defining a transformation made of a logarithmic transformation to be applied to a coordinate.

Library: ilvcharts

This class is a subclass of IlvChartCoordinateTransformer with an identity transformation as the elementary transformation. This means that no transformation is applied to the coordinate or that only a logarithmic transformation is applied if the logarithmic base is greater than 1.

See also

IlvChartCoordinateTransformer.

Constructor & Destructor Documentation

IlvSimpleChartTransformer()

IlvSimpleChartTransformer::IlvSimpleChartTransformer

(

IlUInt

logBase = 0

)

Constructor.

Initializes a new IlvSimpleChartTransformer object.

Parameters

logBase

The logarithmic base set for the current object.

Member Function Documentation

applyElementaryTransfo()

virtual void IlvSimpleChartTransformer::applyElementaryTransfo ( IlDouble &  val ) const

virtual

Applies the elementary transformation to a value.

Parameters

val	This parameter stores the value to transform and is also used to return the transformed value.

Note

Nothing is done in the case of the IlvSimpleChartTransformer class: the value stored in val is not modified since the elementary transformation is the identity.

Implements IlvChartCoordinateTransformer.

applyInverseElementaryTransfo()

virtual void IlvSimpleChartTransformer::applyInverseElementaryTransfo ( IlDouble &  val ) const

virtual

Applies the inverse of the elementary transformation to a value.

Parameters

val	This parameter stores the value to transform inversely and is also used to return the value once it has been inversely transformed.

Note

Nothing is done in the case of the IlvSimpleChartTransformer class: the value stored in val is not modified since the elementary transformation is the identity.

Implements IlvChartCoordinateTransformer.

condToApplyElementaryTransfo()

virtual IlBoolean IlvSimpleChartTransformer::condToApplyElementaryTransfo ( ) const

virtual

Indicates whether the elementary transformation can be applied.

Returns

IlTrue by default, since the elementary transformation is the identity and, therefore, can always be applied.

Implements IlvChartCoordinateTransformer.

condToApplyInverseElementaryTransfo()

virtual IlBoolean IlvSimpleChartTransformer::condToApplyInverseElementaryTransfo ( ) const

virtual

Indicates whether the inverse of the elementary transformation can be applied.

Returns

IlTrue by default, since the elementary transformation is the identity and, therefore, the inverse of this transformation can always be applied.

Implements IlvChartCoordinateTransformer.