.NET5.0/C#9.0でオートシェイプ風図形描画ライブラリを作ろう！(Chapter0)

8815 ワード
.NET C#9.0 .NET5.0 C# SkiaSharp C# テキストリンク

.NET5.0も正式リリースされ、C#言語バージョンも9.0となりました。
とはいえ、私自身C#の知識が7.0くらいの知識からアップデートされていなかったりします。

そこで今回はC#8、9辺りの新しい機能を意識しつつ、.NET5.0のアプリケーションを一から作ってみようと思います。

作るもの

さて、何を作るかですが
「ほとんどの人がどのようなものか知っている（仕様の説明が要らない）」
「実装の結果が視覚的にわかりやすい」
との理由からWord、Excel等についているオートシェイプ機能のような図形描画のライブラリを作ることとしました。

  • オートシェイプ機能のような図形描画のライブラリを.NET5.0クラスライブラリとして作ります。
  • このライブラリを利用したサンプルアプリケーションをWPFで作成します。
  • サンプルでは2DグラフィックスエンジンのSkiaSharpを使います
  • (それ以外はノープランです)

※ 行き当たりばったりで設計しながら作る過程を連載記事として公開してゆく予定ですので、「それあまり良くない設計ですよ」とか「もっといい方法ありますよ」などフィードバックをいただけますと大変うれしいです。

ソースコード

本記事のソースコードはGitHub上に置いておきます。

（「blog/cahpter0-2」のように章ごとにブランチを切っていく予定です）

記事一覧（予定）

それでは、まずは開発の準備から始めましょう！

Chapter0 ソリューションの作成

Visual Studio2019 の最新バージョン(12/13現在はVersion 16.8.3)を使用して開発します。

プロジェクトの構成

以下のような構成でプロジェクトを作成します。

  • CoreShape: 今回作成するメインのプロジェクト （.NET5.0 クラスライブラリ)
  • CoreShape.Extensions.SkiaSharp: SkiaSharp向けのCoreShape拡張。インターフェースの実装や拡張メソッドなどを定義（.NET5.0クラスライブラリ）
  • SkiaSharp: 2Dグラフィックスエンジン（NuGetライブラリ参照）
  • SampleWPF: サンプルアプリ（WPF(.NET5.0)App）

CoreShapeライブラリはどのプラットフォーム、ライブラリにも依存しないポータブルな状態を保つようにします。

プロジェクトの作成

.NET5.0プロジェクトテンプレートの表示

.NET5.0 対応のプロジェクトテンプレートを利用するには今のところVisual Studioのオプション設定を変更する必要があります。

  • メニューバーで「ツール」-「オプション」を選択
  • オプションダイアログの左側で「環境」-「プレビュー機能」を選択
  • 「「新しいプロジェクト」ダイアログに全ての.NET Coreテンプレートを表示する」にチェックを付ける

.NET5.0クラスライブラリの作成

下記の手順で「CoreShape」及び「CoreShape.Extensions.SkiaSharp」のプロジェクトを作成します。

  • メニューバーで「ファイル」-「新規作成」-「プロジェクト」を選択
  • 「新しいプロジェクトの作成」ダイアログでテンプレート「Class library」を選択して「次へ」
  • プロジェクト名「CoareShape」を入力して「次へ」
  • 「追加情報」でターゲットフレームワークで「.NET5.0」を選択して「作成」
  • メニュー「ファイル」-「追加」-「新しいプロジェクト」から「CoreShape.Extensions.SkiaSharp」プロジェクトも同様に作成します。

WPF(.NET5.0)Appの作成

続けてWPFアプリケーション（SampleWpf）のプロジェクトを作成します。

  • メニューバーで「ファイル」-「追加」-「新しいプロジェクト」を選択
  • 「新しいプロジェクトの追加」ダイアログでテンプレート「WPF Application」を選択して「次へ」
  • プロジェクト名を入力して「次へ」
  • 「追加情報」でターゲットフレームワークで「.NET5.0」を選択して「作成」

SkiaSharpのNuGetパッケージを追加

「ツール」-「NuGetパッケージマネージャ」-「ソリューションのNuGetパッケージの管理」を開き、「SkiaSharp」のパッケージを検索し、プロジェクトに追加します。

  • 「SampleWPF」プロジェクトに「SkiaSharp.Views.WPF」の最新安定バージョンを追加します
  • 「CoreShape.Extensions.SkiaSharp」プロジェクトに「SkisSharp」の最新安定バージョンを追加します。

プロジェクトの参照

下記の通りにプロジェクト間の参照設定を行います。

  • SampleWPF
    → CoreShape、CoreShape.Extensions.SkiaSharp を参照
  • CoreShape.Extensions.SkiaSharp
    → CoreShape を参照

NULL許容コンテキストを有効にする

作成されたcsprojファイルに <Nullable>enable</Nullable> を追加します。
こうすることで参照型もNULL非許容が前提となり、NULL以外の値に初期化しないと警告が出るようになります。（作成した全てのプロジェクトでこの設定を行います）

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>net5.0</TargetFramework>
    <Nullable>enable</Nullable>
  </PropertyGroup>
</Project>

Null許容参照型 - C#リファレンス

描画面の設定

SampleWPFでMainWindow.xamlを開き、SkiaSharpで図形を描画するためのコントロールSKElementを追加します。

<Window x:Class="SampleWPF.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:skiaSharp="clr-namespace:SkiaSharp.Views.WPF;assembly=SkiaSharp.Views.WPF"
        xmlns:local="clr-namespace:SampleWPF"
        mc:Ignorable="d"
        Title="MainWindow" Height="450" Width="800">
    <Grid>
        <skiaSharp:SKElement x:Name="skElement" 
                             PaintSurface="sKElement_PaintSurface" />
    </Grid>
</Window>

そしてコードビハインド（MainWindow.xaml.cs）には描画面を更新する際のイベント PaintSurfaceのイベントハンドラを追加しておきます。

private void sKElement_PaintSurface(object sender, SKPaintSurfaceEventArgs e)
{
    //ここに図形描画の処理を記述します。
}

これで実装前の準備は完了です。

次回

次回は

です。