VRS - The Virtual Rendering System

version 3.3

camerapathrecorder.h

Go to the documentation of this file.

/******************************************************************************
 * VRS - The Virtual Rendering System
 * Copyright (C) 2000-2004 Computer Graphics Systems Group at the 
 * Hasso-Plattner-Institute (HPI), Potsdam, Germany.
 *
 * This  library  is  free  software; you can redistribute it and/or  modify it
 * under the terms of the GNU Lesser General Public  License  as  published  by
 * the  Free  Software  Foundation;  either  version 2.1 of the License, or (at
 * your option) any later version. This library  is  distributed  in  the  hope
 * that  it will be useful, but  WITHOUT ANY WARRANTY; without even the implied
 * warranty of  MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE.  See  the
 * GNU Lesser General Public License for more details. You should have received
 * a copy of the GNU Lesser+ General Public License along with this library; if
 * not, write to the FreeSoftware Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA, 02111-1307, USA.
 ******************************************************************************/

// $Id: camerapathrecorder.h 6346 2008-05-20 12:56:22Z Sebastian_Pasewaldt $
// $Date: 2008-05-20 14:56:22 +0200 (Tue, 20 May 2008) $
// $Revision: 6346 $
// $State$
// $Author: Sebastian_Pasewaldt $
//
// $Log$
// Revision 1.11  2006/04/21 13:24:07  buchholz
// external access to interpolated views added
//
// Revision 1.10  2006/04/20 13:53:45  buchholz
// added: option to change keyframes from outside
//
// Revision 1.9  2006/04/19 08:24:06  buchholz
// added: pbuffer canvas option
//
// Revision 1.8  2005/09/09 13:54:53  lorenz
// - Added possibility to use a PathNavigation to smooth path in recordVideo
// - Added possibility to export key frame data (e.g. to PathNavigation)
//
// Revision 1.7  2005/01/03 01:43:10  klimetschek
// - modified win32 project layout, splitted vrs.vcproj into vrs_container, vrs_core, vrs_sg, vrs_image, vrs_opengl and vrs_io
// - removed vrs.vcproj
// minor things:
// - added all glutexamples to vrs4glut.sln
// - fixed some problems in glutexamples
// - removed all project references from all VS projects (using solution wide project dependencies instead)
//
// Revision 1.6  2004/12/19 15:26:39  kirsch
// fixed doxygen comments
//
// Revision 1.5  2004/10/28 14:16:01  basch
// Class comment changed (Doxygen style)
//
// Revision 1.4  2004/10/08 14:34:55  buchholz
// video export method added
//
// Revision 1.3  2004/09/20 08:02:44  buchholz
// comment for video recording added
//
// Revision 1.2  2004/08/02 14:09:53  kirsch
// added endline at the end of file
//
// Revision 1.1  2004/06/16 18:09:19  buchholz
// first check-in
//

#ifndef VRS_SG_CAMERAPATHRECORDER_H
#define VRS_SG_CAMERAPATHRECORDER_H

#include <vrs/vector.h>
#include <vrs/time.h>
#include <vrs/sg/behaviornode.h>
#include <vrs/image/avimaker.h>

namespace VRS {

    class LookAt;
    class KeyEvent;
    class TimeEvent;    
    class Canvas;
    template<typename T> class Array;
    class PathNavigation;

        class VRS_CORE_API CameraPathRecorder : public BehaviorNode {

    public:
        CameraPathRecorder(SO<VRS::LookAt> lookAt);

        void setMaxFramesPerSecond(unsigned int frames);
        unsigned int getMaxFramesPerSecond() const;
        
        enum State { OFF, RECORDING, PLAYING };
        VRS_SERIALIZABLE_CLASS_ENUM(State);

        State getState() const;

        void startRecording();
        void startPlaying();
        void stop();
        void savePath(const std::string& fileName);
        void loadPath(const std::string& fileName);
        void enableKeys(unsigned char recordKey, unsigned char playKey, unsigned char stopKey, 
            unsigned char loadKey, unsigned char saveKey, const std::string& file);
        void disableKeys();


        void recordVideo(
            SO<Canvas> canvas, 
            unsigned int frameRate = 25,
            unsigned int width = 800,
            unsigned int height = 600,            
            const std::string& exportDirectory = "", 
            const std::string& exportImageFileName = "image",             
            const std::string& exportImageFormat = ".bmp",
            PathNavigation *pathNavigation = 0,
            VRS::VideoCompressor* compressor = NULL
        );
        void enableVideoExport(
            unsigned char recordKey, 
            SO<Canvas> canvas,
            unsigned int frameRate = 25,
            unsigned int width = 800,
            unsigned int height = 600,
            const std::string& exportDirectory = "", 
            const std::string& exportImageFileName = "image", 
            const std::string& exportImageFormat = ".bmp"
        );
        void disableVideoExport();
        SO<Iterator<Vector> > getKeyPositions() const;
        SO<Iterator<Vector> > getKeyDirections() const;
        SO<Iterator<double> > getKeyTimes() const;


        void setKeyFrames(SO<Iterator<Vector> > keyPositions, SO<Iterator<Vector> > keyDirections, SO<Iterator<double> > keyTimes);

        void setPBufferEnabled(bool yesNo = false);
        bool getPBufferEnabled() const;
        
        bool getInterpolatedView(double elapsedTime, SO<LookAt> target) const;

        VRS_TYPEINFO(CameraPathRecorder, BehaviorNode);
        VRS_SERIALIZABLE(CameraPathRecorder);

    private:

        CameraPathRecorder();

        virtual BehaviorNode::InvalidationHint handle(Event* event);
            // handles user events (timer and keys)
        BehaviorNode::InvalidationHint onTimer(SO<TimeEvent> te);
        BehaviorNode::InvalidationHint onKey(SO<KeyEvent> ke);
        
        State state_;
        unsigned int maxFramesPerSecond_;        
        SO<Array<Vector> > positions_;
        SO<Array<Vector> > directions_;
        SO<Array<double> > times_;
        SO<LookAt> lookAt_;        
        double elapsedTime_;
        unsigned int renderedFrames_;

        bool enableKeys_;
        unsigned char recordKey_;
        unsigned char playKey_;
        unsigned char stopKey_;
        unsigned char loadKey_;
        unsigned char saveKey_;
        std::string fileName_;

        static std::string KeyString;
        static std::string PathHeaderString;

        // video export variables
        bool videoExportKeyEnabled_;
        unsigned int videoFrameRate_;
        unsigned int videoWidth_;
        unsigned int videoHeight_;
        unsigned char videoExportKey_;
        SO<Canvas> canvas_;
        std::string exportDirectory_;
        std::string exportImageFileName_;
        std::string exportImageFormat_;      

        bool m_enablePBuffer;
    };


}

#endif // VRS_SG_CAMERAPATHRECORDER_H

---

Generated on Fri May 18 06:00:13 2012 by Doxygen 1.5.6

© 2001-2010 Hasso-Plattner-Institut | Impressum | Contact