Class CubismMotionManager

モーションの管理

モーションの管理を行うクラス

Hierarchy

CubismMotionQueueManager
- CubismMotionManager

Constructors

constructor

new CubismMotionManager(): CubismMotionManager
コンストラクタ

Returns CubismMotionManager
Overrides CubismMotionQueueManager.constructor
- Defined in cubism/src/motion/cubismmotionmanager.ts:21

Properties

_currentPriority

_currentPriority: number

_eventCallBack

_eventCallBack: CubismMotionEventFunction

_eventCustomData

_eventCustomData: any

_motions

_motions: CubismMotionQueueEntry[]

_reservePriority

_reservePriority: number

_userTimeSeconds

_userTimeSeconds: number

Methods

doUpdateMotion

doUpdateMotion(model: CubismModel, userTimeSeconds: number): boolean
モーションを更新して、モデルにパラメータ値を反映する。

Returns
true モデルへパラメータ値の反映あり

Returns
false モデルへパラメータ値の反映なし(モーションの変化なし)
Parameters
- model: CubismModel
  
  対象のモデル
- userTimeSeconds: number
  
  デルタ時間の積算値[秒]
Returns boolean
Inherited from CubismMotionQueueManager.doUpdateMotion
- Defined in cubism/src/motion/cubismmotionqueuemanager.ts:205

getCubismMotionQueueEntry

getCubismMotionQueueEntry(motionQueueEntryNumber: any): undefined | CubismMotionQueueEntry
指定したCubismMotionQueueEntryの取得

Returns
指定したCubismMotionQueueEntry

Returns
null 見つからなかった
Parameters
- motionQueueEntryNumber: any
  
  モーションの識別番号
Returns undefined | CubismMotionQueueEntry
Inherited from CubismMotionQueueManager.getCubismMotionQueueEntry
- Defined in cubism/src/motion/cubismmotionqueuemanager.ts:176

getCurrentPriority

getCurrentPriority(): number
再生中のモーションの優先度の取得

Returns
モーションの優先度

Returns number
- Defined in cubism/src/motion/cubismmotionmanager.ts:31

getReservePriority

getReservePriority(): number
予約中のモーションの優先度を取得する。

Returns
モーションの優先度

Returns number
- Defined in cubism/src/motion/cubismmotionmanager.ts:39

isFinished

isFinished(): boolean
全てのモーションの終了の確認

Returns
true 全て終了している

Returns
false 終了していない

Returns boolean
Inherited from CubismMotionQueueManager.isFinished
- Defined in cubism/src/motion/cubismmotionqueuemanager.ts:89

isFinishedByHandle

isFinishedByHandle(motionQueueEntryNumber: any): boolean
指定したモーションの終了の確認

Returns
true 全て終了している

Returns
false 終了していない
Parameters
- motionQueueEntryNumber: any
  
  モーションの識別番号
Returns boolean
Inherited from CubismMotionQueueManager.isFinishedByHandle
- Defined in cubism/src/motion/cubismmotionqueuemanager.ts:128

release

release(): void
デストラクタ

Returns void
Inherited from CubismMotionQueueManager.release
- Defined in cubism/src/motion/cubismmotionqueuemanager.ts:34

reserveMotion

reserveMotion(priority: number): boolean
モーションを予約する。

Returns
true 予約できた

Returns
false 予約できなかった
Parameters
- priority: number
  
  優先度
Returns boolean
- Defined in cubism/src/motion/cubismmotionmanager.ts:103

setEventCallback

setEventCallback(callback: CubismMotionEventFunction, customData?: any): void
イベントを受け取るCallbackの登録
Parameters
- callback: CubismMotionEventFunction
  
  コールバック関数
- customData: any = null
  
  コールバックに返されるデータ
Returns void
Inherited from CubismMotionQueueManager.setEventCallback
- Defined in cubism/src/motion/cubismmotionqueuemanager.ts:189

setReservePriority

setReservePriority(val: number): void
予約中のモーションの優先度を設定する。
Parameters
- val: number
  
  優先度
Returns void
- Defined in cubism/src/motion/cubismmotionmanager.ts:47

startMotion

startMotion(motion: ACubismMotion, autoDelete: boolean, userTimeSeconds: number): any
指定したモーションの開始

指定したモーションを開始する。同じタイプのモーションが既にある場合は、既存のモーションに終了フラグを立て、フェードアウトを開始させる。

Returns
開始したモーションの識別番号を返す。個別のモーションが終了したか否かを判定するIsFinished()の引数で使用する。開始できない時は「-1」
Parameters
- motion: ACubismMotion
  
  開始するモーション
- autoDelete: boolean
  
  再生が終了したモーションのインスタンスを削除するなら true
- userTimeSeconds: number
  
  デルタ時間の積算値[秒]
Returns any
Inherited from CubismMotionQueueManager.startMotion
- Defined in cubism/src/motion/cubismmotionqueuemanager.ts:54

startMotionPriority

startMotionPriority(motion: ACubismMotion, autoDelete: boolean, priority: number): any
優先度を設定してモーションを開始する。

Returns
開始したモーションの識別番号を返す。個別のモーションが終了したか否かを判定するIsFinished()の引数で使用する。開始できない時は「-1」
Parameters
- motion: ACubismMotion
  
  モーション
- autoDelete: boolean
  
  再生が狩猟したモーションのインスタンスを削除するならtrue
- priority: number
  
  優先度
Returns any
- Defined in cubism/src/motion/cubismmotionmanager.ts:59

stopAllMotions

stopAllMotions(): void
全てのモーションを停止する

Returns void
Inherited from CubismMotionQueueManager.stopAllMotions
- Defined in cubism/src/motion/cubismmotionqueuemanager.ts:153

updateMotion

updateMotion(model: CubismModel, deltaTimeSeconds: number): boolean
モーションを更新して、モデルにパラメータ値を反映する。

Returns
true 更新されている

Returns
false 更新されていない
Parameters
- model: CubismModel
  
  対象のモデル
- deltaTimeSeconds: number
  
  デルタ時間[秒]
Returns boolean
- Defined in cubism/src/motion/cubismmotionmanager.ts:81

Class CubismMotionManager

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns CubismMotionManager

Properties

_currentPriority

_eventCallBack

_eventCustomData

_motions

_reservePriority

_userTimeSeconds

Methods

doUpdateMotion

Returns

Returns

Parameters

model: CubismModel

userTimeSeconds: number

Returns boolean

getCubismMotionQueueEntry

Returns

Returns

Parameters

motionQueueEntryNumber: any

Returns undefined | CubismMotionQueueEntry

getCurrentPriority

Returns

Returns number

getReservePriority

Returns

Returns number

isFinished

Returns

Returns

Returns boolean

isFinishedByHandle

Returns

Returns

Parameters

motionQueueEntryNumber: any

Returns boolean

release

Returns void

reserveMotion

Returns

Returns

Parameters

priority: number

Returns boolean

setEventCallback

Parameters

callback: CubismMotionEventFunction

customData: any = null

Returns void

setReservePriority

Parameters

val: number

Returns void

startMotion

Returns

Parameters

motion: ACubismMotion

autoDelete: boolean

userTimeSeconds: number

Returns any

startMotionPriority

Returns

Parameters

motion: ACubismMotion

autoDelete: boolean

priority: number

Returns any

stopAllMotions

Returns void

updateMotion