VelocityComponent.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_VELOCITYCOMPONENT_H__
#define __I6ENGINE_API_VELOCITYCOMPONENT_H__

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

namespace i6e {
namespace api {

        class ISIXE_MODULES_API VelocityComponent : public Component {
        public:
                enum class MaxSpeedHandling {
                        KeepSpeed,
                        StopAcceleration
                };
                enum class DecelerationHandling {
                        Backward,
                        StopDeceleration
                };

                VelocityComponent(const int64_t id, const attributeMap & params);

                ~VelocityComponent();

                attributeMap synchronize() const override;

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

                std::vector<componentOptions> getComponentOptions() override {
                        return {};
                }

                void accelerate(const Vec3 & acceleration, MaxSpeedHandling handling, const std::function<void(void)> & callback);
                void accelerate(const std::function<void(void)> & callback) {
                        accelerate(_acceleration, _handling, callback);
                }
                
                void decelerate(const Vec3 & deceleration, DecelerationHandling handling, const std::function<void(void)> & callback);
                void decelerate(const std::function<void(void)> & callback) {
                        decelerate(_deceleration, _decelerationHandling, callback);
                }

                void stopAcceleration() const;
                
                void setMaxSpeed(double maxSpeed);
                
                void setResistanceCoefficient(double coeff);
                
                void setWindage(double windage);

                void setDecelerationHandling(DecelerationHandling handling) {
                        _decelerationHandling = handling;
                }

        private:
                Vec3 _acceleration;
                Vec3 _deceleration;
                double _maxSpeed;
                double _resistanceCoefficient;
                double _windage;
                MaxSpeedHandling _handling;
                DecelerationHandling _decelerationHandling;

                void Init() override;

                void Finalize() override;
        };

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

#endif /* __I6ENGINE_API_VELOCITYCOMPONENT_H__ */