kinugasa.rpgui

## クラス FieldMap

- java.lang.Object
- - kinugasa.object.Sprite
  - - kinugasa.object.BasicSprite
    - - kinugasa.rpgui.FieldMap

- すべての実装されたインタフェース:
    java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<Sprite>, java.lang.Iterable<FieldMapLayer>, Disposable, Nameable, Controllable, Drawable, Shapeable

      public class FieldMap
      extends BasicSprite
      implements java.lang.Iterable<FieldMapLayer>, Disposable

  フィールドマップの本体で、表示できる全てのデータを持ちます.
  フィールドマップは複合スプライトのような構造になっています。 フィールドマップに対する座標や移動速度の設定は全ての子スプライトに 反映されます。子スプライトは背景と、フィールドマップレイヤがあります。
  関連項目:
    直列化された形式

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

    コンストラクタ
    コンストラクタと説明
    `FieldMap(FieldMapBuilder fieldMapBuilder, BackgroundLayerSprite backgroundLayerSprite, FieldMapLayer... fieldMapLayers)`
    `FieldMap(FieldMapBuilder fieldMapBuilder, BackgroundLayerSprite backgroundLayerSprite, java.util.List<FieldMapLayer> fieldMapLayers)`

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

    All Methods Instance Methods Concrete Methods
    修飾子とタイプ | メソッドと説明
    --- | ---
    `void` | `dispose()` コンテンツをメモリから破棄します.
    `void` | `draw(java.awt.Graphics2D g2)` スプライトを描画します.
    `java.util.List<ChipAttribute>` | `getAttribute(int x, int y)`
    `BackgroundLayerSprite` | `getBackgroundLayerSprite()`
    `java.util.List<MapChip>` | `getChip(int x, int y)`
    `int` | `getChipHeight()`
    `int` | `getChipWidth()`
    `FieldMapBuilder` | `getFieldMapBuilder()`
    `java.util.List<FieldMapLayer>` | `getFieldMapLayers()`
    `NodeMap` | `getNodeMap()`
    `SoundMap` | `getSoundMap()`
    `java.util.Iterator<FieldMapLayer>` | `iterator()`
    `void` | `move()` オブジェクトに設定されているパラメータおよびアルゴリズムを使用して移動します.
    `boolean` | `move(float xValue, float yValue, java.awt.Shape s)` 入力デバイスからの値によって、オブジェクトを移動します.
    `void` | `move(MovingModel m)` 指定のアルゴリズムを使用して移動します.
    `boolean` | `move(java.awt.geom.Point2D.Float p, java.awt.Shape s)` 入力デバイスからの値によって、オブジェクトを移動します.
    `void` | `setAngle(float angle)`
    `void` | `setBounds(float x, float y, float width, float height)` このスプライトの領域を設定します.
    `void` | `setBounds(java.awt.geom.Point2D.Float location, float width, float height)` このスプライトの領域を設定します.
    `void` | `setBounds(java.awt.geom.Rectangle2D.Float bounds)` このスプライトの領域を設定します.
    `void` | `setLocation(float x, float y)` スプライトの左上の位置を設定します.
    `void` | `setLocation(java.awt.geom.Point2D.Float location)` スプライトの左上の位置を設定します.
    `void` | `setMovingModel(MovingModel movingModel)` 移動モデルを設定します.
    `void` | `setSpeed(float speed)`
    `void` | `setVector(VectorF vector)`
    `void` | `setVisible(boolean visible)` スプライトの可視状態を設定します.
    `void` | `setX(float x)` このスプライトの左上のX座標を設定します.
    `void` | `setY(float y)` このスプライトの左上のY座標を設定します.
    `boolean` | `stepOn(int x, int y)`
    `boolean` | `stepOn(Vehicle vehicle, int x, int y)`
    `java.lang.String` | `toString()` スプライトの文字列表記を取得します.

    - ### クラスから継承されたメソッド kinugasa.object.BasicSprite

      `clone, getAngle, getMovingModel, getMovingModel, getNextCenter, getNextLocation, getSpeed, getVector`

    - ### クラスから継承されたメソッド kinugasa.object.Sprite

      `compareTo, contains, getBounds, getCenter, getCenterX, getCenterY, getHeight, getHitBounds, getLocation, getName, getPersonalCenter, getPersonalCenterX, getPersonalCenterY, getSize, getWidth, getX, getY, getZ, isExist, isVisible, setExist, setHeight, setName, setSize, setSize, setWidth, setZ, update, updateCenter, updatePersonalCenter`

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

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

    - ### インタフェースから継承されたメソッド java.lang.Iterable

      `forEach, spliterator`

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

    - #### FieldMap

          public FieldMap(FieldMapBuilder fieldMapBuilder,
                          BackgroundLayerSprite backgroundLayerSprite,
                          java.util.List<FieldMapLayer> fieldMapLayers)

    - #### FieldMap

          public FieldMap(FieldMapBuilder fieldMapBuilder,
                          BackgroundLayerSprite backgroundLayerSprite,
                          FieldMapLayer... fieldMapLayers)

  - ### メソッドの詳細

    - #### getChip

          public java.util.List<MapChip> getChip(int x,
                                                 int y)
                                          throws java.lang.ArrayIndexOutOfBoundsException

      例外:
        `java.lang.ArrayIndexOutOfBoundsException`

    - #### getAttribute

          public java.util.List<ChipAttribute> getAttribute(int x,
                                                            int y)
                                                     throws java.lang.ArrayIndexOutOfBoundsException

      例外:
        `java.lang.ArrayIndexOutOfBoundsException`

    - #### stepOn

          public boolean stepOn(int x,
                                int y)

    - #### stepOn

          public boolean stepOn(Vehicle vehicle,
                                int x,
                                int y)

    - #### dispose

          public void dispose()

      インタフェースからコピーされた説明: `Disposable`
      コンテンツをメモリから破棄します.
      定義:
        `dispose` インタフェース内 `Disposable`

    - #### draw

          public void draw(java.awt.Graphics2D g2)

      クラスからコピーされた説明: `BasicSprite`
      スプライトを描画します. visibleまたはexistがfalseのとき、描画してはなりません.
      定義:
        `draw` インタフェース内 `Drawable`
      定義:
        `draw` クラス内 `BasicSprite`
      パラメータ:
        `g2` - グラフィックスコンテキスト.

    - #### getBackgroundLayerSprite

          public BackgroundLayerSprite getBackgroundLayerSprite()

    - #### getFieldMapLayers

          public java.util.List<FieldMapLayer> getFieldMapLayers()

    - #### getFieldMapBuilder

          public FieldMapBuilder getFieldMapBuilder()

    - #### getSoundMap

          public SoundMap getSoundMap()

    - #### getNodeMap

          public NodeMap getNodeMap()

    - #### getChipWidth

          public int getChipWidth()

    - #### getChipHeight

          public int getChipHeight()

    - #### move

          public void move()

      クラスからコピーされた説明: `BasicSprite`
      オブジェクトに設定されているパラメータおよびアルゴリズムを使用して移動します.
      オーバーライド:
        `move` クラス内 `BasicSprite`

    - #### move

          public void move(MovingModel m)

      クラスからコピーされた説明: `BasicSprite`
      指定のアルゴリズムを使用して移動します.
      オーバーライド:
        `move` クラス内 `BasicSprite`
      パラメータ:
        `m` - 移動方法.

    - #### move

          public boolean move(java.awt.geom.Point2D.Float p,
                              java.awt.Shape s)

      インタフェースからコピーされた説明: `Controllable`
      入力デバイスからの値によって、オブジェクトを移動します.
      定義:
        `move` インタフェース内 `Controllable`
      オーバーライド:
        `move` クラス内 `BasicSprite`
      パラメータ:
        `p` - -1.0~1.0の間のXおよびY軸の入力値.キー操作では-1.0または1.0、ゲームパッドを使用すると可変の値が送信される.
        `s` - このオブジェクトが移動可能な領域.nullでない場合はこの領域から出てはならない.
      戻り値:
        移動後のオブジェクトがs内に存在する場合はtrueを、sから出る(contains()がfalse)ため、移動できなかった場合はfalseを返す.

    - #### move

          public boolean move(float xValue,
                              float yValue,
                              java.awt.Shape s)

      インタフェースからコピーされた説明: `Controllable`
      入力デバイスからの値によって、オブジェクトを移動します.
      定義:
        `move` インタフェース内 `Controllable`
      オーバーライド:
        `move` クラス内 `BasicSprite`
      パラメータ:
        `xValue` - -1.0~1.0の間の入力値.キー操作では-1.0または1.0、ゲームパッドを使用すると可変の値が送信される.
        `yValue` - -1.0~1.0の間の入力値.キー操作では-1.0または1.0、ゲームパッドを使用すると可変の値が送信される.
        `s` - このオブジェクトが移動可能な領域.nullでない場合はこの領域から出てはならない.
      戻り値:
        移動後のオブジェクトがs内に存在する場合はtrueを、sから出る(contains()がfalse)ため、移動できなかった場合はfalseを返す.

    - #### setLocation

          public void setLocation(java.awt.geom.Point2D.Float location)

      クラスからコピーされた説明: `Sprite`
      スプライトの左上の位置を設定します.
      オーバーライド:
        `setLocation` クラス内 `Sprite`
      パラメータ:
        `location` - 左上の位置.

    - #### setLocation

          public void setLocation(float x,
                                  float y)

      クラスからコピーされた説明: `Sprite`
      スプライトの左上の位置を設定します.
      オーバーライド:
        `setLocation` クラス内 `Sprite`
      パラメータ:
        `x` - X座標.
        `y` - Y座標.

    - #### setX

          public void setX(float x)

      クラスからコピーされた説明: `Sprite`
      このスプライトの左上のX座標を設定します.
      オーバーライド:
        `setX` クラス内 `Sprite`
      パラメータ:
        `x` - X座標.

    - #### setY

          public void setY(float y)

      クラスからコピーされた説明: `Sprite`
      このスプライトの左上のY座標を設定します.
      オーバーライド:
        `setY` クラス内 `Sprite`
      パラメータ:
        `y` - Y座標.

    - #### setAngle

          public void setAngle(float angle)

      オーバーライド:
        `setAngle` クラス内 `BasicSprite`

    - #### setSpeed

          public void setSpeed(float speed)

      オーバーライド:
        `setSpeed` クラス内 `BasicSprite`

    - #### setVector

          public void setVector(VectorF vector)

      オーバーライド:
        `setVector` クラス内 `BasicSprite`

    - #### setBounds

          public void setBounds(java.awt.geom.Rectangle2D.Float bounds)

      クラスからコピーされた説明: `Sprite`
      このスプライトの領域を設定します.
      オーバーライド:
        `setBounds` クラス内 `Sprite`
      パラメータ:
        `bounds` - スプライトの領域.

    - #### setBounds

          public void setBounds(java.awt.geom.Point2D.Float location,
                                float width,
                                float height)

      クラスからコピーされた説明: `Sprite`
      このスプライトの領域を設定します.
      オーバーライド:
        `setBounds` クラス内 `Sprite`
      パラメータ:
        `location` - 位置を指定します。
        `width` - 幅です。
        `height` - 高さです。

    - #### setBounds

          public void setBounds(float x,
                                float y,
                                float width,
                                float height)

      クラスからコピーされた説明: `Sprite`
      このスプライトの領域を設定します.
      オーバーライド:
        `setBounds` クラス内 `Sprite`
      パラメータ:
        `x` - X位置です。
        `y` - Y位置です。
        `width` - 幅です。
        `height` - 高さです。

    - #### setMovingModel

          public void setMovingModel(MovingModel movingModel)

      クラスからコピーされた説明: `BasicSprite`
      移動モデルを設定します.
      オーバーライド:
        `setMovingModel` クラス内 `BasicSprite`
      パラメータ:
        `movingModel` - 移動モデル.

    - #### setVisible

          public void setVisible(boolean visible)

      クラスからコピーされた説明: `Sprite`
      スプライトの可視状態を設定します.
      オーバーライド:
        `setVisible` クラス内 `Sprite`
      パラメータ:
        `visible` - スプライトの可視状態.

    - #### toString

          public java.lang.String toString()

      クラスからコピーされた説明: `BasicSprite`
      スプライトの文字列表記を取得します. 文字列にはスプライトのフィールド情報が含まれています.これらの値はすべてアクセサを通して取得可能です.
      オーバーライド:
        `toString` クラス内 `BasicSprite`
      戻り値:
        スプライトの情報.

    - #### iterator

          public java.util.Iterator<FieldMapLayer> iterator()

      定義:
        `iterator` インタフェース内 `java.lang.Iterable<FieldMapLayer>`