Class CriAtomExTween

トゥイーンオブジェクト

Inheritance
object
CriAtomExTween
Implements
Inherited Members
Namespace: CriWare
Assembly: CriWare.CriAtom.dll
Syntax
public class CriAtomExTween : IDisposable
Remarks

説明: CriAtomExTween は、トゥイーンを操作するためのオブジェクトです。 トゥイーンとは、簡単な手順でパラメーターの時間変化を行うためのモジュールです。 CriAtomExTween(in Config, IntPtr, int) 関数でトゥイーンを作成すると、 本関数はトゥイーン操作用に、この"トゥイーンオブジェクト"を返します。 パラメーターの時間変化の開始等、トゥイーンに対して行う操作は、 全てトゥイーンオブジェクトを介して実行されます。 また、AtomExプレーヤーにトゥイーンを関連づける際にも使用します。

Constructors

CriAtomExTween(in Config, IntPtr, int)

トゥイーンの作成

Declaration
public CriAtomExTween(in CriAtomExTween.Config config, IntPtr work = default, int workSize = 0)
Parameters
Type Name Description
CriAtomExTween.Config config

トゥイーン作成用コンフィグ構造体へのポインタ
IntPtr work

トゥイーン作成用ワーク領域へのポインタ
int workSize

トゥイーン作成用ワークサイズ
Remarks

説明: トゥイーン作成用コンフィグに基づいて、トゥイーンを作成します。 作成に成功すると、トゥイーンオブジェクトを返します。 トゥイーンを作成する際には、ワーク領域としてメモリを渡す必要があります。 必要なメモリのサイズは、 CalculateWorkSize(in Config) 関数で計算します。 （SetUserAllocator(delegate* unmanaged[Cdecl]<IntPtr, uint, IntPtr>, delegate* unmanaged[Cdecl]<IntPtr, IntPtr, void>, IntPtr) メソッドを使用してアロケーターを登録済みの場合、 本関数にワーク領域を指定する必要はありません。） 作成したトゥイーンは、AttachTween(CriAtomExTween) 関数にてAtomExプレーヤーにアタッチすることで効果を発揮します。

備考: トゥイーンの保持するパラメーターの初期値は、コンフィグ構造体でパラメータータイプにBasicを指定した場合は各パラメーターのデフォルト値、またはパラメータータイプにAisacを指定した場合は0.0fです。

注意: 本関数を実行する前に、ライブラリを初期化しておく必要があります。 TweenオブジェクトをアタッチしたAtomExプレーヤーで再生している音声がある場合、 本関数を実行する前に、それらの音声を停止するか、そのAtomExプレーヤーを破棄してください。

See Also

CriAtomExTween(IntPtr, int)

デフォルト設定でのインスタンス作成

Declaration
public CriAtomExTween(IntPtr work = default, int workSize = 0)
Parameters
Type Name Description
IntPtr work
int workSize

Properties

NativeHandle

ネイティブハンドル

Declaration
public NativeHandleIntPtr NativeHandle { get; }
Property Value
Type Description
NativeHandleIntPtr

Methods

CalculateWorkSize(in Config)

トゥイーンの作成に必要なワーク領域サイズの計算

Declaration
public static int CalculateWorkSize(in CriAtomExTween.Config config)
Parameters
Type Name Description
CriAtomExTween.Config config

トゥイーン作成用コンフィグ構造体
Returns
Type Description
int

ワーク領域サイズ
Remarks

説明: トゥイーンを作成するのに必要な、ワーク領域のサイズを取得します。 アロケーターを登録せずにトゥイーンを作成する場合、あらかじめ本関数で計算した ワーク領域サイズ分のメモリをワーク領域として CriAtomExTween(in Config, IntPtr, int) 関数に セットする必要があります。 引数にnullを指定した場合、デフォルト設定 （ SetDefaultConfig(out Config) 適用時と同じパラメーター）で ワーク領域サイズを計算します。 ワーク領域サイズ計算時に失敗した場合、戻り値は -1 になります。 ワーク領域サイズの計算に失敗した理由については、エラーコールバックの メッセージで確認可能です。

備考: 引数 config の情報は、関数内でのみ参照されます。 関数を抜けた後は参照されませんので、関数実行後に config の領域を解放しても 問題ありません。

注意: 本関数を実行する前に、ライブラリを初期化しておく必要があります。

See Also

Dispose()

トゥイーンの破棄

Declaration
public void Dispose()
Remarks

説明: トゥイーンを破棄します。 本関数を実行した時点で、トゥイーン作成時に確保されたリソースが全て解放されます。 また、引数に指定したトゥイーンオブジェクトも無効になります。 トゥイーンをアタッチしたAtomExプレーヤーで再生している音声がある場合、 本関数を実行する前に、それらの音声を停止するか、そのAtomExプレーヤーを破棄してください。

See Also

GetValue()

現在値の取得

Declaration
public float GetValue()
Returns
Type Description
float
Remarks

説明: トゥイーンが保持しているパラメーターの現在値を取得します。

MoveFrom(ushort, float)

指定値から現在値に変化

Declaration
public void MoveFrom(ushort timeMs, float value)
Parameters
Type Name Description
ushort timeMs

変化に要する時間（ミリ秒単位）
float value

変化前の開始値
Remarks

説明: time_msで指定した時間をかけて、valueで指定した値から、本関数呼び出し時にトゥイーンが保持している現在値へと変化します。 変化カーブはリニア（線形）です。

MoveTo(ushort, float)

現在値から指定値に変化

Declaration
public void MoveTo(ushort timeMs, float value)
Parameters
Type Name Description
ushort timeMs

変化に要する時間（ミリ秒単位）
float value

変化後の最終値
Remarks

説明: time_msで指定した時間をかけて、本関数呼び出し時にトゥイーンが保持している現在値から、valueで指定した値へと変化します。 変化カーブはリニア（線形）です。

Reset()

トゥイーンのリセット

Declaration
public void Reset()
Remarks

説明: トゥイーンの保持しているパラメーターの現在値をリセットし、初期値に戻します。 トゥイーンの保持するパラメーターの初期値は、コンフィグ構造体でパラメータータイプにBasicを指定した場合は各パラメーターのデフォルト値、またはパラメータータイプにAisacを指定した場合は0.0fです。

備考: トゥイーンによる時間変化が動作していた場合、動作を停止します。

SetDefaultConfig(out Config)

トゥイーン作成用コンフィグ構造体にデフォルト値をセット

Declaration
public static void SetDefaultConfig(out CriAtomExTween.Config pConfig)
Parameters
Type Name Description
CriAtomExTween.Config pConfig

コンフィグ構造体へのポインタ
Remarks

説明: CriAtomExTween(in Config, IntPtr, int) 関数に設定するコンフィグ構造体（ CriAtomExTween.Config ）に、 デフォルトの値をセットします。

See Also

Stop()

トゥイーンの停止

Declaration
public void Stop()
Remarks

説明: トゥイーンによるパラメーターの時間変化を停止します。

Implements

See Also