VRS - The Virtual Rendering System

version 3.3

bookmarknavigation.h

Go to the documentation of this file.

/******************************************************************************
 * VRS - The Virtual Rendering System
 * Copyright (C) 2000-2005 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: bookmarknavigation.h 6422 2008-07-03 11:57:51Z Stefan_Maass $

#ifndef VRS_SG_BOOKMARKNAVIGATION_H
#define VRS_SG_BOOKMARKNAVIGATION_H

#include <vrs/sg/interactiontechnique.h>

namespace VRS {

class DirectionInterpolator;

class VRS_CORE_API BookmarkNavigation : public InteractionTechnique {

public:
    BookmarkNavigation(double duration = 6.0);    

    static InteractionTechnique::KeyFunctionID getStoreKeyID(int i);
    static InteractionTechnique::KeyFunctionID getActivationKeyID(int i);
    
    void setBookmarkKeys(
        SO<Iterator<unsigned int> > storeKeys               = NULL, 
        SO<Iterator<unsigned int> > activationKeys          = NULL,
        InputEvent::Modifier storeKeyMustModifier           = InputEvent::Ctrl,
        InputEvent::Modifier activationKeyMustModifier      = InputEvent::NoModifier,
        InputEvent::Modifier storeKeyMustNotModifier        = InputEvent::AllKeys,
        InputEvent::Modifier activationKeyMustNotModifier   = InputEvent::AllKeys
    );

    void initPath(const Vector& endPos, const Vector& endDir, bool accelerate = true, bool decelerate = true);
        
    void initMultiStepPath(SO<Array<Vector> > positions, SO<Array<Vector> > directions);

        enum PathStyle {
                LookInFlightDirection, 
                LookAtTarget,          
        Simple                 
        };

        void setPathStyle(PathStyle pathStyle);

        PathStyle getPathStyle() const;
        
    void setDuration(double duration);
        
        double getDuration() const;
        
    bool pathActive() const;
    
    void stopPath();
    
    void savePath(const std::string& fileName);
    void loadPath(const std::string& fileName);
    
    static const InteractionTechnique::KeyFunctionID LoadKey;
    static const InteractionTechnique::KeyFunctionID SaveKey;
    void setBookmarkFilename(const std::string& filename);
    const std::string& getBookmarkFilename() const;        

    virtual void onDeactivation();

    void setStopOnDeactivation(bool stop);
    bool stopOnDeactivation() const;

    VRS_TYPEINFO(BookmarkNavigation, InteractionTechnique);
    VRS_SERIALIZABLE(BookmarkNavigation);

private:    
    
    virtual void onKey(SO<KeyEvent> event, KeyFunctionID id);  
    virtual void onTimer(SO<VRS::TimeEvent> event, double secondsSinceLastTimeEvent);
    
    SO<Array<bool> > m_targetStored;
    SO<Array<Vector> > m_targetPos;
    SO<Array<Vector> > m_targetDir;

    double m_duration;
    PathStyle m_pathStyle;

    // initialized for each navigation
    SO<DirectionInterpolator> m_interpol;
    bool m_active;                  
    Vector m_currentTargetPos;
    Vector m_currentTargetDir;     
    Vector m_currentStartPos;
    bool m_accelerate;
    bool m_decelerate;
    double m_progress;
    bool m_stopOnDeactivation;
    
    // for loading and saving the path as ASCII
    static std::string KeyString;
    static std::string PathHeaderString;
    std::string m_pathASCIIFileName;
    
    // for multi step paths
    bool m_multiStepPath;
    SO<Array<Vector> > m_multiStepPositions;
    SO<Array<Vector> > m_multiStepDirections;
    unsigned int m_currentStep;
};

} // namespace VRS

#endif // VRS_SG_BOOKMARKNAVIGATION_H

---

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

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