src/CameraObject.hh

/*
 * Copyright Staffan Gimåker 2006-2007, 2009-2010.
 * Copyright Anders Boberg 2006-2007.
 *
 * ---
 *
 * This file is part of peekabot.
 *
 * peekabot 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 3 of the License, or
 * (at your option) any later version.
 *
 * peekabot 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, see <http://www.gnu.org/licenses/>.
 */

#ifndef PEEKABOT_CAMERA_OBJECT_HH_INCLUDED
#define PEEKABOT_CAMERA_OBJECT_HH_INCLUDED


#include "Types.hh"
#include "SceneObject.hh"
#include "HandlerInformer.hh"

#include <Eigen/Core>


namespace peekabot
{
    class CameraObject : public SceneObject
    {
    public:
        CameraObject();

        CameraObject(ScopedHandler* handler) throw();

        bool set_fov(float fov);

        float get_fov() const throw();

        void set_orthographic(bool enable);

        bool is_orthographic() const throw();

        virtual void accept(ObjectVisitor* visitor) throw();

        virtual ObjectType get_object_type() const;

        void set_zoom_distance(float zoom_distance) throw();

        float get_zoom_distance() const throw();

        void set_near_plane(float y_distance) throw();

        float get_near_plane() const throw();

        void set_far_plane(float y_distance) throw();

        float get_far_plane() const throw();

        inline const Eigen::Vector4f get_view_vector() const throw()
        {
            return get_transformation().matrix().col(0);
        }

        inline const Eigen::Vector4f get_up_vector() const throw()
        {
            return get_transformation().matrix().col(2);
        }


        typedef boost::signals2::signal<void ()> OrthoSetsignal;

        typedef boost::signals2::signal<void ()> FovSetSignal;

        typedef boost::signals2::signal<void ()> ZoomDistanceSetSignal;

        typedef boost::signals2::signal<void ()> NearPlaneSetSignal;

        typedef boost::signals2::signal<void ()> FarPlaneSetSignal;

        // ---

        inline OrthoSetsignal &ortho_set_signal() const
        {
            return m_ortho_set_signal;
        }

        inline FovSetSignal &fov_set_signal() const
        {
            return m_fov_set_signal;
        }

        inline ZoomDistanceSetSignal &zoom_distance_set_signal() const
        {
            return m_zoom_distance_set_signal;
        }

        inline NearPlaneSetSignal &near_plane_set_signal() const
        {
            return m_near_plane_set_signal;
        }

        inline FarPlaneSetSignal &far_plane_set_signal() const
        {
            return m_far_plane_set_signal;
        }


    protected:
        virtual PropMap &get_prop_adapters();

    private:
        static void create_prop_adapters(PropMap &adapters);


        static void start_handler(
            const std::string & name,
            XMLHandler::AttributeMap &attributes,
            ScopedHandler *handler) throw();

        void orthographic_start_handler(
            const std::string & name,
            XMLHandler::AttributeMap &attributes,
            ScopedHandler *handler) throw();

        void fov_start_handler(
            const std::string & name,
            XMLHandler::AttributeMap &attributes,
            ScopedHandler *handler) throw();

        void fov_value_start_handler(
            const std::string & name,
            XMLHandler::AttributeMap &attributes,
            ScopedHandler *handler,
            bool value_in_degrees) throw();

        void fov_value_cdata_handler(
            const std::string &cdata,
            ScopedHandler *handler,
            bool value_in_degrees) throw();


    private:
        float m_fov;

        bool m_is_orthographic;

        float m_near;

        float m_far;

        float m_zoom_distance;

        static HandlerInformer ms_handler_informer;

        mutable OrthoSetsignal m_ortho_set_signal;
        mutable FovSetSignal m_fov_set_signal;
        mutable ZoomDistanceSetSignal m_zoom_distance_set_signal;
        mutable NearPlaneSetSignal m_near_plane_set_signal;
        mutable FarPlaneSetSignal m_far_plane_set_signal;
    };
}


#endif // PEEKABOT_CAMERA_OBJECT_HH_INCLUDED