Magic_Game/src/kiwano/2d/Frame.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/ObjectBase.h>
#include <kiwano/render/Texture.h>

namespace kiwano
{
KGE_DECLARE_SMART_PTR(Frame);

/**
 * \~chinese
 * @brief ͼ<EFBFBD><EFBFBD>֡
 */
class KGE_API Frame : public virtual ObjectBase
{
public:
    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ͼ<EFBFBD><CDBC>֡
    Frame();

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

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

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

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

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

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

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD>߶<EFBFBD>
    float GetHeight() const;

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

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD>ü<EFBFBD>λ<EFBFBD><CEBB>
    Point GetCropPoint() const;

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

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

private:
    TexturePtr texture_;
    Rect       crop_rect_;
};

inline bool Frame::IsValid() const
{
    return texture_ && texture_->IsValid();
}
inline float Frame::GetWidth() const
{
    return crop_rect_.GetWidth();
}
inline float Frame::GetHeight() const
{
    return crop_rect_.GetHeight();
}
inline Size Frame::GetSize() const
{
    return crop_rect_.GetSize();
}
inline Point Frame::GetCropPoint() const
{
    return crop_rect_.GetLeftTop();
}
inline Rect const& Frame::GetCropRect() const
{
    return crop_rect_;
}
inline TexturePtr Frame::GetTexture() const
{
    return texture_;
}
}  // namespace kiwano