PitchControlCurve

PitchControlCurve

NoteGroup 内の指定した時間範囲で生成されたピッチをオーバーライドするピッチコントロールカーブです。

ピッチコントロールカーブは、複数の時間-ピッチのペアで定義される連続的なピッチの変更を表します。 このオブジェクトはアンカー位置（ノートグループに相対的）、アンカーピッチ値（ノートグループに対して相対的な半音単位の値）、およびアンカー位置とアンカーピッチ値によってオフセットされた複数の時間-ピッチのペアを保持しています。

アンカー位置とアンカーピッチの値は GUI には表示されませんが、実装の便宜のために保持されています。通常、これらは内部のすべてのポイントを囲むバウンディングボックスの中心位置に設定されます。

(2.1.0 以降でサポート)

継承

メソッド

clearScriptData()

継承元：

clone() → {PitchControlCurve}

現在のオブジェクトのディープコピー。

戻り値：
型
PitchControlCurve

getIndexInParent() → {number}

継承元：

現在のオブジェクトの、親の中での添え字を取得します。Lua では、添え字は 1 から始まります。JavaScript では、添え字は 0 から始まります。

戻り値：
型
number

getParent() → {NestedObject|undefined}

継承元：

親 NestedObject を取得します。現在のオブジェクトが親に付いていない場合、undefined を返します。

戻り値：
型
NestedObject | undefined

getPitch() → {number}

ピッチコントロールカーブのアンカーピッチ値を、ノートグループのピッチオフセットに対して相対的な半音単位で取得します。

戻り値：

pitch in semitones

型
number

getPoints() → {Array.<Array.<number>>}

このピッチコントロールカーブのすべてのコントロールポイントを取得します。

この関数は、[ time , value ] ペアの配列を返します。ここで、time はカーブのアンカー位置を基準としたブリック単位、value はアンカー位置からの半音単位のピッチオフセットを示します。

戻り値：

array of [time, value] pairs

型
Array.<Array.<number>>

getPosition() → {number}

ピッチコントロールカーブのアンカー位置を、ノートグループの時間オフセットに対して相対的なブリック単位で取得します。

戻り値：

position in blicks

型
number

getScriptData(key) → {any}

継承元：
パラメータ：
名前 型 細細
key string

The key to retrieve the value for
戻り値：

The stored value, or undefined if key doesn't exist

型
any

getScriptDataKeys() → {Array.<string>}

継承元：
戻り値：

Array of all stored keys

型
Array.<string>

getValueAt(time) → {number}

特定の時間における補間されたピッチ値を取得します。

この関数は、カーブのコントロールポイントにより補間された、指定された時間における半音単位のピッチオフセットを返します。

パラメータ：
名前 型 細細
time number

time in blicks relative to the curve's position
戻り値：

pitch offset in semitones

型
number

hasScriptData(key) → {boolean}

継承元：
パラメータ：
名前 型 細細
key string

The key to check for
戻り値：

true if the key exists, false otherwise

型
boolean

isMemoryManaged() → {boolean}

継承元：

現在のオブジェクトがメモリ管理されているかどうか（スクリプト環境によってガベージコレクションされるか）を確認します。

戻り値：
型
boolean

removeScriptData(key)

継承元：
パラメータ：
名前 型 細細
key string

The key to remove

setPitch(pitch)

このピッチコントロールカーブのアンカーピッチ値を設定します。

パラメータ：
名前 型 細細
pitch number

pitch in semitones

setPoints(points)

このピッチコントロールカーブのすべてのコントロールポイントを設定します。

各コントロールポイントは、[ time , value ] の配列である必要があります。ここで、time はカーブのアンカー位置を基準としたブリック単位、value はアンカー位置からの半音単位のピッチオフセットを示します。

パラメータ：
名前 型 細細
points Array.<Array.<number>>

array of [time, value] pairs

setPosition(position)

このピッチコントロールカーブのアンカー位置を設定します。

パラメータ：
名前 型 細細
position number

position in blicks

setScriptData(key, value)

継承元：
パラメータ：
名前 型 細細
key string

The key to store the value under
value any

The value to store (must be JSON-serializable)