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 "params.h"
#include <vapor/common.h>
#include "viewpointparams.h"
#include "command.h"


namespace VAPoR {
class ExpatParseMgr;

class XmlNode;
class ParamNode;

class PARAMS_API AnimationParams : public Params {
    
public: 

    long getCurrentTimestep() {
        return GetValueLong(_currentTimestepTag);
    }
    int setCurrentTimestep(long ts) {
        int rc = SetValueLong(_currentTimestepTag,"Set timestep",ts);
        return rc;
    }

    int getStartTimestep() {
        return GetValueLong(_startTimestepTag);
    }
    int setStartTimestep(int ts) {
        int rc= SetValueLong(_startTimestepTag,"Set start timestep",ts);
        return rc;
    }

    int getEndTimestep() {
        return GetValueLong(_endTimestepTag);
    }
    int setEndTimestep(int val) {
        
        return SetValueLong(_endTimestepTag,"Set end timestep",val);
    }

    int getMinTimestep() {
        return GetValueLong(_minTimestepTag);
    }
    int setMinTimestep(int val) {
        
        return SetValueLong(_minTimestepTag,"Set min timestep",val);
    }
    int getMaxTimestep() {
        return GetValueLong(_maxTimestepTag);
    }

    int setMaxTimestep(int val) {
        return SetValueLong(_maxTimestepTag,"Set max timestep",val);
    }

    int getPlayDirection() {
        return GetValueLong(_playDirectionTag);
    }

    int setPlayDirection(int val) {
        return SetValueLong(_playDirectionTag,"Set play direction",val);
    }
    int getFrameStepSize() {
        return GetValueLong(_stepSizeTag);
    }
    int setFrameStepSize(int val) {
        return SetValueLong(_stepSizeTag,"Set frame stepsize",val);
    }
    double getMaxFrameRate() {
        return GetValueDouble(_maxRateTag);
    }
    int setMaxFrameRate(double rate) {
        return SetValueDouble(_maxRateTag,"Set max frame rate",rate);
    }
    bool isRepeating() {
        return (GetValueLong(_repeatTag) != 0);
    }
    int setRepeating(bool onOff){
        return SetValueLong(_repeatTag,"enable repeat play",(long)onOff);
    }
    
    int getMinTimeToRender() {return ((int)(1000.f/getMaxFrameRate()) );}

    int SetCaptureEnabled(bool val) {
        return SetValueLong(_captureEnabledTag, "Toggle capture enabled", (long)val);
    }
    bool GetCaptureEnabled() {
        return (GetValueLong(_captureEnabledTag) != 0);
    }
    int SetCaptureFilepath(string path){
        return SetValueString(_capturePathTag, "Set capture file path", path);
    }
    string GetCaptureFilepath(){
        return GetValueString(_capturePathTag);
    }

    AnimationParams(XmlNode* parent, int winnum);
    ~AnimationParams();


    //The following are not part of the public API
#ifndef DOXYGEN_SKIP_THIS
    virtual void Validate(int type);
    virtual void restart();
    const std::string getShortName() {return _shortName;}
    static ParamsBase* CreateDefaultInstance() {return new AnimationParams(0,-1);}

    //When rendering is finished, renderer calls this.  Returns true no change (if the change bit
    //needs to be set. 
    //It advances the currentFrame to the next one
    bool advanceFrame();

    //set to pause if last frame is done, return true if done.
    bool checkLastFrame();
    int getNextFrame(int dir); //Determine the next frame in the specified direction
    
    
private:
    
    static const string _shortName;
    static const string _repeatTag;
    static const string _maxRateTag;
    static const string _stepSizeTag;
    static const string _startTimestepTag;
    static const string _endTimestepTag;
    static const string _minTimestepTag;
    static const string _maxTimestepTag;
    static const string _playDirectionTag;
    static const string _currentTimestepTag;
    static const string _capturePathTag;
    static const string _captureEnabledTag;
    

#endif /* DOXYGEN_SKIP_THIS */
    
};

};

#endif //ANIMATIONPARAMS_H