/home/kitware/dashboards/avogadro/libavogadro/src/camera.h

/**********************************************************************
  Camera - Class for representing the view.

  Copyright (c) 2007-2008 Benoit Jacob
  Copyright (c) 2007 Donald Ephraim Curtis
  Copyright (c) 2007 Carsten Niehaus
  Copyright (c) 2007-2008 Marcus D. Hanwell
  Copyright (c) 2007-2009 Geoff Hutchison
        Copyright (C) 2011 David C. Lonie

  This file is part of the Avogadro molecular editor project.
  For more information, see <http://avogadro.openmolecules.net/>

  Avogadro is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  Avogadro 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 General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  02110-1301, USA.
 **********************************************************************/

#ifndef CAMERA_H
#define CAMERA_H

#include <avogadro/global.h>
#include <Eigen/Geometry>
#include <QPoint>

namespace Avogadro {

  class GLWidget;

  class CameraPrivate;
  class A_EXPORT Camera
  {
    protected:
      friend class GLWidget;
      void setParent(const GLWidget *glwidget);

    public:
      explicit Camera(const GLWidget *parent = 0, double angleOfViewY = 40.0);
      virtual ~Camera();
      Camera(const Camera *camera);
      const GLWidget *parent() const;
      void setAngleOfViewY(double angleOfViewY);
      double angleOfViewY() const;
      void setModelview(const Eigen::Transform3d &matrix);
      const Eigen::Transform3d & modelview() const;
      Eigen::Transform3d & modelview();
      void applyPerspective() const;
      void applyProjection() const;
      void applyModelview() const;
      void initializeViewPoint();
      double distance(const Eigen::Vector3d & point) const;
      void translate(const Eigen::Vector3d &vector);
      void pretranslate(const Eigen::Vector3d &vector);
      void rotate(const double &angle, const Eigen::Vector3d &axis);
      void prerotate(const double &angle, const Eigen::Vector3d &axis);

      void scale(double coefficient);

      Eigen::Vector3d unProject(const Eigen::Vector3d& v) const;

      Eigen::Vector3d unProject(const QPoint& p, const Eigen::Vector3d& ref) const;

      Eigen::Vector3d unProject(const QPoint& p) const;

      Eigen::Vector3d project(const Eigen::Vector3d& v) const;

      Eigen::Vector3d backTransformedXAxis() const;

      Eigen::Vector3d backTransformedYAxis() const;

      Eigen::Vector3d backTransformedZAxis() const;

      Eigen::Vector3d transformedXAxis() const;

      Eigen::Vector3d transformedYAxis() const;

      Eigen::Vector3d transformedZAxis() const;

      bool nearClippingPlane(Eigen::Vector3d *normal, Eigen::Vector3d *point);

      void normalize();

      double scalingCoefficient();

    private:
      CameraPrivate * const d;

      Eigen::Vector3d V4toV3DivW(const Eigen::Vector4d & v4) {
        return v4.start<3>()/v4.w();
      }
  };

} // end namespace Avogadro

#endif // __CAMERA_H