３角形ポリゴンの表示
概要
３Ｄ空間上に三角形のポリゴンを表示しています。
動作環境
必須環境
| 対応 XNA バージョン |
|
| 対応プラットフォーム |
|
| Windows 必須頂点シェーダ バージョン | 2.0 |
| Windows 必須ピクセルシェーダ バージョン | 2.0 |
動作確認環境
| プラットフォーム |
|
内容
ポリゴンとは
ポリゴンとは複数の頂点定義によって生成される面のことを言います。一般的にポリゴンといった場合、３つの頂点から成る三角形の面のことを言います。そして３角形がポリゴンの最小単位になります。モデリングソフトによっては４角形や多角形としてポリゴンを表示している場合がありますが、それらも最終的には三角形のポリゴンに分解されます。
ゲームなどで表示されているモデルは、この三角形ポリゴンを複数組み合わせて形成されています。
ポリゴンは頂点によって形成されます。頂点には位置や色などのデータを持たせることができます。今回のサンプルも「位置」と「色」のデータによって作られています。
今回のサンプルの面の色はそれぞれの頂点に設定されている色と距離によってきれいに補間されていますが、独自のシェーダプログラムで自由に変えることができます(シェーダプログラムについては別の機会に説明します)。
頂点データ定義
ポリゴンを表示させるには「頂点データ」が必要であり、その頂点にどんな要素を含めるかをプログラマが決める必要があります。ポリゴンを描画する際には、どんな頂点データでポリゴンを描画するかを描画エンジンであるデバイスに指示しなければなりません。これを行うには「VertexDeclaration」クラスを作成し、「頂点データ定義」を設定します。
しかし、XNA Game Studio 4.0 からはこの設定が簡略化されており、今回の Tips では VertexDeclaration クラスを準備する必要はありません。(フレームワークで用意されている頂点データに定義情報がすでに組み込まれているからです)
頂点データ
ポリゴンを描画するには頂点データが必要と書きましたが、まず、どんなデータを持たせるかを決めなければいけません。今回は「位置」と「色」のデータを使用します。持たせるデータを決めたら、それらのデータを持つ構造体を作成する必要があります。頂点データはある程度自由に決めることができますが、一般的に使用される頂点データはすでに XNA Framework で定義されているので、サンプルではそれを使用しています。
「位置」と「色」を持つ頂点データは「VertexPositionColor」構造体として定義されています。ポリゴンを形成するには複数の頂点が必要なので、これを配列として宣言しておきます。
<summary>
頂点データリスト
</summary>
private VertexPositionColor[] vertices = null;
エフェクト
XNA ではポリゴンを描画する際に、シェーダプログラムを別に作成してどのように描画するかを決めなければいけません。それには別途エフェクトファイルを作成してプログラムを書き、それをエフェクトクラスとして読み込んでシェーダプログラムを実行させます。
しかし、今回のような単純な三角形ポリゴンの描画や、複雑な描画効果を必要としない場合にとってそれはとても煩わしい作業となってしまいます。
そのため XNA では基本的な描画に関してはシェーダプログラムを書かなくてもいいように、必要な項目をプロパティとして設定できるように拡張したエフェクトを定義しています。それが「BasicEffect」クラスです。今回はポリゴンを描画することが目的なので、描画に手間のかからない「BasicEffect」を使うことにします。
<summary>
基本エフェクト
</summary>
private BasicEffect basicEffect = null;
エフェクトや BasicEffect に関しては別の機会に詳しく説明したいと思います。
ちなみに Windows Phone 7 では独自のエフェクトを使用することはできず、BasicEffect のようなフレームワークに組み込まれたエフェクトのみ使用できます。
頂点データ定義を作成
XNA Framework 3.1 まではプログラムで明示的に作成する必要がありましたが、4.0 からはフレームワークに組み込まれている頂点情報に「IVertexType.VertexDeclaration」としてすでに組み込まれているのでそれを使うことにします。
エフェクトの作成
BasicEffect クラスを作成します。頂点の色をそのまま使用するために BasicEffect.VertexColorEnabled プロパティを true に設定します。
// エフェクトを作成
this.basicEffect = new BasicEffect(this.GraphicsDevice);
// エフェクトで頂点カラーを有効にする
this.basicEffect.VertexColorEnabled = true;
BasicEffect コンストラクタ
シェーダーモデル2.0を用いた頂点色、テクスチャー、ライティングを行うエフェクトクラス「BasicEffect」のインスタンスを作成します。
| device | GraphicsDevice | エフェクトを作成するための GraphicsDevice を指定します |
ビューマトリックスとプロジェクションマトリックス
BasicEffect にビューマトリックスとプロジェクションマトリックスを設定します。それぞれの概念的な説明に関しては下記のリンクを参照してください。
// ビューマトリックスをあらかじめ設定 ((0, 0, 15) から原点を見る)
this.basicEffect.View = Matrix.CreateLookAt(
new Vector3(0.0f, 0.0f, 15.0f),
Vector3.Zero,
Vector3.Up
);
// プロジェクションマトリックスをあらかじめ設定
this.basicEffect.Projection = Matrix.CreatePerspectiveFieldOfView(
MathHelper.ToRadians(45.0f),
(float)this.GraphicsDevice.Viewport.Width /
(float)this.GraphicsDevice.Viewport.Height,
1.0f,
100.0f
);
ビューマトリックスを生成するには「Matrix.CreateLookAt」メソッドを使用します。
第１引数にはカメラの位置、第２引数にはカメラの注視点、第３引数にはカメラの上方方向を指定します。
今回は(0, 0, 15)の位置から原点を見るように設定しています。
Matrix.CreateLookAt メソッド
ビューマトリックスを作成します。
| cameraPosition | Vector3 | カメラの位置 |
| cameraTarget | Vector3 | カメラの注視点 |
| cameraUpVector | Vector3 | カメラの上方方向 |
プロジェクションマトリックスを生成するには「Matrix.CreatePerspectiveFieldOfView」メソッドを使用します。
第１引数には視野角を radian の単位で指定します。サンプルでは degree の単位を「MathHelper.ToRadians」メソッドで radian に変換しています。Radian と Degree については「Radian と Degree」を参照して下さい。
第２引数にはアスペクト比(縦横比)を指定します。通常は「ビューの幅÷高さ」の値を指定します。サンプルではデバイスのビューポートに設定されている幅と高さから算出しています。
第３引数には前方クリップ位置、第４引数には後方クリップ位置を指定します。
Matrix.CreatePerspectiveFieldOfView メソッド
ビューフィールドの設定に基づいて透視射影マトリックスを作成します。
| fieldOfView | float | 視野角。radian の単位で指定します。 |
| aspectRatio | float | アスペクト比(縦横比)。通常は「ビューの幅÷高さ」の値を指定 |
| nearPlaneDistance | float | 前方クリップ位置。この位置より手前にあるオブジェクトは描画されません。 |
| farPlaneDistance | float | 後方クリップ位置。この位置より奥にあるオブジェクトは描画されません。 |
頂点データの作成
３つの頂点データを作成します。まずは配列を作成し、各々の頂点を作成していきます。
// 頂点データを作成する
this.vertices = new VertexPositionColor[3];
this.vertices[0] = new VertexPositionColor(new Vector3(0.0f, 3.0f, 0.0f),
Color.Red);
this.vertices[1] = new VertexPositionColor(new Vector3(3.0f, -2.0f, 0.0f),
Color.Blue);
this.vertices[2] = new VertexPositionColor(new Vector3(-3.0f, -2.0f, 0.0f),
Color.Green);
頂点データの作成には「VertexPositionColor」のコンストラクタに「頂点の位置」と「頂点の色」を指定します。
VertexPositionColor コンストラクタ
位置と色の頂点データを持つ構造体「VertexPositionColor」のインスタンスを作成します。
| position | Vector3 | 頂点の位置 |
| color | Color | 頂点の色 |
頂点の位置はカメラから見る範囲に設定してください。また、頂点の並びは「右回り(時計まわり)」に配置されるように設定してください。「左回り(反時計回り)」に設定するとポリゴンが見えなくなります。これについての説明は「ポリゴンの描画する面を指定する」を参照してください。
ポリゴンの描画
// パスの数だけ繰り替えし描画 (といっても直接作成した BasicEffect は通常１回)
foreach (EffectPass pass in this.basicEffect.CurrentTechnique.Passes)
{
// パスの開始
pass.Apply();
// ポリゴンを描画する
this.GraphicsDevice.DrawUserPrimitives(
PrimitiveType.TriangleList,
this.vertices,
0,
1
);
}
// 登録された DrawableGameComponent を描画する
base.Draw(gameTime);
エフェクトには「テクニック」と「パス」と呼ばれるものがあり、パスを通して実際の描画プログラムを実行します。パスは一つのエフェクトに複数含まれていることがあるので、foreach で繰り返し呼ぶようにしています。ただし、BasicEffect ではテクニックとパスは一つずつなので直接パスのインデックスを指定することもできますが、上記の記述の方が他のエフェクトでも代用できるのですっきりするでしょう。
実際の描画を始める前に「EffectPass.Apply」メソッドを呼び出してパスを開始します。このメソッドを呼ぶことによってグラフィックデバイスに対して今回使用するエフェクトのパラメータなどを適用させます。
パスを開始したら、「GraphicsDevice.DrawUserPrimitives」メソッドでポリゴンを描画します。
第１引数には描画するプリミティブの種類を指定します。今回は三角形ポリゴンを描画するので「PrimitiveType.TriangleList」を指定します。
第２引数には作成した頂点データを指定します。
第３引数には何番目の頂点から描画するかを指定します。通常は 0 を指定します。
第４引数には描画するプリミティブの数を指定します。今回は三角形ポリゴンが１枚なので 1 を指定します。頂点数ではないことに注意してください。
GraphicsDevice.DrawUserPrimitives メソッド
ユーザーが指定した頂点データに基づいてプリミティブを描画します。
| T | 制限なし | 頂点データ構造体 |
| primitiveType | PrimitiveType | 描画するプリミティブの種類 |
| vertexData | T[] | 描画する頂点データの配列 |
| vertexOffset | int | 何番目からの頂点データを描画に使用するかを指定する |
| primitiveCount | int | 描画するプリミティブの数。 |
これで描画プログラムは以上です。実際に実行させて三角形が表示されれば完了です。
全コード
using System;
using System.Collections.Generic;
using System.Linq;
using Microsoft.Xna.Framework;
using Microsoft.Xna.Framework.Audio;
using Microsoft.Xna.Framework.Content;
using Microsoft.Xna.Framework.GamerServices;
using Microsoft.Xna.Framework.Graphics;
using Microsoft.Xna.Framework.Input;
using Microsoft.Xna.Framework.Media;
#if WINDOWS_PHONE
using Microsoft.Xna.Framework.Input.Touch;
#endif
namespace DrawTriangle
{
<summary>
ゲームメインクラス
</summary>
public class GameMain : Microsoft.Xna.Framework.Game
{
<summary>
グラフィックデバイス管理クラス
</summary>
private GraphicsDeviceManager graphics = null;
<summary>
スプライトのバッチ化クラス
</summary>
private SpriteBatch spriteBatch = null;
<summary>
頂点データリスト
</summary>
private VertexPositionColor[] vertices = null;
<summary>
基本エフェクト
</summary>
private BasicEffect basicEffect = null;
<summary>
GameMain コンストラクタ
</summary>
public GameMain()
{
// グラフィックデバイス管理クラスの作成
this.graphics = new GraphicsDeviceManager(this);
// ゲームコンテンツのルートディレクトリを設定
this.Content.RootDirectory = "Content";
#if WINDOWS_PHONE
// Windows Phone のデフォルトのフレームレートは 30 FPS
this.TargetElapsedTime = TimeSpan.FromTicks(333333);
// バックバッファサイズの設定
this.graphics.PreferredBackBufferWidth = 480;
this.graphics.PreferredBackBufferHeight = 800;
// フルスクリーン表示
this.graphics.IsFullScreen = true;
#endif
}
<summary>
ゲームが始まる前の初期化処理を行うメソッド
グラフィック以外のデータの読み込み、コンポーネントの初期化を行う
</summary>
protected override void Initialize()
{
// TODO: ここに初期化ロジックを書いてください
// コンポーネントの初期化などを行います
base.Initialize();
}
<summary>
ゲームが始まるときに一回だけ呼ばれ
すべてのゲームコンテンツを読み込みます
</summary>
protected override void LoadContent()
{
// テクスチャーを描画するためのスプライトバッチクラスを作成します
this.spriteBatch = new SpriteBatch(this.GraphicsDevice);
// エフェクトを作成
this.basicEffect = new BasicEffect(this.GraphicsDevice);
// エフェクトで頂点カラーを有効にする
this.basicEffect.VertexColorEnabled = true;
// ビューマトリックスをあらかじめ設定 ((0, 0, 15) から原点を見る)
this.basicEffect.View = Matrix.CreateLookAt(
new Vector3(0.0f, 0.0f, 15.0f),
Vector3.Zero,
Vector3.Up
);
// プロジェクションマトリックスをあらかじめ設定
this.basicEffect.Projection = Matrix.CreatePerspectiveFieldOfView(
MathHelper.ToRadians(45.0f),
(float)this.GraphicsDevice.Viewport.Width /
(float)this.GraphicsDevice.Viewport.Height,
1.0f,
100.0f
);
// 頂点データを作成する
this.vertices = new VertexPositionColor[3];
this.vertices[0] = new VertexPositionColor(new Vector3(0.0f, 3.0f, 0.0f),
Color.Red);
this.vertices[1] = new VertexPositionColor(new Vector3(3.0f, -2.0f, 0.0f),
Color.Blue);
this.vertices[2] = new VertexPositionColor(new Vector3(-3.0f, -2.0f, 0.0f),
Color.Green);
}
<summary>
ゲームが終了するときに一回だけ呼ばれ
すべてのゲームコンテンツをアンロードします
</summary>
protected override void UnloadContent()
{
// TODO: ContentManager で管理されていないコンテンツを
// ここでアンロードしてください
}
<summary>
描画以外のデータ更新等の処理を行うメソッド
主に入力処理、衝突判定などの物理計算、オーディオの再生など
</summary>
<param name="gameTime">このメソッドが呼ばれたときのゲーム時間</param>
protected override void Update(GameTime gameTime)
{
// Xbox 360 コントローラ、Windows Phone の BACK ボタンを押したときに
// ゲームを終了させます
if (GamePad.GetState(PlayerIndex.One).Buttons.Back == ButtonState.Pressed)
{
this.Exit();
}
// TODO: ここに更新処理を記述してください
// 登録された GameComponent を更新する
base.Update(gameTime);
}
<summary>
描画処理を行うメソッド
</summary>
<param name="gameTime">このメソッドが呼ばれたときのゲーム時間</param>
protected override void Draw(GameTime gameTime)
{
// 画面を指定した色でクリアします
this.GraphicsDevice.Clear(Color.CornflowerBlue);
// パスの数だけ繰り替えし描画 (といっても直接作成した BasicEffect は通常１回)
foreach (EffectPass pass in this.basicEffect.CurrentTechnique.Passes)
{
// パスの開始
pass.Apply();
// ポリゴンを描画する
this.GraphicsDevice.DrawUserPrimitives(
PrimitiveType.TriangleList,
this.vertices,
0,
1
);
}
// 登録された DrawableGameComponent を描画する
base.Draw(gameTime);
}
}
}