kinugasa.contents.graphics

## クラス SpriteSheet

- java.lang.Object
- - kinugasa.contents.graphics.SpriteSheet

-     public class SpriteSheet
      extends java.lang.Object

  1つの画像リソースを切り出して、複数の画像インスタンスを構築するためのビルダです.
  同一のアルゴリズムで複数のスプライトシートを構築する場合はSpriteSheetCutterを使用してください。

- - ### コンストラクタのサマリー

    コンストラクタ
    コンストラクタと説明
    `SpriteSheet()` 空のスプライトシートを作成します.
    `SpriteSheet(java.awt.image.BufferedImage baseImage)` 新しいスプライトシートを構築します.
    `SpriteSheet(java.lang.String filePath)` 新しいスプライトシートを構築します.

  - ### メソッドのサマリー

    All Methods Instance Methods Concrete Methods
    修飾子とタイプ | メソッドと説明
    --- | ---
    `SpriteSheet` | `add(java.awt.image.BufferedImage image)` 指定された画像を追加します.
    `SpriteSheet` | `addAll(java.awt.image.BufferedImage... images)` 指定された0個以上の画像を全てその順序でリストに追加します.
    `SpriteSheet` | `baseImage()` ベース画像本体をリストに追加します.
    `SpriteSheet` | `columns(int x, int width, int height)` 座標x,0からwidth,heightのサイズでY方向に可能な数だけ画像を分割し、全ての部分画像をリストに追加します.
    `SpriteSheet` | `cut(int x, int y, int width, int height)` ベース画像の指定された領域を切り出して新しい画像とします.
    `SpriteSheet` | `cut(java.awt.Rectangle rectangle)` ベース画像の指定された領域を切り出して新しい画像とします.
    `SpriteSheet` | `cut(SpriteSheetCutter cutter)` 切り出しアルゴリズムに基づいて、このシートを切り出します.
    `java.awt.image.BufferedImage[]` | `images()` 操作を確定し、追加されている全ての画像を追加された順序の配列として取得します.
    `SpriteSheet` | `resizeAll(float scale)`
    `SpriteSheet` | `rows(int y, int width, int height)` 座標0,yからwidth,heightのサイズでX方向に可能な数だけ画像を分割し、全ての部分画像をリストに追加します.
    `SpriteSheet` | `split(int width, int height)` 座標0,0からwidth,heightのサイズで二次元に可能な数だけ分割し、全ての部分画像をリストに追加します.
    `java.util.Map<java.lang.String,java.awt.image.BufferedImage>` | `toMap()` 操作を確定し、追加されている全ての画像を追加された順序の連番をキーとしたマップとして取得します.
    `java.lang.String` | `toString()`

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### SpriteSheet

          public SpriteSheet()

      空のスプライトシートを作成します.

    - #### SpriteSheet

          public SpriteSheet(java.lang.String filePath)

      新しいスプライトシートを構築します.
      パラメータ:
        `filePath` - ロードする画像のパスを指定します。 このコンストラクタでは、ImageUtilのloadメソッドを使用して画像がロードされます。

    - #### SpriteSheet

          public SpriteSheet(java.awt.image.BufferedImage baseImage)

      新しいスプライトシートを構築します.
      パラメータ:
        `baseImage` - ベースとなる画像を指定します。

  - ### メソッドの詳細

    - #### cut

          public SpriteSheet cut(int x,
                                 int y,
                                 int width,
                                 int height)
                          throws java.awt.image.RasterFormatException

      ベース画像の指定された領域を切り出して新しい画像とします.
      パラメータ:
        `x` - X座標.
        `y` - Y座標.
        `width` - 幅.
        `height` - 高さ.
      戻り値:
        このインスタンス自体が返る.
      例外:
        `java.awt.image.RasterFormatException` - 画像の範囲外にアクセスしたときに投げられる.

    - #### cut

          public SpriteSheet cut(java.awt.Rectangle rectangle)
                          throws java.awt.image.RasterFormatException

      ベース画像の指定された領域を切り出して新しい画像とします.
      パラメータ:
        `rectangle` - 領域.
      戻り値:
        このインスタンス自体が返る.
      例外:
        `java.awt.image.RasterFormatException` - 画像の範囲外にアクセスしたときに投げられる.

    - #### resizeAll

          public SpriteSheet resizeAll(float scale)

    - #### cut

          public SpriteSheet cut(SpriteSheetCutter cutter)
                          throws java.awt.image.RasterFormatException

      切り出しアルゴリズムに基づいて、このシートを切り出します.
      パラメータ:
        `cutter` - 特定の切り出し設定アルゴリズム.
      戻り値:
        このインスタンス自体が返る.
      例外:
        `java.awt.image.RasterFormatException` - 画像の範囲外にアクセスしたときに投げられる.

    - #### split

          public SpriteSheet split(int width,
                                   int height)
                            throws java.awt.image.RasterFormatException

      座標0,0からwidth,heightのサイズで二次元に可能な数だけ分割し、全ての部分画像をリストに追加します.
      パラメータ:
        `width` - 幅.
        `height` - 高さ.
      戻り値:
        このインスタンス自体が返る.
      例外:
        `java.awt.image.RasterFormatException` - 画像の範囲外にアクセスしたときに投げられる.

    - #### rows

          public SpriteSheet rows(int y,
                                  int width,
                                  int height)
                           throws java.awt.image.RasterFormatException

      座標0,yからwidth,heightのサイズでX方向に可能な数だけ画像を分割し、全ての部分画像をリストに追加します.
      パラメータ:
        `y` - Y座標.
        `width` - 幅.
        `height` - 高さ.
      戻り値:
        このインスタンス自体が返る.
      例外:
        `java.awt.image.RasterFormatException` - 画像の範囲外にアクセスしたときに投げられる.

    - #### columns

          public SpriteSheet columns(int x,
                                     int width,
                                     int height)
                              throws java.awt.image.RasterFormatException

      座標x,0からwidth,heightのサイズでY方向に可能な数だけ画像を分割し、全ての部分画像をリストに追加します.
      パラメータ:
        `x` - X座標.
        `width` - 幅.
        `height` - 高さ.
      戻り値:
        このインスタンス自体が返る.
      例外:
        `java.awt.image.RasterFormatException` - 画像の範囲外にアクセスしたときに投げられる.

    - #### add

          public SpriteSheet add(java.awt.image.BufferedImage image)

      指定された画像を追加します.
      パラメータ:
        `image` - 画像.
      戻り値:
        このインスタンス自体が返る.

    - #### addAll

          public SpriteSheet addAll(java.awt.image.BufferedImage... images)

      指定された0個以上の画像を全てその順序でリストに追加します.
      パラメータ:
        `images` - 画像.
      戻り値:
        このインスタンス自体が返る.

    - #### baseImage

          public SpriteSheet baseImage()

      ベース画像本体をリストに追加します.
      戻り値:
        このインスタンス自体が返る.

    - #### images

          public java.awt.image.BufferedImage[] images()

      操作を確定し、追加されている全ての画像を追加された順序の配列として取得します. この操作では、nullインスタンスのsubImageは切り捨てられます。
      戻り値:
        追加されている画像の配列.

    - #### toMap

          public java.util.Map<java.lang.String,java.awt.image.BufferedImage> toMap()

      操作を確定し、追加されている全ての画像を追加された順序の連番をキーとしたマップとして取得します.
      戻り値:
        追加されている画像のマップ。

    - #### toString

          public java.lang.String toString()

      オーバーライド:
        `toString` クラス内 `java.lang.Object`