Public Member Functions

ParamDimensionBase Class Reference

Search for all occurrences

Detailed Description

See also:
Class ParamDimension.
Description:
This class (along with ParamDimension) describes the dimension of a parameter. This dimension can be considered a unit of measure. It describes the parameter's type and order of magnitude.

The dimension type and possibly the dimension scale (if the type is custom) are used to determine a scale factor for the parameter. When a controller is drawing a function curve, it only needs to use the Convert() function - the scale factor is rolled into the single 'vzoom' parameter passed to Animatable::PaintFCurves(). So, for a controller to plot a value 'val' at time t it would do the following:

int x = TimeToScreen(t,tzoom,tscroll);

int y = ValueToScreen(dim->Convert(val),rect.h()-1,vzoom,vscroll);

#include <ParamDimension.h>

Inheritance diagram for ParamDimensionBase:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual  ~ParamDimensionBase ()
virtual DimType  DimensionType ()=0
virtual float  Convert (float value)=0
virtual float  UnConvert (float value)=0

Constructor & Destructor Documentation

virtual ~ParamDimensionBase ( ) [inline, virtual]
Remarks:
Destructor.
{}

Member Function Documentation

virtual DimType DimensionType ( ) [pure virtual]
Remarks:
Returns the dimension type of the parameter. See Dimension Types
virtual float Convert ( float  value ) [pure virtual]
Remarks:
When a controller needs to display the parameter values (for example in the function curve editor) it converts the value using this method.
Parameters:
float value

The value to convert.
Returns:
The converted value.
virtual float UnConvert ( float  value ) [pure virtual]
Remarks:
This method is used to un-converted a converted value.
Parameters:
float value

The value to un-convert.
Returns:
The un-converted value.

ParamDimensionBase ParamDimensionBase ParamDimensionBase ParamDimensionBase ParamDimensionBase ParamDimensionBase ParamDimensionBase ParamDimensionBase ParamDimensionBase ParamDimensionBase
ParamDimensionBase ParamDimensionBase ParamDimensionBase ParamDimensionBase ParamDimensionBase ParamDimensionBase ParamDimensionBase ParamDimensionBase ParamDimensionBase ParamDimensionBase