Magic_Game/src/kiwano/render/StrokeStyle.h

// Copyright (c) 2016-2019 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/DirectX/D2DDeviceResources.h>

namespace kiwano
{
class RenderContext;
class Renderer;

KGE_DECLARE_SMART_PTR(StrokeStyle);

/**
 * \addtogroup Render
 * @{
 */

/// \~chinese
/// @brief <20><><EFBFBD><EFBFBD><EFBFBD>˵<EFBFBD><CBB5><EFBFBD>ʽ
/// @details <20><><EFBFBD><EFBFBD><EFBFBD>˵<EFBFBD><CBB5><EFBFBD>ʽ<EFBFBD><CABD>ʾ<EFBFBD>߶ζ˵㲿<CBB5>ֵ<EFBFBD><D6B5><EFBFBD>״
enum class CapStyle
{
    Flat,      ///< <20><><EFBFBD>˵<EFBFBD>
    Square,    ///< <20><><EFBFBD>ζ˵㣬<CBB5><E3A3AC><EFBFBD><EFBFBD>ͻ<EFBFBD><CDBB><EFBFBD><EFBFBD><EFBFBD>ֵ<EFBFBD><D6B5><EFBFBD><EFBFBD>߶ο<DFB6><CEBF>ȵ<EFBFBD>һ<EFBFBD><D2BB>
    Round,     ///< Բ<>ζ˵㣬Բֱ<D4B2><D6B1><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>߶ο<DFB6><CEBF><EFBFBD>
    Triangle,  ///< <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʽ<EFBFBD><CABD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>б<EFBFBD>߳<EFBFBD><DFB3>ȵ<EFBFBD><C8B5><EFBFBD><EFBFBD>߶ο<DFB6><CEBF><EFBFBD>
};

/// \~chinese
/// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʽ
/// @details <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʽ<EFBFBD><CABD>ʾ<EFBFBD><CABE><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ཻ<EFBFBD><E0BDBB><EFBFBD>ֵ<EFBFBD><D6B5><EFBFBD>״
enum class LineJoinStyle
{
    Miter,  ///< б<><D0B1><EFBFBD><EFBFBD>ʽ
    Bevel,  ///< б<><D0B1><EFBFBD><EFBFBD>ʽ
    Round   ///< Բ<><D4B2><EFBFBD><EFBFBD>ʽ
};

/// \~chinese
/// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʽ
/// @details <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʽ<EFBFBD><CABD>ʾ<EFBFBD>߶εļ<CEB5>϶
enum class DashStyle
{
    Solid,       ///< <20>޼<EFBFBD><DEBC>ϵ<EFBFBD>ʵ<EFBFBD><CAB5>
    Dash,        ///< б<><D0B1><EFBFBD><EFBFBD>ʽ
    Dot,         ///< Բ<><D4B2><EFBFBD><EFBFBD>ʽ
    DashDot,     ///< Բ<><D4B2><EFBFBD><EFBFBD>ʽ
    DashDotDot,  ///< Բ<><D4B2><EFBFBD><EFBFBD>ʽ
};

/// \~chinese
/// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʽ
class StrokeStyle : public virtual ObjectBase
{
    friend class RenderContext;
    friend class Renderer;

public:
    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʽ
    /// @param cap <20><><EFBFBD><EFBFBD><EFBFBD>˵<EFBFBD><CBB5><EFBFBD>ʽ
    /// @param line_join <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʽ
    /// @param dash <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʽ
    /// @param dash_offset <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ƫ<EFBFBD><C6AB><EFBFBD><EFBFBD>
    static StrokeStylePtr Create(CapStyle cap, LineJoinStyle line_join = LineJoinStyle::Miter,
                                 DashStyle dash = DashStyle::Solid, float dash_offset = 0.0f);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʽ
    /// @param cap <20><><EFBFBD><EFBFBD><EFBFBD>˵<EFBFBD><CBB5><EFBFBD>ʽ
    /// @param line_join <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʽ
    /// @param dash_array <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ߵij<DFB5><C4B3><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>϶<EFBFBD><CFB6><EFBFBD><EFBFBD>
    /// @param dash_size <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>С
    /// @param dash_offset <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ƫ<EFBFBD><C6AB><EFBFBD><EFBFBD>
    static StrokeStylePtr Create(CapStyle cap, LineJoinStyle line_join = LineJoinStyle::Miter,
                                 const float* dash_array = nullptr, size_t dash_size = 0, float dash_offset = 0.0f);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʽ
    /// @tparam _DashSize <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>С
    /// @param cap <20><><EFBFBD><EFBFBD><EFBFBD>˵<EFBFBD><CBB5><EFBFBD>ʽ
    /// @param line_join <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʽ
    /// @param dash_array <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ߵij<DFB5><C4B3><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>϶<EFBFBD><CFB6><EFBFBD><EFBFBD>
    /// @param dash_offset <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ƫ<EFBFBD><C6AB><EFBFBD><EFBFBD>
    template <size_t _DashSize>
    static StrokeStylePtr Create(CapStyle cap, LineJoinStyle                     line_join = LineJoinStyle::Miter,
                                 float (&dash_array)[_DashSize] = nullptr, float dash_offset = 0.0f)
    {
        return StrokeStyle::Create(cap, line_join, dash_array, _DashSize, dash_offset);
    }

    StrokeStyle();

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

#if defined(KGE_WIN32)
private:
    ComPtr<ID2D1StrokeStyle> GetStrokeStyle() const;

    void SetStrokeStyle(ComPtr<ID2D1StrokeStyle> style);

private:
    ComPtr<ID2D1StrokeStyle> style_;
#endif
};

/** @} */

inline bool StrokeStyle::IsValid() const
{
    return style_ != nullptr;
}

#if defined(KGE_WIN32)
inline ComPtr<ID2D1StrokeStyle> StrokeStyle::GetStrokeStyle() const
{
    return style_;
}

inline void StrokeStyle::SetStrokeStyle(ComPtr<ID2D1StrokeStyle> style)
{
    style_ = style;
}
#endif

}  // namespace kiwano