kinugasa.object

## 列挙型 SpriteSortMode

- java.lang.Object
- - java.lang.Enum<SpriteSortMode>
  - - kinugasa.object.SpriteSortMode

- すべての実装されたインタフェース:
    java.io.Serializable, java.lang.Comparable<SpriteSortMode>, java.util.Comparator<Sprite>

      public enum SpriteSortMode
      extends java.lang.Enum<SpriteSortMode>
      implements java.util.Comparator<Sprite>

  CompositeSpriteのソート方向を指定するコンパレータです.

- - ### 列挙型定数のサマリー

    列挙型定数
    列挙型定数と説明
    `BACK_TO_FRONT` この列挙を指定すると、描画順はZ軸座標の小さい順になります.
    `FRONT_TO_BACK` この列挙を指定すると、描画順はZ軸座標の大きい順になります.
    `RANDOM` この列挙を指定すると、使用するたびに異なる滅茶苦茶な順番に並び替えます.

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

    All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
    修飾子とタイプ | メソッドと説明
    --- | ---
    `abstract int` | `compare(Sprite s1, Sprite s2)`
    `static SpriteSortMode` | `valueOf(java.lang.String name)` 指定した名前を持つこの型の列挙型定数を返します。
    `static SpriteSortMode[]` | `values()` この列挙型の定数を含む配列を宣言されている順序で返します。

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

      `clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

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

      `getClass, notify, notifyAll, wait, wait, wait`

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

      `comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong`

- - ### 列挙型定数の詳細

    - #### FRONT_TO_BACK

          public static final SpriteSortMode FRONT_TO_BACK

      この列挙を指定すると、描画順はZ軸座標の大きい順になります. したがって、Z軸座標の小さなスプライトが手前に表示されます.

    - #### BACK_TO_FRONT

          public static final SpriteSortMode BACK_TO_FRONT

      この列挙を指定すると、描画順はZ軸座標の小さい順になります. したがって、Z軸座標の大きなスプライトが手前に表示されます.

    - #### RANDOM

          public static final SpriteSortMode RANDOM

      この列挙を指定すると、使用するたびに異なる滅茶苦茶な順番に並び替えます. この列挙は衣笠乱数ジェネレータ（kinugasa.util.Random）を使用します.

  - ### メソッドの詳細

    - #### values

          public static SpriteSortMode[] values()

      この列挙型の定数を含む配列を宣言されている順序で返します。 このメソッドは次のようにして定数を反復するために 使用できます:

          for(SpriteSortMode c: SpriteSortMode.values())
            System.out.println(c);

      戻り値:
        この列挙型の定数を含む、宣言されている順序での配列

    - #### valueOf

          public static SpriteSortMode valueOf(java.lang.String name)

      指定した名前を持つこの型の列挙型定数を返します。 文字列は、この型の列挙型定数を宣言するのに使用した識別子と正確に 一致している必要があります。 (余分な空白文字を含めることはできません。)
      パラメータ:
        `name` - 返される列挙型定数の名前。
      戻り値:
        指定した名前の列挙型定数
      例外:
        `java.lang.IllegalArgumentException` - この列挙型に、指定した名前の定数がない場合
        `java.lang.NullPointerException` - 引数がnullの場合

    - #### compare

          public abstract int compare(Sprite s1,
                                      Sprite s2)

      定義:
        `compare` インタフェース内 `java.util.Comparator<Sprite>`