AnimationParams.h

Go to the documentation of this file.

//************************************************************************
//                                  *
//           Copyright (C)  2004                *
//     University Corporation for Atmospheric Research          *
//           All Rights Reserved                *
//                                  *
//************************************************************************/
//
//  File:       AnimationParams.h
//
//  Author:     Alan Norton
//          National Center for Atmospheric Research
//          PO 3000, Boulder, Colorado
//
//  Date:       January 2005
//
//  Description:    Defines the AnimationParams class
//      This is derived from the Params class
//      It contains all the parameters required for animation
 
//
#ifndef ANIMATIONPARAMS_H
#define ANIMATIONPARAMS_H
 
#include <vapor/ParamsBase.h>
 
 
 
class PARAMS_API AnimationParams : public VAPoR::ParamsBase {
public:
    AnimationParams(ParamsBase::StateSave *ssave);
 
    AnimationParams(VAPoR::ParamsBase::StateSave *ssave, VAPoR::XmlNode *node);
 
    virtual ~AnimationParams();
 
    //
    size_t GetCurrentTimestep() const { return (size_t)GetValueLong(_currentTimestepTag, 0); }
 
    //
    void SetCurrentTimestep(size_t ts)
    {
        SetValueLong(_currentTimestepTag, "Set timestep", (long)ts);
    }
 
    //
    size_t GetStartTimestep() const { return (size_t)GetValueLong(_startTimestepTag, 0); }
 
    //
    void SetStartTimestep(size_t ts) { SetValueLong(_startTimestepTag, "Set start timestep", (long)ts); }
 
    //
    size_t GetEndTimestep() const { return (size_t)GetValueLong(_endTimestepTag, (long)0); }
 
    //
    void SetEndTimestep(size_t val) { SetValueLong(_endTimestepTag, "Set end timestep", (long)val); }
 
    //
    bool GetPlayBackwards() const { return GetValueLong(_playBackwardsTag, 0); }
 
    //
    void SetPlayBackwards(bool val) { SetValueLong(_playBackwardsTag, "Set play direction", (long)val); }
 
    //
    size_t GetFrameStepSize() const { return (size_t)GetValueLong(_stepSizeTag, 1); }
 
    //
    void SetFrameStepSize(size_t val) { SetValueLong(_stepSizeTag, "Set frame stepsize", (size_t)val); }
 
    //
    double GetMaxFrameRate() { return GetValueDouble(_maxRateTag, 1.0); }
 
    void SetMaxFrameRate(double rate) { SetValueDouble(_maxRateTag, "Set max frame rate", rate); }
 
    //
    bool GetRepeating() const { return (GetValueLong(_repeatTag, false)); }
 
    //
    void SetRepeating(bool onOff) { SetValueLong(_repeatTag, "enable repeat play", (long)onOff); }
 
    // Get static string identifier for this params class
    //
    static string GetClassType() { return ("AnimationParams"); }
 
public:
    static const string _repeatTag;
    static const string _maxRateTag;
    static const string _stepSizeTag;
    static const string _startTimestepTag;
    static const string _endTimestepTag;
    static const string _playBackwardsTag;
    static const string _currentTimestepTag;
 
private:
    void _init();
};
 
#endif    // ANIMATIONPARAMS_H