MoverInterpolateComponent.h

Go to the documentation of this file.

/*
 * i6engine
 * Copyright (2016) Daniel Bonrath, Michael Baer, All rights reserved.
 *
 * This file is part of i6engine; i6engine 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 Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef __I6ENGINE_API_MOVERINTERPOLATECOMPONENT_H__
#define __I6ENGINE_API_MOVERINTERPOLATECOMPONENT_H__

#include "i6engine/math/i6eQuaternion.h"
#include "i6engine/math/i6eVector.h"

#include "i6engine/api/components/MoverComponent.h"

namespace i6e {
namespace api {

        class ISIXE_MODULES_API MoverInterpolateComponent : public MoverComponent {
        public:
                enum class Mode : uint16_t {
                        TWOSTATE_TOGGLE,        // ! loops forward through all keyframes and afterwards backwards. This is repeated endlessly.
                        TWOSTATE_OPENTIME,      // ! same as TWOSTATE_TOGGLE but waits opentime before returning
                        NSTATE_LOOP,            // ! loops through all keyframes (moving from last to first keyframe is interpolated just like all other segments)
                        ONCE                            // ! moves from start to end and stops there
                };

                enum class Way : uint16_t {
                        LINEAR,                 // ! linear interpolation
                        BEZIER                  // ! approximation using bezier-curves
                };

                MoverInterpolateComponent(const int64_t id, const attributeMap & params);
                ~MoverInterpolateComponent();

                void addKeyFrame(const Vec3 & position, const Quaternion & rotation);

                void removeKeyFrame(const uint32_t id);

                inline keyFrame getKeyframe(const uint32_t nth) const {
                        return _keyFrames[nth];
                }

                inline void setMode(const Mode m) { _mode = m; }
                inline void setOpenTime(const uint64_t opentime) {
                        _openTime = opentime;
                }
                inline void setWay(const Way w) { _way = w; }

                inline Way getWay() const { return _way; }

                void start(Vec3 & startPos) override;

                attributeMap synchronize() const override;

                std::string getTemplateName() const override {
                        return "MoverInterpolate";
                }

                void reset() override;

                std::vector<componentOptions> getComponentOptions() override;

        private:
                std::vector<keyFrame> _keyFrames;

                Mode _mode;

                uint64_t _openTime;

                Way _way;

                double _totalDistance;

                double _currentDist;

                size_t _currentFrame;

                bool _direction;

                boost::mutex _lock;

                void News(const GameMessage::Ptr & msg) override;

                void getNewPosition(const uint64_t t, Vec3 & newPos, Quaternion & newRot) override;

                void loadParams(const attributeMap & params) override;

                MoverInterpolateComponent(const MoverInterpolateComponent &) = delete;

                const MoverInterpolateComponent & operator=(const MoverInterpolateComponent &) = delete;
        };

} /* namespace api */
} /* namespace i6e */

#endif /* __I6ENGINE_API_MOVERLINEARCOMPONENT_H__ */