ParamDimension.h

Go to the documentation of this file.

//**************************************************************************/
// Copyright (c) 1998-2006 Autodesk, Inc.
// All rights reserved.
// 
// These coded instructions, statements, and computer programs contain
// unpublished proprietary information written by Autodesk, Inc., and are
// protected by Federal copyright law. They may not be disclosed to third
// parties or copied or duplicated in any form, in whole or in part, without
// the prior written consent of Autodesk, Inc.
//**************************************************************************/
#pragma once
#include "MaxHeap.h"
#include "CoreExport.h"
#include "strbasic.h"

// This must be updated if a new entry is added to DimType!
#define NUM_BUILTIN_DIMS    10

enum DimType {
    DIM_WORLD,
    DIM_ANGLE,
    DIM_COLOR,      //0-1
    DIM_COLOR255,   //0-255
    DIM_PERCENT,    //0-100
    DIM_NORMALIZED, //0-1
    DIM_SEGMENTS,
    DIM_TIME,
    DIM_CUSTOM,
    DIM_NONE
};

// These two classes describe the dimension of a parameter (sub-anim).
// 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 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);
//
class ParamDimensionBase: public MaxHeapOperators {
    public:
        virtual ~ParamDimensionBase() {}
        virtual DimType DimensionType()=0;
        virtual float Convert(float value)=0;
        virtual float UnConvert(float value)=0;
}; 

class ParamDimension : public ParamDimensionBase {
    public:
        // If the DimType is custom than these must be implemented.
        virtual float GetDimScale() {return 1.0f;}
        virtual void SetDimScale() {}
        virtual MCHAR* DimensionName() {return _M("");}     
};

// These point to default implementations for the standard DIM types.
CoreExport extern ParamDimension *defaultDim;
CoreExport extern ParamDimension *stdWorldDim;
CoreExport extern ParamDimension *stdAngleDim;
CoreExport extern ParamDimension *stdColorDim;
CoreExport extern ParamDimension *stdColor255Dim;
CoreExport extern ParamDimension *stdPercentDim;
CoreExport extern ParamDimension *stdNormalizedDim;
CoreExport extern ParamDimension *stdSegmentsDim;
CoreExport extern ParamDimension *stdTimeDim;