概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## kinugasa.game
クラス KinugasaGame

    java.lang.Object
      kinugasa.game.Game
          kinugasa.game.KinugasaGame

すべての実装されたインタフェース:
  Nameable

直系の既知のサブクラス:
  MyGame

    public abstract class KinugasaGame

extends Game

衣笠ゲームフレームワークの核となるゲームクラスの基本の実装です.
衣笠フレームワークを使用してゲームを構築するには、このクラスを継承したゲームクラスを用意します。

バージョン:
  1.0.0 - 2013/04/20_18:54:20
作成者:
  Dra0211

フィールドの概要
`private java.awt.Rectangle` | `clippingRectangle` 描画時にグラフィックスコンテキストをクリッピングするための ウインドウの内部領域です.
`private int` | `fps` gameTimeMangerに設定するFPSの最大値です.
`private GameTimeManager` | `gameTimeManager` ゲームのFPSを管理するクラスです.
`private java.awt.image.BufferStrategy` | `graphicsBuffer` グラフィックスコンテキストのバッファです.
`private java.awt.Graphics2D` | `graphicsContext` あるフレームにおいてウインドウに描画するための グラフィックスコンテキストです.
`private GameLoop` | `loop` ゲームを実行するスレッドです.
`private java.awt.RenderingHints` | `renderingHints` レンダリングの品質です.
`private boolean` | `started` ゲームの起動と終了を1回に制限するためのフラグです.
`private AWTGameWindow` | `window` ゲームを表示するウインドウです.

クラス kinugasa.game.Game から継承されたフィールド
`name`

コンストラクタの概要
`protected` | `KinugasaGame(GameConfig conf)` ゲームを作成します.このコンストラクタを呼び出しただけでは、ゲームは起動しません.
`` | `KinugasaGame(java.lang.String name)` 簡易コンストラクタです.

メソッドの概要
`protected abstract void` | `dispose()` ゲームの終了前処理を定義します.
`protected abstract void` | `draw(java.awt.Graphics2D g)` ゲームの再描画を行うメソッドです.
`void` | `gameExit()` このメソッドを呼び出すことで、ゲームを終了します.
`protected void` | `gameStart()` このメソッドを呼び出すことで、ゲームを起動します.
`GameTimeManager` | `getGameTimeManager()` ゲームの時間管理クラスを取得します.
`GameWindow` | `getWindow()` ゲームのGUI設定を取得します.
`static void` | `main(java.lang.String[] args)` バージョン情報を出力します.
`(package private) void` | `repaint()` ゲームループが、再描画処理を要求するために使用するメソッドです.
`protected abstract void` | `startUp()` ゲームの初期化処理を定義します.
`java.lang.String` | `toString()`
`protected abstract void` | `update()` ゲームの更新処理を定義します.

クラス kinugasa.game.Game から継承されたメソッド
`getName`

クラス java.lang.Object から継承されたメソッド
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

フィールドの詳細

### window

    private AWTGameWindow window

  ゲームを表示するウインドウです.

### graphicsBuffer

    private java.awt.image.BufferStrategy graphicsBuffer

  グラフィックスコンテキストのバッファです.

### graphicsContext

    private java.awt.Graphics2D graphicsContext

  あるフレームにおいてウインドウに描画するための グラフィックスコンテキストです.

### renderingHints

    private java.awt.RenderingHints renderingHints

  レンダリングの品質です.

### loop

    private GameLoop loop

  ゲームを実行するスレッドです.

### gameTimeManager

    private GameTimeManager gameTimeManager

  ゲームのFPSを管理するクラスです.

### clippingRectangle

    private java.awt.Rectangle clippingRectangle

  描画時にグラフィックスコンテキストをクリッピングするための ウインドウの内部領域です.

### fps

    private int fps

  gameTimeMangerに設定するFPSの最大値です.

### started

    private boolean started

  ゲームの起動と終了を1回に制限するためのフラグです.

コンストラクタの詳細

### KinugasaGame

    protected KinugasaGame(GameConfig conf)

  ゲームを作成します.このコンストラクタを呼び出しただけでは、ゲームは起動しません.

  パラメータ:
    `conf` - ゲームの設定を送信します。ウインドウのサイズやFPSの設定が含まれます。

### KinugasaGame

    public KinugasaGame(java.lang.String name)

  簡易コンストラクタです. ウインドウサイズや背景色はstartUpメソッドで設定する必要があります。

  パラメータ:
    `name` - ゲームウインドウのタイトルとなる文字列です。ゲームの名前としても設定されます。

メソッドの詳細

### gameStart

    protected final void gameStart()
                            throws java.lang.IllegalStateException

  クラス `Game` の記述:
  このメソッドを呼び出すことで、ゲームを起動します. このメソッドは、ゲームの起動時に1度だけコールするようにしてください。
  通常は、メインメソッドで必要なシステムプロパティを設定した後、ゲームクラスの 作成に続いてこのメソッドを呼び出します。
  GUIやフィールドの初期化後、ループを起動してください。ループがstartUp()を呼び出すため、
  startUp()を明示的に呼び出す必要はありません。

  定義:
    クラス `Game` 内の `gameStart`
  例外:
    `java.lang.IllegalStateException` - ゲームがすでに起動している場合に投げられます。

### gameExit

    public final void gameExit()
                        throws java.lang.IllegalStateException

  クラス `Game` の記述:
  このメソッドを呼び出すことで、ゲームを終了します. ウインドウのクローズイベントやゲーム中のイベントとして このメソッドをコールすることができます。
  このメソッドはdispose()を起動したあと、アプリケーションを終了させます。

  定義:
    クラス `Game` 内の `gameExit`
  例外:
    `java.lang.IllegalStateException` - ゲームがすでに起動している場合に投げられます。

### repaint

    final void repaint()

  クラス `Game` の記述:
  ゲームループが、再描画処理を要求するために使用するメソッドです. このメソッドを呼び出すことで、グラフィックスコンテキストを作成し、draw(Graphics2D)を呼び出すように してください。

  定義:
    クラス `Game` 内の `repaint`

### startUp

    protected abstract void startUp()

  クラス `Game` の記述:
  ゲームの初期化処理を定義します. このメソッドは、ゲームの起動時（gameStartをコールした後）に必ず1度だけ実行されます。
  コンテンツのロードやフィールドの初期化処理を定義してください。

  定義:
    クラス `Game` 内の `startUp`

### dispose

    protected abstract void dispose()

  クラス `Game` の記述:
  ゲームの終了前処理を定義します. このメソッドは、ウインドウを閉じたり、ゲーム中のイベントによってgameExit()が呼ばれた場合に 1度だけ実行されます。コンテンツの解放や途中経過の保存を定義してください。

  定義:
    クラス `Game` 内の `dispose`

### update

    protected abstract void update()

  クラス `Game` の記述:
  ゲームの更新処理を定義します. このメソッドは、ゲーム実行中のdraw(Graphics2D)がコールされる前に毎回呼ばれます。
  ワールドの更新や座標の変更処理を定義してください。

  定義:
    クラス `Game` 内の `update`

### draw

    protected abstract void draw(java.awt.Graphics2D g)

  クラス `Game` の記述:
  ゲームの再描画を行うメソッドです. このメソッドは、repaint()メソッドから呼ばれます。このメソッドは、実装によっては 1フレーム中に何度もコールされることがあります。

  定義:
    クラス `Game` 内の `draw`
  パラメータ:
    `g` - 書き込むグラフィックスコンテキスト.

### getWindow

    public final GameWindow getWindow()

  クラス `Game` の記述:
  ゲームのGUI設定を取得します. このメソッドによって返されるWindowインスタンスに操作を行うことで、 ウインドウの状態を変更することができます。

  定義:
    クラス `Game` 内の `getWindow`
  戻り値:
    このゲームで使用されているWindowの実装が返されます.

### getGameTimeManager

    public final GameTimeManager getGameTimeManager()

  クラス `Game` の記述:
  ゲームの時間管理クラスを取得します. このメソッドによって返されるGameTimeManagerに操作を行うことで FPSの変更や経過時間の取得ができます。

  定義:
    クラス `Game` 内の `getGameTimeManager`
  戻り値:
    このゲームで使用されているGameTimeManagerが返されます.

### toString

    public java.lang.String toString()

  オーバーライド:
    クラス `Game` 内の `toString`

### main

    public static void main(java.lang.String[] args)

  バージョン情報を出力します.

  パラメータ:
    `args` - コマンドライン引数は無視されます。

概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド