Cocos Sharp 入門 （1） Cocos Sharp の概要およびメリット・デメリット

はじめに

こんにちは、＠hiro128_777です。
今回は、これから Cocos Sharp を導入しようかな～と検討している方もいらっしゃるかと思いますので、あらためて、Cocos Sharp の概要およびメリット・デメリットを整理したいと思います。

Cocos Sharp ってどんなもの

Cocos Sharp は、Xamarin 上で動作する2Dゲーム開発用クロスプラットフォームライブラリです。
Cocos Sharp は Monogame 上に構築されており、Monogameのエンジンを Cocos2d,3d の API で利用できます。

つまり…
C#ユーザーであれば、Xamarin　＋　Cocos Sharp で最短でクロスプラットフォームでのゲーム開発が可能です！！

Cocos Sharp を使うメリットは

Xamarin.Forms と共存できる

Cocos Sharp を使う最大のメリットは、ゲーム画面を Xamarin.Forms 上のUIコントロールの一つとして扱うことができるため、一つの画面内で一部分はゲーム、一部分はリスト表示というようなことが実現できることです。今のところクロスプラットフォームでこんな芸当ができるのは Cocos Sharp のみです。

具体例として、前回の記事をご参照ください。
hiro128.hatenablog.jp

ゲーム開発未経験でも簡単にスマホゲームが作れる

Cocos Sharp は学習コストが非常に低いです。C#経験者であれば、1週間も触ればすぐゲーム開発が可能になります。
職業としてではなく、趣味としてできるだけ簡単にスマホゲームをリリースしたい場合、Cocos Sharp は非常に魅力的な選択肢となります。

処理が早い

Cocos Sharp は2Dに特化しているため、3D用のライブラリも存在せず、3D用のプロセスを起動する必要もないので、非常に軽快に動作します。

コード共有率が非常に高い

ゲームは基本的に標準のUIコントロールを使用せず、独自の描画を行うため、Xamarin.Forms のように各プラットフォームのUIコントロールの差異を調整するようなことをする必要がありません。よって、コード共有率が非常に高くなります。通常の場合90％以上のコード共有率が実現できます。プラットフォーム個別の実装が必要なのは、各種センサー周り、カメラ周り、広告関係、課金関係などに限られます。

Xamarin 環境があれば導入コストが無料

Xamarin の環境をすでに持っているのであれば、Cocos Sharp 自体は無料で使い始めることができます。MIT License なので商用利用も可能です。

Cocos Sharp のデメリットは

日本語情報がほとんどない

Cocos Sharp の日本語情報はほとんどありませんが、Cocos2d-x の情報は非常にたくさん存在しますので、それをC#に読み替えれば大丈夫です。それでも分からない場合は、twitter, teratailなどで質問すれば、何らかのアドバイスが得られると思います。また、私のblogにも色々情報がありますのでご参考にしていただければ幸いです。

職業としてゲーム開発者を目指す場合メリットが薄い

C#環境で職業としてゲーム開発者を目指すのであれば Unity が最適だと考えられます。ゲーム会社さんで Cocos Sharp を使っているという会社さんは聞いたことがありませんので…

まとめ

Cocos Sharp は「Xamarin 触ったことあるけど、ゲームも作ってみたいな～」という方には最適なソリューションです。ぜひ、皆様も Cocos Sharp でゲーム開発にチャレンジしてみてください！

CocosSharp for Xamarin.Forms で寿司を流そう！

はじめに

こんにちは、＠hiro128_777です。

この記事は「Xamarin(その2) Advent Calendar 2016 - Qiita」の14日目になります。

今回やってみたこと

皆様 Xamarin.Forms というと業務アプリ的なイメージがあるかと思うのですが、なんと、CocosSharp for Xamarin.Formsを使うと、Xamarin.Formsの中にCocosSharpのゲームを同居できてしまいます。

というわけで今回は、CocosSharp for Xamarin.Forms で寿司を流すサンプルを作成してみました。
アプリの中に動きのあるコンテンツを利用したいときのご参考にでもなれば幸いです。

今回のサンプルのソースは以下をご参照ください。

https://github.com/TomohiroSuzuki128/CocosSharpFormsSample

作成方法

Xamarin Forms の新規プロジェクトを作成し、CocosSharp.Forms 1.7.1 のパッケージをインストールしてください。
※この辺りの詳細な方法については、たくさん情報がございますので割愛します。

概要

画面の構成は上の図のように、画面の上半分が Cocos Sharp のゲーム画面で、寿司が流れる部分となります。
下半分が Xamarin.Forms で操作するボタンが配置されています。

ボタンを1回押すごとにゲーム画面部分に寿司が1つ流れます。

XAMLの作成

<?xml version="1.0" encoding="utf-8" ?>
<ContentPage xmlns="http://xamarin.com/schemas/2014/forms"
			 xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
			 xmlns:prism="clr-namespace:Prism.Mvvm;assembly=Prism.Forms"
			 prism:ViewModelLocator.AutowireViewModel="True"
			 Title="ココ寿司ャープ"
			 x:Class="CocosSharpFormsSample.Views.MainPage">
	<Grid x:Name="MainGrid" RowSpacing="0">
		<Grid.RowDefinitions>
			<RowDefinition Height="*"/>
			<RowDefinition Height="*"/>
		</Grid.RowDefinitions>
		<StackLayout Grid.Column="0" Grid.Row="1">
			<StackLayout Padding="0,100,0,0">
				<Button Text="左へ寿司を流す" Command="{Binding LeftCommand}" />
			</StackLayout>
			<StackLayout Padding="0,20,0,0">
				<Button Text="右へ寿司を流す" Command="{Binding RightCommand}" />
			</StackLayout>
		</StackLayout>
	</Grid>
</ContentPage>

XAMLは通常の Xamarin.Forms の場合と何も変わりません。上下2段のGridが配置してあり、下のセルにボタンが2つ配置されています。
CocosSharp のコントロールは XAML 上には配置されていません。CocosSharp のコントロールは XAML 上で追加するとなぜか落ちるため、後ほどコードビハインドで追加します。

コードビハインド

using System;
using System.Collections.Generic;

using Xamarin.Forms;
using CocosSharp;
using CocosSharpFormsSample.ViewModels;

namespace CocosSharpFormsSample.Views
{
	public partial class MainPage : ContentPage
	{
		public MainPage()
		{
			InitializeComponent();

			var grid = this.FindByName<Grid>("MainGrid");

			var gameView = new CocosSharpView()
			{
				HorizontalOptions = LayoutOptions.FillAndExpand,
				VerticalOptions = LayoutOptions.FillAndExpand,
				ViewCreated = CocosSharpView_ViewCreated
			};
			grid.Children.Add(gameView, 0, 0);
		}

		private void CocosSharpView_ViewCreated(object sender, EventArgs e)
		{
			var gameView = sender as CCGameView;

			if (gameView != null)
			{
				gameView.DesignResolution = new CCSizeI(350, 300);
				gameView.ResolutionPolicy = CCViewResolutionPolicy.ExactFit;
				gameView.ContentManager.SearchPaths = new List<string> { "Images" };
				var gameScene = new GameScene(gameView);
				gameView.RunWithScene(gameScene);
				var viewModel = BindingContext as MainPageViewModel;
				viewModel.GameScene = gameScene;
			}
		}

	}
}

コードビハインドでは、InitializeComponentの後にCocosSharpViewのコントロールを作成し配置します。
また、コントロール作成時のイベントハンドラ内で以下のようにゲーム画面の初期設定を行っています。

gameView.DesignResolution = new CCSizeI(350, 300);

ゲーム内の仮想解像度を横350ユニット、縦300ユニットに設定する。

gameView.ResolutionPolicy = CCViewResolutionPolicy.ExactFit;

アスペクト比を保ったまま最大の大きさで表示する。

gameView.ContentManager.SearchPaths = new List<string> { "Images" };

アセットを探しに行くパスを設定する。

var viewModel = BindingContext as MainPageViewModel;
viewModel.GameScene = gameScene;

また、ViewModel側からゲーム操作できるように参照を渡しています。この部分本当は疎結合にしたいのですが、現状では厳しそうな感じです。

ゲームロジック

CocosSharp のゲームでは、CCSceneの中にCCLayerが存在し、その中にCCSpriteが配置されます。

最初にCCLayer上で寿司が流れるロジックを作成します。

using System;

using CocosSharp;

namespace CocosSharpFormsSample
{
	public class GameLayer : CCLayerColor
	{
		private CCTexture2D sushiTexture;

		public GameLayer(CCColor4B? color = default(CCColor4B?)) : base(color)
		{
			sushiTexture = new CCSprite("Sushi.png", null).Texture;
		}

		public void ConveyorShushiRightToLeft()
		{
			var sushi = new CCSprite(sushiTexture);
			sushi.PositionX = 401f;
			sushi.PositionY = 80f;
			var moveBy = new CCMoveBy(4f, new CCPoint(-500f, 0));
			var remove = new CCRemoveSelf();
			var sequence = new CCSequence(moveBy, remove);
			sushi.RunAction(sequence);
			AddChild(sushi);
		}

		public void ConveyorShushiLeftToRight()
		{
			var sushi = new CCSprite(sushiTexture);
			sushi.PositionX = -50f;
			sushi.PositionY = 210f;
			var moveBy = new CCMoveBy(4f, new CCPoint(500f, 0));
			var remove = new CCRemoveSelf();
			var sequence = new CCSequence(moveBy, remove);
			sushi.RunAction(sequence);
			AddChild(sushi);
		}

	}
}

ConveyorShushiRightToLeftConveyorShushiLeftToRightの各メソッドは、それぞれ「左へ寿司を流す」「右へ寿司を流す」ボタンを押したときに、画面外の領域に寿司を配置しそのまま画面上を寿司が流れ、画面外に到達したら寿司をGameLayerから削除する一連のアクションを実行します。

次に、作成したGameLayerをCCSceneに配置します。

using System;

using CocosSharp;

namespace CocosSharpFormsSample
{
	public class GameScene : CCScene
	{
		GameLayer layer;

		public GameScene(CCGameView gameView) : base(gameView)
		{
			layer = new GameLayer(CCColor4B.White);
			AddLayer(layer);
		}

		public void RightToLeft()
		{
			layer.ConveyorShushiRightToLeft();
		}

		public void LeftToRight()
		{
			layer.ConveyorShushiLeftToRight();
		}

	}
}

ViewModel

ViewModelでは、Xamarin.Forms側のCommandに従いCocosSharp側に指示を与えています。

using Prism.Commands;
using Prism.Mvvm;
using Prism.Navigation;

namespace CocosSharpFormsSample.ViewModels
{
	public class MainPageViewModel : BindableBase
	{

		public GameScene GameScene { get; set; }
		public DelegateCommand LeftCommand => new DelegateCommand(Left, CanLeft);
		public DelegateCommand RightCommand => new DelegateCommand(Right, CanRight);

		INavigationService _navigationService;

		public MainPageViewModel(INavigationService navigationService)
		{
			_navigationService = navigationService;
		}

		private bool CanLeft()
		{
			return true;
		}

		private void Left()
		{
			GameScene.RightToLeft();
		}

		private bool CanRight()
		{
			return true;
		}

		private void Right()
		{
			GameScene.LeftToRight();
		}

	}
}

以上で完了です。

では早速動かしてみましょう。

ボタンを押すと左右から寿司が流れました（笑）

まとめ

• CocosSharp for Xamarin.Formsを使うと、Xamarin.Formsの中の一部分としてCocosSharpのゲームを同居できます。
• Xamarin.Forms側からCocosSharpのゲームを操作することも可能です。
• Xamarin.Formsでは表現しきれない動きのあるコンテンツを利用したい時に有効です。

今回のサンプルのソースは以下をご参照ください。

https://github.com/TomohiroSuzuki128/CocosSharpFormsSample

CocosSharp for Xamarin.Forms では、Xamarin.Forms 内のコントロールとしてCocos Sharp を使えます。

こんにちは、＠hiro128_777です。

実はCocos Sharpは、バージョン1.6.2までと1.7.1以降で大きな違いがあります。
以下のようにNuGetのパッケージも別パッケージとなっています。

バージョン　1.6.2まで
CocosSharp PCL ………………………………フルスクリーンでの使用が前提。同一画面内で、Xamarin Native, Xamarin.Formsとの同居は不可。

バージョン　1.7.1以降
CocosSharp ……………………………………Xamarin Native内の一つのUIパーツとしてとしてCocos Sharpを利用可能。
CocosSharp for Xamarin.Forms 1.7.1 ………Xamarin.Forms 内の一つのUIパーツとしてとしてCocos Sharpを利用可能

バージョン　1.7.1以降ではゲーム画面は、NativeではCCGameView、FormsではCocosSharpViewというUIコントロールの一つとして扱われるように変更されています。
これによって一つの画面内で一部分はゲーム、一部分はリスト表示というようなことが実現できるようになり、Cocos Sharpの利用シーンがぐっと増えた感じです！

図で表すと以下のようになります。

今後は、業務系のアプリでもCocos Sharpを効果的に利用できますね。
次回は、CocosSharp for Xamarin.Formsを実際に使ってみたいと思います。

Cocos Sharp Deep Dive（2） スケジューラ

今回は、Cocos Sharp の もう一つの重要な機能であるスケジューラがどのような内部動作をしているのかを深く解析したいと思います。

スケジューラにメソッドを登録する場合には、以下のようにCCNodeのScheduleメソッドを使用します。

Schedule(t => this.DetectCollisions(), 0.1f);

これは、0.1秒ごとにDetectCollisionsメソッドを実行しなさいという意味です。

まずは、Scheduleメソッドの内部動作を確認してみましょう。

CCNodeのScheduleメソッドのソースコードを見てみると以下のようになっています。

public void Schedule (Action<float> selector, float interval)
{
	Schedule (selector, interval, CCSchedulePriority.RepeatForever, 0.0f);
}

Scheduleメソッドのオーバーロードをコールしていますので、コール先のソースコードを見てみると以下のようになっています。

public void Schedule (Action<float> selector, float interval, uint repeat, float delay)
{
	if (Scheduler != null)
		Scheduler.Schedule (selector, this, interval, repeat, delay, !IsRunning);
	else
		AddLazySchedule (selector, this, interval, repeat, delay, !IsRunning);
}

SchedulerプロパティのScheduleメソッドをコールしています。AddLazyScheduleの方も追っていくと、最終的にはScheduleメソッドをコールするようになっています。

Schedulerプロパティのを確認すると、その実体はCCScheduler.SharedSchedulerのようです。

CCScheduler Scheduler
{
	get { return CCScheduler.SharedScheduler; }
}

SharedSchedulerというプロパティ名からもわかるとおり、CCSchedulerを確認すると Singleton になっています。

さらに、Scheduleメソッドを確認すると以下のように、デリゲートと付帯情報をCCTimerのリストとして登録しています。

public void Schedule (Action<float> selector, ICCUpdatable target, float interval, uint repeat, float delay, bool paused)
{
	// 省略
	element.Timers.Add(new CCTimer(this, target, selector, interval, repeat, delay));
	// 省略
}

よって、CCNodeのScheduleメソッドに登録したデリゲートは全てCCSchedulerで一括管理されるようになっていることがわかります。

では次に一括管理されたデリゲートがどのように実行されていくか見てみましょう。

デリゲートと付帯情報はCCTimerのリストとして管理されており、CCSchedulerのUpdateメソッド内で、各CCTimerのUpdateメソッドがコールされています。

public class CCScheduler
{
	internal void Update (float dt)
	{
		if (TimeScale != 1.0f)
		{
			dt *= TimeScale;
		}

		// 省略

		for (elt.TimerIndex = 0; elt.TimerIndex < elt.Timers.Count; ++elt.TimerIndex)
		{
			elt.CurrentTimer = elt.Timers[elt.TimerIndex];
			if(elt.CurrentTimer != null) {
				elt.CurrentTimerSalvaged = false;

				elt.CurrentTimer.Update(dt);

				elt.CurrentTimer = null;
			}
		}
		// 省略
	}
}

CCTimerのUpdateメソッドを確認してみると以下のようになっています。

internal class CCTimer : ICCUpdatable
{
	public void Update(float dt)
	{
	    if (elapsed == -1)
	    {
	        elapsed = 0;
	        timesExecuted = 0;
	    }
	    else
	    {
	        if (runForever && !useDelay)
	        {
	            //standard timer usage
	            elapsed += dt;
	            if (elapsed >= Interval)
	            {
	                if (Selector != null)
	                {
	                    Selector(elapsed);
	                }
					elapsed = 0;
	            }
	        }
	        else
	        {
				// 省略
	        }
	    }
	}
}

今回のフレームの経過時間であるdtから、前回デリゲートを実行してからのトータル経過時間elapsedを計算して、与えられたIntervalを経過していたら、Selectorデリゲートを実行しているのが分かります。

これで、スケジューラがどのような内部動作をしているのかがわかりました。

というわけで、今回はここまでです。

Cocos Sharp Deep Dive（1） CCAction

これまでCCMoveToや、CCRotateToなど個々のアクションの使い方をご説明しましたが、今回は、実際にこれらのアクションがどのような内部動作をしているのかを深く解析したいと思います。

例えば、CCMoveToをはじめとする全てのアクションを利用する場合には以下のようにCCNodeのRunActionメソッドを使用します。

var moveToAction = new CCMoveTo(3f, new CCPoint(50f, 100f));
node.RunAction(moveToAction);

まずは、RunActionしたアクションがどのように管理されているかを確認してみましょう。

CCNodeのRunActionメソッドのソースコードを見てみると以下のようになっています。

public CCActionState RunAction(CCAction action)
{
	return ActionManager != null ? ActionManager.AddAction(action, this, !IsRunning) : AddLazyAction(action, this, !IsRunning);
}

RunActionしたアクションをActionManagerに登録しています。AddLazyActionの方も追っていくと、最終的にはActionManagerに登録するようになっています。

よって、RunActionしたアクションは全てActionManagerで一括管理されるようになっています。

また、ActionManagerのAddActionを確認すると、追加されたアクションのStartActionをコールし、CCActionStateを返すようになっています。

public CCActionState AddAction(CCAction action, CCNode target, bool paused = false)
{
	// 省略
	var state = action.StartAction(target);
	// 省略
	return state;
}

次に、実際のアクションの動きがどのように動作しているのかを確認します。
基本的な動作原理として、1フレームごとに、ActionManagerのUpdateメソッドがコールされます。
引数のdtは deltaTime つまり、前のフレームから現在のフレームまでの経過時間です。

public void Update(float dt)
{
	// 省略
	for (int i = 0; i < count; i++)
	{
		// 省略
		currentTarget.CurrentActionState.Step(dt);
		// 省略
	}
}

この中で、登録されているCCActionStateのStepメソッドをコールしています。

Stepメソッドは、CCMoveToや、CCRotateToをStartActionしたときに生成されるCCMoveToStateおよび、CCRotateToStateの継承元であるCCFiniteTimeActionStateに実装されています。

Stepメソッドでは、当該のアクションのすでに完了した部分の時間を分子に、アクション全体の所要時間を分母にし、アクションが何％進んだかを示す値を引数にしUpdateメソッドをコールしています。

protected internal override void Step(float dt)
{
	if (firstTick)
	{
		firstTick = false;
		Elapsed = 0f;
	}
	else
	{
		Elapsed += dt;
	}

	Update (Math.Max (0f,
			Math.Min (1, Elapsed / Math.Max (Duration, float.Epsilon)
			)
		)
	);
}

これを、例としてCCMoveToStateで確認すると、以下のようになっています。

残りの未完了のアクションであるPositionDeltaのうち、今回のフレームで消化すべき量を求めてその分だけアクションするようになっています。

public class CCMoveToState : CCMoveByState
{

	public CCMoveToState (CCMoveTo action, CCNode target)
		: base (action, target)
	{ 
		StartPosition = target.Position;
		PositionDelta = action.PositionEnd - target.Position;
	}

	public override void Update (float time)
	{
		if (Target != null)
		{
			CCPoint currentPos = Target.Position;

			CCPoint newPos = StartPosition + PositionDelta * time;
			Target.Position = newPos;
			PreviousPosition = newPos;
		}
	}
}

つまりアクションは一見するとスケジューラのようなフレームで管理された動作とは違うように見えますが、詳しく見てみると、スケジューラと同じように1フレームごとの動作に細切れにされた上で実行されているのが分かります。

というわけで、今回はここまでです。