C_animation.hpp

/*
 * Copyright 2024 Guillaume Guillet
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef _FGE_C_ANIMATION_HPP_INCLUDED
#define _FGE_C_ANIMATION_HPP_INCLUDED
 
#include "FastEngine/fge_extern.hpp"
#include "FastEngine/C_rect.hpp"
#include "FastEngine/manager/C_baseManager.hpp"
#include "FastEngine/manager/anim_manager.hpp"
 
namespace fge
{
 
class FGE_API Animation : public manager::BaseDataAccessor<
                                  manager::GlobalDataAccessorManagerInfo<anim::AnimationManager, &anim::gManager>,
                                  manager::DataAccessorOptions::BLOCKPOINTER_ONLY>
{
public:
    using BaseDataAccessor::operator=;
    using Index = uint16_t;
 
    Animation() = default;
    Animation(std::string_view name, Index frame = 0);
    Animation(std::string_view name, std::string_view group, Index frame = 0);
    Animation(char const name[], Index frame = 0);
    Animation(char const name[], char const group[], Index frame = 0);
    Animation(SharedDataType data, Index frame = 0);
    Animation(SharedDataType data, std::string_view group, Index frame = 0);
    Animation(SharedDataType data, char const group[], Index frame = 0);
 
    void clear() override;
 
    [[nodiscard]] anim::AnimationType getType() const;
 
    bool setGroup(std::string_view group);
    bool setGroup(Index groupIndex);
 
    [[nodiscard]] anim::AnimationGroup const* getGroup() const;
    [[nodiscard]] anim::AnimationGroup* getGroup();
    [[nodiscard]] anim::AnimationGroup const* getGroup(std::string_view group) const;
    [[nodiscard]] anim::AnimationGroup* getGroup(std::string_view group);
    [[nodiscard]] anim::AnimationGroup const* getGroup(Index groupIndex) const;
    [[nodiscard]] anim::AnimationGroup* getGroup(Index groupIndex);
 
    [[nodiscard]] bool isGroupValid() const;
 
    Index nextFrame();
    void setFrame(Index frame);
 
    [[nodiscard]] Index getFrameIndex() const;
    [[nodiscard]] Index getGroupIndex() const;
 
    [[nodiscard]] fge::anim::AnimationFrame const* getFrame() const;
    [[nodiscard]] fge::anim::AnimationFrame* getFrame();
    [[nodiscard]] fge::anim::AnimationFrame const* getFrame(Index frameIndex) const;
    [[nodiscard]] fge::anim::AnimationFrame* getFrame(Index frameIndex);
 
    [[nodiscard]] bool isFrameValid() const;
 
    void setLoop(bool active);
    [[nodiscard]] bool isLoop() const;
 
    void setReverse(bool active);
    [[nodiscard]] bool isReverse() const;
 
    void setHorizontalFlip(bool active);
    [[nodiscard]] bool isHorizontalFlipped() const;
 
    [[nodiscard]] std::shared_ptr<fge::TextureType> const& retrieveTexture() const;
 
    [[nodiscard]] fge::RectInt retrieveTextureRect() const;
 
private:
    Index g_groupIndex{0};
    Index g_frameIndex{0};
 
    bool g_loop{false};
    bool g_reverse{false};
    bool g_flipHorizontal{false};
};
 
FGE_API fge::net::Packet const& operator>>(fge::net::Packet const& pck, fge::Animation& data);
FGE_API fge::net::Packet& operator<<(fge::net::Packet& pck, fge::Animation const& data);
 
FGE_API void to_json(nlohmann::json& j, fge::Animation const& p);
FGE_API void from_json(nlohmann::json const& j, fge::Animation& p);
 
} // namespace fge
 
#endif // _FGE_C_ANIMATION_HPP_INCLUDED