ciScenario.h

Go to the documentation of this file.

// Original Author:  Tim George
// Date:       Oct 2005
//
//
//

#if !defined(_CISCENARIO_H_)
#define _CISCENARIO_H_
#include "ciApi.h"

#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000

#include <iostream>
#include <fstream>
#include <string.h>
#include "clXML.h"
#include "clXMLNode.h"

class CI_API ciScenario  
{
public:     // methods

    // getMouseVelocity
    double getMouseVel() { return m_mouseVel; }

    // setMouseVelocity
    void setMouseVel(double rate) { m_mouseVel = rate; }

    // getLogScale
    bool getLogScale() { return m_logScale; }

    void setLogScale( bool logScale ) { m_logScale = logScale; }

    double getTime(){return m_timeOfDay;}

    void setTime(double time){m_timeOfDay = time;}

    double getMouseFOV(){return m_mouseFOV;}

    void setMouseFOV(double mouseFOV){m_mouseFOV = mouseFOV;}

    bool getSceneWindow(){return m_sceneWindow;}

    void setSceneWindow(bool flag){m_sceneWindow = flag;}

    int getActiveSensor(){return m_activeSensor;}

    void setActiveSensor(int sensorID){
        m_activeSensor = sensorID;
    }

    void setActiveRGBSensor(int sensorId, int chan) {
        if((chan >= 0) && (chan <= 3)){
            m_activeRGBSensor[chan] = sensorId;
        }

    };

    int getRGBSensor(int chan) {
        if ((chan < 0) || (chan > 3))
        {

            return m_activeRGBSensor[0];
        }
        else{

            return m_activeRGBSensor[chan];
        }
    };

    void setForceTextures(bool flag){m_forceTextures = flag;}
    bool getForceTextures(){return m_forceTextures;}
    void setReduceMcm(bool flag){m_reduceMcm = flag;}
    bool getReduceMcm(){return m_reduceMcm;}
    void setUseMouse(bool flag){m_useMouse = flag;}
    bool getUseMouse(){return m_useMouse;}
    void setUpdateTextures(bool flag){m_updateTextures = flag;}
    bool getUpdateTextures(){return m_updateTextures;}
    void setPbuffer32F(bool flag){m_pbuffer32F = flag;}
    bool getPbuffer32F(){return m_pbuffer32F;}
    void setUseRGBTexture(bool flag){m_useRGBTextures = flag;}
    bool getUseRGBTexture(){return m_useRGBTextures;}

   void setUseShadows(bool flag){m_useShadows = flag;}
    bool getUseShadows(){return m_useShadows;}
   void setUseLightSources(bool flag){m_useLightSources = flag;}
    bool getUseLightSources(){return m_useLightSources;}
   void setUseLitWindows(bool flag){m_useLitWindows = flag;}
    bool getUseLitWindows(){return m_useLitWindows;}
   void setLitWindowStart(double time){m_litWindowStart = time;}
   double getLitWindowStart(){return m_litWindowStart;}
   void setLitWindowStop(double time){m_litWindowStop = time;}
   double getLitWindowStop(){return m_litWindowStop;}

    // archive
    bool archive(std::ofstream &outf);

    // serialize
    bool serialize(char *filepath);

    //
    // loadXML
    //
    // \par Description:
    // Loads attributes from an XML node
    //
    // \param clXMLNode* scenarioNode
    // \return bool
    //
    bool loadXML(clXMLNode* scenarioNode);

    //
    // parseXML
    //
    // \par Description:
    // Parses an XML document for specific tags
    //
    // \param clXML xmlDocument
    // \return bool
    //
    bool parseXML(clXML& xmlDocument);

    //loadXMLNode
    bool loadXMLNode(std::string tag, char *nodeString);
    //loadXMLNode
    bool loadXMLNode(std::string tag, bool *nodeBool);
    //loadXMLNode
    bool loadXMLNode(std::string tag, int *nodeBool);
    //loadXMLNode
    bool loadXMLNode(std::string tag, double *nodeBool);

    //
    // saveXML
    //
    // \par Description:
    // Saves XML nodes to an XML document
    //
    // \param clXML* xmlDocument
    //
    void saveXML(clXML* xmlDocument);

    // operator =
    ciScenario operator = (ciScenario &obj);

protected:  // methods

public:     // construction/destruction

    // ciTrack
    ciScenario();

    // ciScenario
    ciScenario(ciScenario &obj);

    virtual ~ciScenario();

protected:  // variables

    double  m_timeOfDay;         
    double  m_mouseVel;
    bool m_logScale;
    double  m_mouseFOV;
    bool m_sceneWindow;
    int     m_activeSensor;
    int     m_activeRGBSensor[4];
    double  m_lightLevel;
    bool m_forceTextures;
    bool m_reduceMcm;
    bool m_useMouse;
    bool m_updateTextures;
    bool m_pbuffer32F;
    bool m_useRGBTextures;
   bool m_useShadows;
   bool m_useLightSources;
   bool m_useLitWindows;
   double m_litWindowStart;
   double m_litWindowStop;
    clXMLNode* m_parentNode;
private: // variables

};

#endif // _ciSCENARIO_H_