action.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005-2019 by the FIFE team                              *
 *   http://www.fifengine.net                                              *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE 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 FIFE_MODEL_METAMODEL_ACTION_H
#define FIFE_MODEL_METAMODEL_ACTION_H

// Standard C++ library includes
#include <string>
#include <vector>
#include <list>

// 3rd party library includes

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder
#include "util/math/angles.h"
#include "util/base/fifeclass.h"

#include "ivisual.h"

namespace FIFE {
    class ActionAudio;

    class Action : public FifeClass {
    public:
        Action(const std::string& identifier);

        virtual ~Action();

        const std::string& getId() { return m_id; }

        void setDuration(uint32_t duration) { m_duration = duration; }

        uint32_t getDuration() { return m_duration; }

        void adoptVisual(IVisual* visual) { m_visual = visual; }

        template<typename T> T* getVisual() const { return reinterpret_cast<T*>(m_visual); }

        void adoptAudio(ActionAudio* audio) { m_audio = audio; }

        ActionAudio* getAudio() const { return m_audio; }

    private:
        std::string m_id;

        // duration of the action
        uint32_t m_duration;
        // visualization for action
        IVisual* m_visual;
        // audio for action
        ActionAudio* m_audio;
    };

}

#endif