src/SceneObject.hh

/*
 * Copyright Staffan Gimåker 2006-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_SCENE_OBJECT_HH_INCLUDED
#define PEEKABOT_SCENE_OBJECT_HH_INCLUDED


#include <utility>
#include <string>
#include <stdexcept>
#include <set>
#include <boost/signals2.hpp>
#include <Eigen/Core>
#include <Eigen/Geometry>
#include <boost/bimap.hpp>
#include <boost/cstdint.hpp>

#include "Types.hh"
#include "XMLHandler.hh"
#include "Any.hh"
#include "PropMap.hh"


namespace peekabot
{
    class SceneObject;
    class ObjectVisitor;
    class ScopedHandler;
    class Prop;

    class SceneObject
    {
    public:
        class ChildNotFound : public std::runtime_error
        {
        public:
            ChildNotFound(const std::string &name)
                : std::runtime_error("Child '" + name + "' not found") {}
        };



        SceneObject(const std::string &default_name);

        SceneObject(const std::string &default_name, ScopedHandler *handler);

        virtual ~SceneObject();

        inline const Eigen::Transform3f &get_mtow() const throw()
        {
            return m_mtow;
        }

        inline const Eigen::Transform3f &get_parent_mtow() const throw()
        {
            return m_parent ? m_parent->get_mtow() : get_mtow();
        }

        void detach();

        void rearrange(SceneObject *new_parent, bool retain_mtow);

        bool is_descendant(SceneObject *object) const throw();

        SceneObject *get_parent() throw();

        const SceneObject *get_parent() const throw();

        typedef std::set<SceneObject *> Children;
        typedef Children::iterator ChildIterator;
        typedef Children::const_iterator ConstChildIterator;

        Children &get_children() throw();

        const Children &get_children() const throw();

        ChildIterator begin();

        ChildIterator end();

        ConstChildIterator begin() const;

        ConstChildIterator end() const;

        void clear();

        SceneObject *get_child(const std::string &name)
            throw(ChildNotFound);

        const SceneObject *get_child(const std::string &name)
            const throw(ChildNotFound);

        bool has_child(const std::string &name) const throw();

        bool has_descendent(const std::string &rel_path) const throw();

        SceneObject *get_descendent(const std::string &rel_path)
            throw(std::runtime_error);

        const SceneObject *get_descendent(const std::string &rel_path)
            const throw(std::runtime_error);

        std::size_t child_count() const throw();

        ObjectID get_object_id() const throw();

        bool attach(SceneObject *subtree,
                    NameConflictPolicy conflict_policy = FAIL_ON_CONFLICT)
            throw(std::runtime_error);

        boost::uint8_t get_layer() const throw();

        void set_layer(boost::uint8_t layer);

        const std::string &get_name() const throw();

        void set_name(const std::string &name);

        float get_opacity() const throw();

        void set_opacity(float opacity);

        void set_hidden(bool hidden);

        bool is_hidden() const throw();

        bool is_visible() const throw();

        float get_accumulated_opacity() const throw();

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

        virtual ObjectType get_object_type() const = 0;

        inline const Eigen::Transform3f &get_transformation() const throw()
        {
            return m_mtop;
        }

        void set_transformation(
            const Eigen::Transform3f &m,
            CoordinateSystem system = PARENT_COORDINATES);

        void apply_transformation(const Eigen::Transform3f &transform) throw();

        void set_position(const Eigen::Vector3f &pos) throw();

        void set_world_position(const Eigen::Vector3f &pos) throw();

        void set_rpy(
            float roll, float pitch, float yaw,
            CoordinateSystem system);

        void rotate(const Eigen::Vector3f &axis, float angle);

        void rotate_x(float angle) throw();

        void rotate_y(float angle) throw();

        void rotate_z(float angle) throw();

        void set_orientation(
            const Eigen::Vector3f &v, CoordinateSystem system);

        void set_color(const RGBColor &color, bool recursive = false);

        RGBColor get_color() const throw();

        void set_selected(bool select);

        bool is_selected() const throw();

        bool has_selected_ancestor() const throw();


        typedef PropMap::iterator PropIterator;
        typedef PropMap::const_iterator ConstPropIterator;

        Prop *get_prop(PropKey key);

        const Prop *get_prop(PropKey key) const;

        Any get_prop_value(PropKey key) const;

        void set_prop_value(PropKey key, const Any &val);

        template<typename T> inline
        T get_prop_value(PropKey key) const
        {
            return any_cast<T>(get_prop_value(key));
        }

        template<typename T> inline
        void set_prop_value(PropKey key, const T &val)
        {
            return set_prop_value(key, Any(val));
        }

        std::size_t prop_adapter_count() const;

        PropIterator prop_adapters_begin();

        ConstPropIterator prop_adapters_begin() const;

        PropIterator prop_adapters_end();

        ConstPropIterator prop_adapters_end() const;

        std::size_t prop_count() const;

        PropIterator props_begin();

        ConstPropIterator props_begin() const;

        PropIterator props_end();

        ConstPropIterator props_end() const;

        void erase_prop(PropKey key);

        void erase_prop(PropIterator it);

        bool has_prop(PropKey key) const;

        PropKey get_prop_key(const std::string &name) const;

        PropKey add_prop(const std::string &name, Prop *prop);

        const std::string &get_prop_name(PropKey key) const;


        typedef boost::signals2::signal<void (
            PropKey, Prop *)> PropAddedSignal;

        typedef boost::signals2::signal<void (
            PropKey, Prop *)> PropErasedSignal;

        typedef boost::signals2::signal<void (
            SceneObject *child)> ChildAttachedSignal;

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

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

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

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

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

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

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

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

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

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

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

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

        // ---

        inline PropAddedSignal &prop_added_signal() const
        {
            return m_prop_added_signal;
        }

        inline PropErasedSignal &prop_erased_signal() const
        {
            return m_prop_erased_signal;
        }

        inline ChildAttachedSignal &child_attached_signal() const
        {
            return m_child_attached_signal;
        }

        inline DetachedSignal &detached_signal() const
        {
            return m_detached_signal;
        }

        inline TransformationSetSignal &transformation_set_signal() const
        {
            return m_transformation_set_signal;
        }

        inline NameSetSignal &name_set_signal() const
        {
            return m_name_set_signal;
        }

        inline LayerSetSignal &layer_set_signal() const
        {
            return m_layer_set_signal;
        }

        inline OpacitySetSignal &opacity_set_signal() const
        {
            return m_opacity_set_signal;
        }

        inline ColorSetSignal &color_set_signal() const
        {
            return m_color_set_signal;
        }

        inline HiddenSetSignal &hidden_set_signal() const
        {
            return m_hidden_set_signal;
        }

        inline AccumOpacityChangedSignal &accum_opacity_changed_signal() const
        {
            return m_accum_opacity_changed_signal;
        }

        inline MtowChangedSignal &mtow_changed_signal() const
        {
            return m_mtow_changed_signal;
        }

        inline VisibilityChangedSignal &visibility_changed_signal() const
        {
            return m_visibility_changed_signal;
        }

        inline SelectedSetSignal &selected_set_signal() const
        {
            return m_selected_set_signal;
        }

        inline HasSelectedAncestorChangedSignal &
        has_selected_ancestor_changed_signal() const
        {
            return m_has_selected_ancestor_changed_signal;
        }


    private:
        void recalc_mtows();

        void recalc_visibility();

        void orthonormalize_transform() throw();

        SceneObject *_get_descendent(
            const std::vector<std::string>::const_iterator first,
            const std::vector<std::string>::const_iterator last) throw();

        const SceneObject *_get_descendent(
            const std::vector<std::string>::const_iterator first,
            const std::vector<std::string>::const_iterator last) const throw();

        static void create_prop_adapters(PropMap &adapters);

    protected:
        virtual PropMap &get_prop_adapters();

        const PropMap &get_prop_adapters() const;

        static void merge_prop_adapters(PropMap &to, const PropMap &from);


        void end_handler(
            const std::string &name,
            ScopedHandler *handler) throw(std::runtime_error);

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

        void name_cdata_handler(
            const std::string &cdata,
            ScopedHandler *handler) throw(std::runtime_error);

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

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

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

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

        void transform_end_handler(
            const std::string &name, ScopedHandler *handler) throw();

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

        void rotate_cdata_handler(
            boost::uint32_t tag,
            CoordinateSystem system,
            const std::string &cdata,
            ScopedHandler *handler) throw();

        void rotate_end_handler(
            const std::string &name, ScopedHandler *handler) throw();

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

        void translate_cdata_handler(
            CoordinateSystem system,
            const std::string &cdata,
            ScopedHandler *handler) throw();

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

        void matrix_cdata_handler(
            CoordinateSystem system,
            const std::string &cdata,
            ScopedHandler *handler) throw();

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


        //
        // ----------------------- Members ---------------------------
        //

    private:
        PropMap m_props;

        typedef boost::bimap<PropKey, std::string> PropNames;
        static PropNames ms_prop_names;

        static PropKey ms_next_prop_key;

        static ObjectID ms_next_object_id;

        bool m_is_hidden;

        bool m_is_visible;

        SceneObject *m_parent;

        boost::uint8_t m_layer;

        float m_opacity;

        std::string m_name;

        ObjectID m_id;

        int m_transforms_since_normalization;

        RGBColor m_color;

        Children m_children;

        Eigen::Transform3f m_mtop;

        Eigen::Transform3f m_mtow;

        bool m_is_selected;


        mutable PropAddedSignal m_prop_added_signal;
        mutable PropErasedSignal m_prop_erased_signal;
        mutable ChildAttachedSignal m_child_attached_signal;
        mutable DetachedSignal m_detached_signal;
        mutable TransformationSetSignal m_transformation_set_signal;
        mutable NameSetSignal m_name_set_signal;
        mutable LayerSetSignal m_layer_set_signal;
        mutable OpacitySetSignal m_opacity_set_signal;
        mutable ColorSetSignal m_color_set_signal;
        mutable HiddenSetSignal m_hidden_set_signal;
        mutable AccumOpacityChangedSignal m_accum_opacity_changed_signal;
        mutable MtowChangedSignal m_mtow_changed_signal;
        mutable VisibilityChangedSignal m_visibility_changed_signal;
        mutable SelectedSetSignal m_selected_set_signal;
        mutable HasSelectedAncestorChangedSignal m_has_selected_ancestor_changed_signal;
    };
}

#endif // PEEKABOT_SCENE_OBJECT_HH_INCLUDED