Magic_Game/src/kiwano/2d/SpriteFrame.h

// Copyright (c) 2016-2018 Kiwano - Nomango
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

#pragma once
#include <kiwano/core/Common.h>
#include <kiwano/math/Math.h>
#include <kiwano/render/Texture.h>

namespace kiwano
{

/**
 * \~chinese
 * @brief <EFBFBD><EFBFBD><EFBFBD><EFBFBD>֡
 */
class KGE_API SpriteFrame
{
public:
    SpriteFrame();

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>֡
    /// @param file_path ͼ<><CDBC>·<EFBFBD><C2B7>
    SpriteFrame(const String& file_path);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>֡
    /// @param res ͼ<><CDBC><EFBFBD><EFBFBD>Դ
    SpriteFrame(const Resource& res);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>֡
    /// @param texture <20><><EFBFBD><EFBFBD>
    SpriteFrame(TexturePtr texture);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>֡
    /// @param file_path ͼ<><CDBC>·<EFBFBD><C2B7>
    /// @param crop_rect <20>ü<EFBFBD><C3BC><EFBFBD><EFBFBD><EFBFBD>
    SpriteFrame(const String& file_path, const Rect& crop_rect);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>֡
    /// @param res ͼ<><CDBC><EFBFBD><EFBFBD>Դ
    /// @param crop_rect <20>ü<EFBFBD><C3BC><EFBFBD><EFBFBD><EFBFBD>
    SpriteFrame(const Resource& res, const Rect& crop_rect);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>֡
    /// @param texture <20><><EFBFBD><EFBFBD>
    /// @param crop_rect <20>ü<EFBFBD><C3BC><EFBFBD><EFBFBD><EFBFBD>
    SpriteFrame(TexturePtr texture, const Rect& crop_rect);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD>ͼ<EFBFBD><CDBC>
    /// @param file_path ͼ<><CDBC>·<EFBFBD><C2B7>
    bool Load(const String& file_path);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD>ͼ<EFBFBD><CDBC>
    /// @param res ͼ<><CDBC><EFBFBD><EFBFBD>Դ
    bool Load(const Resource& res);

    /// \~chinese
    /// @brief <20>Ƿ<EFBFBD><C7B7><EFBFBD>Ч
    bool IsValid() const;

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD>ü<EFBFBD><C3BC><EFBFBD><EFBFBD><EFBFBD>
    const Rect& GetCropRect() const;

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD><EFBFBD>
    TexturePtr GetTexture() const;

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD><EFBFBD>֡<EFBFBD><D6A1>С
    Size GetSize() const;

    /// \~chinese
    /// @brief <20>ü<EFBFBD><C3BC><EFBFBD><EFBFBD><EFBFBD>֡Ϊ<D6A1><CEAA><EFBFBD><EFBFBD>
    /// @param crop_rect <20>ü<EFBFBD><C3BC><EFBFBD><EFBFBD><EFBFBD>
    void SetCropRect(const Rect& crop_rect);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>òü<C3B2><C3BC><EFBFBD><EFBFBD><EFBFBD>
    /// @param texture <20><><EFBFBD><EFBFBD>
    void SetTexture(TexturePtr texture);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>зָ<D6B8><EEBEAB>֡
    /// @param cols <20><><EFBFBD><EFBFBD>
    /// @param rows <20><><EFBFBD><EFBFBD>
    /// @param max_num <20><><EFBFBD><EFBFBD>֡<EFBFBD><D6A1><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>-1Ϊ<31><CEAA><EFBFBD>ָ<EFBFBD><D6B8><EFBFBD><EFBFBD><EFBFBD>ͼ<EFBFBD><CDBC>ȫ<EFBFBD><C8AB><EFBFBD><EFBFBD>Ϊ<EFBFBD><CEAA><EFBFBD><EFBFBD>֡
    /// @param padding_x X<><58><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @param padding_y Y<><59><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    Vector<SpriteFrame> Split(int cols, int rows, int max_num = -1, float padding_x = 0, float padding_y = 0);

private:
    TexturePtr texture_;
    Rect       crop_rect_;
};

inline bool SpriteFrame::IsValid() const
{
    return texture_ && texture_->IsValid();
}

inline const Rect& SpriteFrame::GetCropRect() const
{
    return crop_rect_;
}

inline TexturePtr SpriteFrame::GetTexture() const
{
    return texture_;
}

inline Size SpriteFrame::GetSize() const
{
    return crop_rect_.GetSize();
}

}  // namespace kiwano