ciMovieMerge.h

Go to the documentation of this file.

// Copyright JRM Enterprises, Inc. 2004
// All rights reserved.
//
// This code is the intellectual property of JRM Enterprises, Inc.
// It may not be used or released as source or compiled binary form
// without the prior written consent of JRM Enterprises, Inc.
//
// Original Author:  Tim George
// Date:       Oct 2005
//
//
//

#if !defined(_CIMOVIEMERGE_H_)
#define _CIMOVIEMERGE_H_

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

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

class CI_API ciMovieMerge  
{
public:     // methods

    //getUsePicture
    bool getUsePicture(){
         if(m_useMovieMerge)    
            return m_usePicture;
        else
            return false;
    }

    //getSaveImages
    bool getSaveImages(){
         if(m_useMovieMerge)    
            return m_saveImages;
        else
            return false;
    }

    //getTerrainVisiblity
    bool getTerrainVisiblity(){
        if(m_useMovieMerge)    
            return m_terrainVisiblity;
        else
            return true;
    }
    //*getImageFileName
    char *getImageFileName(){
        if(m_useMovieMerge)    
            return m_imageFileName;
        else
       return (char *)"";
    }
    //getImageCount
    int getImageCount(){return m_imageCount;} 
    //getPercentContrast
   double getPercentContrast(){return m_percentContrast;}
    //setPercentContrast
   void setPercentContrast(double percent){m_percentContrast = percent;}
    //getPercentContrast
   int getFramerate(){return m_framerate;}
    //setPercentContrast
   void setFramerate(int rate){
        if(rate < 0)
            rate = 1;
        if(rate > 120)
            rate = 120;
        m_framerate = rate;
    }
    
    //setUsePicture
    void setUsePicture(bool usePicture){
        m_usePicture = usePicture;}
    //setSaveImages
    void setSaveImages(bool saveImages){
        m_saveImages = saveImages;}
    //setTerrainVisiblity
    void setTerrainVisiblity(bool terrainVisiblity){m_terrainVisiblity = terrainVisiblity;}
    //setImageFileName
    void setImageFileName(char *imageFileName){strncpy(m_imageFileName, imageFileName, sizeof(m_imageFileName));}
    //setImageCount
    void setImageCount(int imageCount){m_imageCount = imageCount;}
    //setTargetEntity
    void setTargetEntity(int targetEntity){m_targetEntity = targetEntity;}
    //getTargetEntity
    int getTargetEntity(){return m_targetEntity;}

    //getUseMovieMerge
   bool getUseMovieMerge() { return m_useMovieMerge; }

    //setUseMovieMerge
   void setUseMovieMerge(bool flag) { m_useMovieMerge = flag; }
    
    int getStartImageNum() { return m_startImageNum; }

    void setStartImageNum(int num) { m_startImageNum = num; }
    
    // archive
    bool archive(std::ofstream &outf);

    // serialize
    bool serialize(char *filepath);

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

    //
    // 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 =
    ciMovieMerge operator = (ciMovieMerge &obj);

protected:  // methods

public:     // construction/destruction

    // ciTrack
    ciMovieMerge();

    // ciTrack
    ciMovieMerge(ciMovieMerge &obj);

    //~ciMovieMerge
    virtual ~ciMovieMerge();



protected:  // variables
    bool m_terrainVisiblity;
    char m_imageFileName[256];
    int m_imageCount;
    bool m_usePicture;
    bool m_saveImages;
    int m_targetEntity;
    double m_percentContrast;
    int m_framerate;
    clXMLNode* m_parentNode;
    bool m_useMovieMerge;
    int m_startImageNum;
private: // variables

};

#endif // _ciTRACK_H_