mirror of
https://github.com/4ian/GDevelop.git
synced 2025-10-15 10:19:04 +00:00
126 lines
3.0 KiB
C++
126 lines
3.0 KiB
C++
/*
|
|
* GDevelop Core
|
|
* Copyright 2008-2016 Florian Rival (Florian.Rival@gmail.com). All rights
|
|
* reserved. This project is released under the MIT License.
|
|
*/
|
|
#ifndef GDCORE_EFFECTS_CONTAINER_H
|
|
#define GDCORE_EFFECTS_CONTAINER_H
|
|
#include <memory>
|
|
#include <vector>
|
|
#include <algorithm>
|
|
|
|
#include "GDCore/String.h"
|
|
|
|
namespace gd {
|
|
class Effect;
|
|
}
|
|
namespace gd {
|
|
class SerializerElement;
|
|
}
|
|
|
|
namespace gd {
|
|
|
|
/**
|
|
* \brief Contains effects applied to an entity on screen (i.e: a Layer or an
|
|
* Object).
|
|
*
|
|
* \ingroup PlatformDefinition
|
|
*/
|
|
class GD_CORE_API EffectsContainer {
|
|
public:
|
|
EffectsContainer();
|
|
EffectsContainer(const EffectsContainer& other);
|
|
virtual ~EffectsContainer(){};
|
|
|
|
EffectsContainer& operator=(const EffectsContainer& rhs);
|
|
/**
|
|
* \brief Return true if the effect called "name" exists.
|
|
*/
|
|
bool HasEffectNamed(const gd::String& name) const;
|
|
|
|
/**
|
|
* \brief Return a reference to the effect called "name".
|
|
*/
|
|
Effect& GetEffect(const gd::String& name);
|
|
|
|
/**
|
|
* \brief Return a reference to the effect called "name".
|
|
*/
|
|
const Effect& GetEffect(const gd::String& name) const;
|
|
|
|
/**
|
|
* Return a reference to the effect at position "index" in the effects list
|
|
*/
|
|
Effect& GetEffect(std::size_t index);
|
|
|
|
/**
|
|
* Return a reference to the effect at position "index" in the effects list
|
|
*/
|
|
const Effect& GetEffect(std::size_t index) const;
|
|
|
|
/**
|
|
* Return the position of the effect called "name" in the effects list
|
|
*/
|
|
std::size_t GetEffectPosition(const gd::String& name) const;
|
|
|
|
/**
|
|
* Return the number of effects.
|
|
*/
|
|
std::size_t GetEffectsCount() const;
|
|
|
|
/**
|
|
* Add a new effect at the specified position in the effects list.
|
|
*/
|
|
gd::Effect& InsertNewEffect(const gd::String& name, std::size_t position);
|
|
|
|
/**
|
|
* \brief Add a copy of the specified effect in the effects list.
|
|
*
|
|
* \note No pointer or reference must be kept on the effect passed as
|
|
* parameter.
|
|
*
|
|
* \param theEffect The effect that must be copied and inserted
|
|
* into the effects list
|
|
* \param position Insertion position.
|
|
*/
|
|
void InsertEffect(const Effect& theEffect, std::size_t position);
|
|
|
|
/**
|
|
* Remove the specified effect.
|
|
*/
|
|
void RemoveEffect(const gd::String& name);
|
|
|
|
/**
|
|
* \brief Move the specified effect at a new position in the list.
|
|
*/
|
|
void MoveEffect(std::size_t oldIndex, std::size_t newIndex);
|
|
|
|
/**
|
|
* Swap the position of two effects.
|
|
*/
|
|
void SwapEffects(std::size_t firstEffectIndex, std::size_t secondEffectIndex);
|
|
|
|
/**
|
|
* \brief Serialize the effects container.
|
|
*/
|
|
void SerializeTo(SerializerElement& element) const;
|
|
|
|
/**
|
|
* \brief Unserialize the effects container.
|
|
*/
|
|
void UnserializeFrom(const SerializerElement& element);
|
|
|
|
/**
|
|
* \brief Clear all effects of the container.
|
|
*/
|
|
inline void Clear() { effects.clear(); }
|
|
|
|
private:
|
|
std::vector<std::shared_ptr<gd::Effect>> effects;
|
|
static Effect badEffect;
|
|
void Init(const EffectsContainer& other);
|
|
};
|
|
} // namespace gd
|
|
|
|
#endif
|