Interface IRenderingUnit

描画ユニット:

  • TextAlive における画面描画処理の最小単位
  • 種類（フレーズ、単語、文字、グラフィック）を getType で取得できる
  • 前後のユニットを previous と next で取得できる
  • （存在する場合）親要素と子要素の一覧をそれぞれ parent と children で取得できる
  • 開始時刻、終了時刻、その差分を startTime endTime および duration で取得できる

Rendering unit:

  • The base interface for all rendering unit implementations in TextAlive
  • getType returns the implementation type (phrase, word, character, or graphic)
  • previous and next return the previous and next unit
  • parent and children return the parent unit and the list of child units (if applicable)
  • startTime and endTime return the timing information and duration returns the duration i.e. endTime - startTime

See

TimedObject

interface IRenderingUnit {
    animate: RenderingUnitFunction;
    children: IRenderingUnit[];
    duration: number;
    endTime: number;
    next: IRenderingUnit;
    parent: IRenderingUnit;
    previous: IRenderingUnit;
    startTime: number;
    contains(time): boolean;
    getType(): number;
    overlaps(obj): boolean;
    overlaps(startTime, endTime): boolean;
    progress(time): number;
    toString(): string;
}

Hierarchy (view full)

Properties

animate children duration endTime next parent previous startTime

Methods

contains getType overlaps progress toString

Properties

animate

animate: RenderingUnitFunction

このプロパティに関数が定義されているとき、 TextAlive の通常動作（割り当て済みテンプレートの animate 関数を呼ぶ）はスキップされ、この関数が呼ばれる

When animate function is defined, TextAlive default behavior (call animate functions of all assigned template instances) is suppressed and this function is called instead

Readonly children

children: IRenderingUnit[]

Readonly duration

duration: number

描画ユニットの長さ [ms] / Duration of this rendering unit [ms]

endTime

endTime: number

Readonly next

next: IRenderingUnit

Readonly parent

parent: IRenderingUnit

Readonly previous

previous: IRenderingUnit

startTime

startTime: number

Methods

contains

  • contains(time): boolean

  • Returns whether this time range contains the specified time (start and end inclusive).

    Parameters

    • time: number

      時刻 [ms] / Time [ms]

    Returns boolean

getType

  • getType(): number

  • この描画ユニットの種類 / Type of this rendering unit

    Returns number

    See

    UnitTypes

overlaps

  • overlaps(obj): boolean

  • Returns whether the specified range overlaps with this time range (start and end inclusive).

    Parameters

    • obj: TimedObject

      時刻付きオブジェクト / Timed object

    Returns boolean

  • overlaps(startTime, endTime): boolean

  • Returns whether the specified range overlaps with this time range (start and end inclusive).

    Parameters

    • startTime: number

      開始時刻 [ms] / Start time [ms]

    • endTime: number

      終了時刻 [ms] / End time [ms]

    Returns boolean

progress

  • progress(time): number

  • 指定された楽曲中の位置をこの描画ユニット中の位置 [0, 1] にマッピングして返す

    Returns the position in this rendering unit [0, 1]

    Parameters

    • time: number

      楽曲中の位置 / Position in a song

    Returns number

toString

  • toString(): string

  • この描画ユニットの文字表現 / String representation of this rendering unit

    Returns string

Settings

Member Visibility

Theme

On This Page

animatechildrendurationendTimenextparentpreviousstartTimecontainsgetTypeoverlapsprogresstoString