パッケージ com.lmt.lib.bms

クラス BmsPoint

  • すべての実装されたインタフェース:
    BmsAt, Comparable<BmsAt>

    public class BmsPoint
    extends Object
    implements BmsAt, Comparable<BmsAt>
    タイムラインの時間軸の位置を表す「楽曲位置(BmsAt)」の単純実装です。

    楽曲位置のみのデータが欲しい時、MapやSet等のキーとして利用したい時などの用途で利用することを想定しています。 当クラスで保持する小節番号、小節の刻み位置はBmsSpecで規定されている範囲であることを強制しません。 従って、各値にはマイナス値などのタイムライン上の有効範囲外の値を格納することができます。そのような値が格納された 楽曲位置を各APIの入力値として使用すると、APIによっては例外をスローすることがありますので取り扱いには注意してください。

    関連項目:
    BmsAt
    • フィールドの概要

      フィールド 
      修飾子とタイプ フィールド 説明
      static BmsPoint BEGIN
      タイムライン上で有効な最も小さい楽曲位置
      static BmsPoint END
      タイムライン上で有効な最も大きい楽曲位置
    • コンストラクタの概要

      コンストラクタ 
      コンストラクタ 説明
      BmsPoint()
      新しい楽曲位置オブジェクトを構築します。
      BmsPoint​(int measure, double tick)
      指定した小節番号、刻み位置で新しい楽曲位置オブジェクトを構築します。
      BmsPoint​(BmsAt at)
      指定した楽曲位置と同じ新しい楽曲位置オブジェクトを構築します。
    • フィールドの詳細

      • BEGIN

        public static final BmsPoint BEGIN
        タイムライン上で有効な最も小さい楽曲位置
      • END

        public static final BmsPoint END
        タイムライン上で有効な最も大きい楽曲位置
    • コンストラクタの詳細

      • BmsPoint

        public BmsPoint()
        新しい楽曲位置オブジェクトを構築します。
      • BmsPoint

        public BmsPoint​(BmsAt at)
        指定した楽曲位置と同じ新しい楽曲位置オブジェクトを構築します。
        パラメータ:
        at - 楽曲位置
        例外:
        NullPointerException - atがnull
      • BmsPoint

        public BmsPoint​(int measure,
                        double tick)
        指定した小節番号、刻み位置で新しい楽曲位置オブジェクトを構築します。
        パラメータ:
        measure - 小節番号
        tick - 刻み位置
    • メソッドの詳細

      • equals

        public boolean equals​(Object obj)
        楽曲位置の比較を行います。

        比較対象オブジェクトをBmsAtにキャストできない場合、当メソッドはfalseを返します。

        オーバーライド:
        equals クラス内 Object
        パラメータ:
        obj - 比較対象オブジェクト
        戻り値:
        このオブジェクトと比較対象オブジェクトの楽曲位置が同一の場合true
      • hashCode

        public int hashCode()
        楽曲位置のハッシュコード値を返します。
        オーバーライド:
        hashCode クラス内 Object
        戻り値:
        楽曲位置のハッシュコード値
      • toString

        public String toString()
        楽曲位置の文字列表現を返します。
        オーバーライド:
        toString クラス内 Object
        戻り値:
        楽曲位置の文字列表現
      • compareTo

        public int compareTo​(BmsAt at)
        この楽曲位置オブジェクトと指定された楽曲位置を比較します。

        比較処理の詳細についてはBmsAt.compare(BmsAt, BmsAt)を参照してください。

        定義:
        compareTo インタフェース内 Comparable<BmsAt>
        パラメータ:
        at - 比較対象楽曲位置
        戻り値:
        楽曲位置の比較結果
        例外:
        NullPointerException - atがnull
      • getMeasure

        public int getMeasure()
        小節番号を取得します。
        定義:
        getMeasure インタフェース内 BmsAt
        戻り値:
        小節番号
      • getTick

        public double getTick()
        小節の刻み位置を取得します。
        定義:
        getTick インタフェース内 BmsAt
        戻り値:
        小節の刻み位置
      • of

        public static BmsPoint of​(BmsAt at)
        指定された楽曲位置と同じ新しい楽曲位置オブジェクトを構築します。
        パラメータ:
        at - 楽曲位置
        戻り値:
        楽曲位置オブジェクト
        例外:
        NullPointerException - atがnull
      • of

        public static BmsPoint of​(int measure,
                                  double tick)
        指定された小節番号、小節の刻み位置で新しい楽曲位置オブジェクトを構築します。
        パラメータ:
        measure - 小節番号
        tick - 小節の刻み位置
        戻り値:
        楽曲位置オブジェクト