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

インタフェース BmsAt

  • 既知の実装クラスのリスト:
    BeMusicPoint, BmsAddress, BmsMeasureValue, BmsNote, BmsPoint, BmsTimelineElement
    public interface BmsAt
    タイムラインにおける時間軸の位置を表すインターフェイスです。

    タイムラインにおける時間軸の位置は「小節番号(Measure)」と「小節の刻み位置(Tick)」で成り立っています。 この位置のことを「楽曲位置」と呼称します。BmsAtは、楽曲位置の要素を参照する機能を提供します。

    タイムラインの楽曲位置の有効範囲は、小節番号の場合BmsSpec.MEASURE_MIN～BmsSpec.MEASURE_MAX、 刻み位置の場合BmsSpec.TICK_MIN～BmsSpec.TICK_MAXとなります。ただし、刻み位置の範囲は小節番号が示す 小節の長さに依存しますので、現実的な最大値はBmsSpec.TICK_MAXよりも遥かに小さい値になります。 多くのBMSコンテンツでは、小節における刻み位置の最大値は概ねBmsSpec.TICK_COUNT_DEFAULT前後となります。

    • メソッドの詳細

      • getMeasure

        int getMeasure()
        小節番号を取得します。
        戻り値:
        小節番号

      • getTick

        double getTick()
        小節の刻み位置を取得します。
        戻り値:
        小節の刻み位置

      • onMeasureLine

        default boolean onMeasureLine()
        楽曲位置が小節線上にあるかどうかを判定します。

        具体的に、小節線上とはgetTick()が返した刻み位置がBmsSpec.TICK_MINと等しいことを表します。 その位置から少しでもずれていた場合、小節線上とは見なされません。

        戻り値:
        楽曲位置が小節線上にある場合true

      • equals

        static boolean equals​(BmsAt at1,
                      BmsAt at2)
        2つの楽曲位置を比較し、位置が同じかどうかを判定します。
        パラメータ:
        at1 - 楽曲位置1
        at2 - 楽曲位置2
        戻り値:
        2つの楽曲位置が同じであればtrue
        例外:
        NullPointerException - at1またはat2がnull

      • compare

        static int compare​(BmsAt at1,
                   BmsAt at2)
        2つの楽曲位置を比較します。
        パラメータ:
        at1 - 楽曲位置1
        at2 - 楽曲位置2
        戻り値:
        楽曲位置1 == 楽曲位置2は0、楽曲位置1 > 楽曲位置2は正の値、楽曲位置1 < 楽曲位置2は負の値
        例外:
        NullPointerException - at1またはat2がnull

      • compare2

        static int compare2​(int measure1,
                    double tick1,
                    int measure2,
                    double tick2)
        2つの楽曲位置を比較します。
        パラメータ:
        measure1 - 楽曲位置1の小節番号
        tick1 - 楽曲位置1の小節の刻み位置
        measure2 - 楽曲位置2の小節番号
        tick2 - 楽曲位置2の小節の刻み位置
        戻り値:
        楽曲位置1 == 楽曲位置2は0、楽曲位置1 > 楽曲位置2は正の値、楽曲位置1 < 楽曲位置2は負の値

      • hashCode

        static int hashCode​(BmsAt at)
        楽曲位置からハッシュコード値を生成します。
        パラメータ:
        at - 楽曲位置
        戻り値:
        ハッシュコード値
        例外:
        NullPointerException - atがnull

      • toString

        static String toString​(BmsAt at)
        楽曲位置の文字列表現を返します。
        パラメータ:
        at - 楽曲位置
        戻り値:
        楽曲位置の文字列表現
        例外:
        NullPointerException - atがnull