| 1 |
/*************************************************************************** |
| 2 |
* Copyright (C) 2005-2019 by the FIFE team * |
| 3 |
* http://www.fifengine.net * |
| 4 |
* This file is part of FIFE. * |
| 5 |
* * |
| 6 |
* FIFE is free software; you can redistribute it and/or * |
| 7 |
* modify it under the terms of the GNU Lesser General Public * |
| 8 |
* License as published by the Free Software Foundation; either * |
| 9 |
* version 2.1 of the License, or (at your option) any later version. * |
| 10 |
* * |
| 11 |
* This library is distributed in the hope that it will be useful, * |
| 12 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of * |
| 13 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * |
| 14 |
* Lesser General Public License for more details. * |
| 15 |
* * |
| 16 |
* You should have received a copy of the GNU Lesser General Public * |
| 17 |
* License along with this library; if not, write to the * |
| 18 |
* Free Software Foundation, Inc., * |
| 19 |
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * |
| 20 |
***************************************************************************/ |
| 21 |
|
| 22 |
#ifndef FIFE_MODEL_METAMODEL_ACTION_H |
| 23 |
#define FIFE_MODEL_METAMODEL_ACTION_H |
| 24 |
|
| 25 |
// Standard C++ library includes |
| 26 |
#include <string> |
| 27 |
#include <vector> |
| 28 |
#include <list> |
| 29 |
|
| 30 |
// 3rd party library includes |
| 31 |
|
| 32 |
// FIFE includes |
| 33 |
// These includes are split up in two parts, separated by one empty line |
| 34 |
// First block: files included from the FIFE root src directory |
| 35 |
// Second block: files included from the same folder |
| 36 |
#include "util/math/angles.h" |
| 37 |
#include "util/base/fifeclass.h" |
| 38 |
|
| 39 |
#include "ivisual.h" |
| 40 |
|
| 41 |
namespace FIFE { |
| 42 |
class ActionAudio; |
| 43 |
|
| 44 |
class Action : public FifeClass { |
| 45 |
public: |
| 46 |
/** Constructor |
| 47 |
* Actions are created by calling addAction from object, thus |
| 48 |
* this method should really be called only by object or test code |
| 49 |
*/ |
| 50 |
Action(const std::string& identifier); |
| 51 |
|
| 52 |
/** Destructor |
| 53 |
*/ |
| 54 |
virtual ~Action(); |
| 55 |
|
| 56 |
/** Get the identifier for this action. |
| 57 |
*/ |
| 58 |
const std::string& getId() { return m_id; } |
| 59 |
|
| 60 |
/** Sets the duration for this action |
| 61 |
*/ |
| 62 |
void setDuration(uint32_t duration) { m_duration = duration; } |
| 63 |
|
| 64 |
/** Gets the duration of this action |
| 65 |
*/ |
| 66 |
uint32_t getDuration() { return m_duration; } |
| 67 |
|
| 68 |
/** Sets visualization to be used. Transfers ownership. |
| 69 |
*/ |
| 70 |
void adoptVisual(IVisual* visual) { m_visual = visual; } |
| 71 |
|
| 72 |
/** Gets used visualization |
| 73 |
*/ |
| 74 |
template<typename T> T* getVisual() const { return reinterpret_cast<T*>(m_visual); } |
| 75 |
|
| 76 |
/** Sets audio to be used. Transfers ownership. |
| 77 |
*/ |
| 78 |
void adoptAudio(ActionAudio* audio) { m_audio = audio; } |
| 79 |
|
| 80 |
/** Gets used audio |
| 81 |
*/ |
| 82 |
ActionAudio* getAudio() const { return m_audio; } |
| 83 |
|
| 84 |
private: |
| 85 |
std::string m_id; |
| 86 |
|
| 87 |
// duration of the action |
| 88 |
uint32_t m_duration; |
| 89 |
// visualization for action |
| 90 |
IVisual* m_visual; |
| 91 |
// audio for action |
| 92 |
ActionAudio* m_audio; |
| 93 |
}; |
| 94 |
|
| 95 |
} |
| 96 |
|
| 97 |
#endif |