Interface IPhrase

フレーズ / Phrase

interface IPhrase {
    animate: RenderingUnitFunction;
    charCount: number;
    children: IWord[];
    duration: number;
    endTime: number;
    firstChar: IChar;
    firstWord: IWord;
    lastChar: IChar;
    lastWord: IWord;
    next: IPhrase;
    parent: IRenderingUnit;
    previous: IPhrase;
    startTime: number;
    text: string;
    wordCount: number;
    contains(time): boolean;
    findIndex(unit): number;
    getType(): number;
    overlaps(obj): boolean;
    overlaps(startTime, endTime): boolean;
    progress(time): number;
    toString(): string;
}

Hierarchy (view full)

Properties

animate charCount children duration endTime firstChar firstWord lastChar lastWord next parent previous startTime text wordCount

Methods

contains findIndex 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 charCount

charCount: number

Readonly children

children: IWord[]

Inherit Doc

Readonly duration

duration: number

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

endTime

endTime: number

Readonly firstChar

firstChar: IChar

Readonly firstWord

firstWord: IWord

Readonly lastChar

lastChar: IChar

Readonly lastWord

lastWord: IWord

Readonly next

next: IPhrase

Inherit Doc

Readonly parent

parent: IRenderingUnit

Readonly previous

previous: IPhrase

Inherit Doc

startTime

startTime: number

Readonly text

text: string

文字ユニットに含まれるプレーンテキスト / Plain text contained in this text unit

Readonly wordCount

wordCount: 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

findIndex

  • findIndex(unit): number

  • Parameters

    Returns number

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

animatecharCountchildrendurationendTimefirstCharfirstWordlastCharlastWordnextparentpreviousstartTimetextwordCountcontainsfindIndexgetTypeoverlapsprogresstoString