manipulatedCameraFrame.h

/****************************************************************************

 Copyright (C) 2002-2013 Gilles Debunne. All rights reserved.

 This file is part of the QGLViewer library version 2.5.2.

 http://www.libqglviewer.com - contact@libqglviewer.com

 This file may be used under the terms of the GNU General Public License 
 versions 2.0 or 3.0 as published by the Free Software Foundation and
 appearing in the LICENSE file included in the packaging of this file.
 In addition, as a special exception, Gilles Debunne gives you certain 
 additional rights, described in the file GPL_EXCEPTION in this package.

 libQGLViewer uses dual licensing. Commercial/proprietary software must
 purchase a libQGLViewer Commercial License.

 This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

*****************************************************************************/

#ifndef QGLVIEWER_MANIPULATED_CAMERA_FRAME_H
#define QGLVIEWER_MANIPULATED_CAMERA_FRAME_H

#include "manipulatedFrame.h"

namespace qglviewer {
class QGLVIEWER_EXPORT ManipulatedCameraFrame : public ManipulatedFrame
{
#ifndef DOXYGEN
    friend class Camera;
    friend class ::QGLViewer;
#endif

    Q_OBJECT

public:
    ManipulatedCameraFrame();
    virtual ~ManipulatedCameraFrame() {}

    ManipulatedCameraFrame(const ManipulatedCameraFrame& mcf);
    ManipulatedCameraFrame& operator=(const ManipulatedCameraFrame& mcf);

public:
    Vec pivotPoint() const { return pivotPoint_; }
    void setPivotPoint(const Vec& point) { pivotPoint_ = point; }

#ifndef DOXYGEN
    Vec revolveAroundPoint() const { qWarning("revolveAroundPoint() is deprecated, use pivotPoint() instead"); return  pivotPoint(); }
    void setRevolveArountPoint(const Vec& point) { qWarning("setRevolveAroundPoint() is deprecated, use setPivotPoint() instead"); setPivotPoint(point); }
#endif


public:
    bool rotatesAroundUpVector() const { return rotatesAroundUpVector_; }
    void setRotatesAroundUpVector(bool constrained) { rotatesAroundUpVector_ = constrained; }

    bool zoomsOnPivotPoint() const { return zoomsOnPivotPoint_; }
    void setZoomsOnPivotPoint(bool enabled) { zoomsOnPivotPoint_ = enabled; }

private:
#ifndef DOXYGEN
    void zoom(float delta, const Camera * const camera);
#endif


public Q_SLOTS:
    void setFlySpeed(float speed) { flySpeed_ = speed; }

    void setSceneUpVector(const Vec& up) { sceneUpVector_ = up; }

public:
    float flySpeed() const { return flySpeed_; }

    Vec sceneUpVector() const { return sceneUpVector_; }

#ifndef DOXYGEN
    Vec flyUpVector() const;
    void setFlyUpVector(const Vec& up);
#endif


protected:
    virtual void mouseReleaseEvent(QMouseEvent* const event, Camera* const camera);
    virtual void mouseMoveEvent   (QMouseEvent* const event, Camera* const camera);
    virtual void wheelEvent       (QWheelEvent* const event, Camera* const camera);

protected Q_SLOTS:
    virtual void spin();

public:
    virtual QDomElement domElement(const QString& name, QDomDocument& document) const;
public Q_SLOTS:
    virtual void initFromDOMElement(const QDomElement& element);

#ifndef DOXYGEN
protected:
    virtual void startAction(int ma, bool withConstraint=true); // int is really a QGLViewer::MouseAction
#endif

private Q_SLOTS:
    virtual void flyUpdate();

private:
    void updateSceneUpVector();
    Quaternion turnQuaternion(int x, const Camera* const camera);
    Quaternion pitchYawQuaternion(int x, int y, const Camera* const camera);

private:
    // Fly mode data
    float flySpeed_;
    float driveSpeed_;
    Vec sceneUpVector_;
    QTimer flyTimer_;

    bool rotatesAroundUpVector_;
    // Inverse the direction of an horizontal mouse motion. Depends on the projected
    // screen orientation of the vertical axis when the mouse button is pressed.
    bool constrainedRotationIsReversed_;

    bool zoomsOnPivotPoint_;

    Vec pivotPoint_;
};

} // namespace qglviewer

#endif // QGLVIEWER_MANIPULATED_CAMERA_FRAME_H