Class CubismMotion

モーションクラス

モーションのクラス。

Hierarchy

ACubismMotion
- CubismMotion

Constructors

constructor

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

Returns CubismMotion
Overrides ACubismMotion.constructor
- Defined in cubism/src/motion/cubismmotion.ts:689

Properties

_eyeBlinkParameterIds

_eyeBlinkParameterIds: string[] = []

_fadeInSeconds

_fadeInSeconds: number

_fadeOutSeconds

_fadeOutSeconds: number

_firedEventValues

_firedEventValues: string[]

_isLoop

_isLoop: boolean

_isLoopFadeIn

_isLoopFadeIn: boolean

_lastWeight

_lastWeight: number

_lipSyncParameterIds

_lipSyncParameterIds: string[] = []

_loopDurationSeconds

_loopDurationSeconds: number

`Optional` _modelCurveIdEyeBlink

_modelCurveIdEyeBlink?: string

`Optional` _modelCurveIdLipSync

_modelCurveIdLipSync?: string

_motionData

_motionData: CubismMotionData

_offsetSeconds

_offsetSeconds: number

`Optional` _onFinishedMotion

_onFinishedMotion?: ((self: ACubismMotion) => void)

Type declaration

- (self: ACubismMotion): void
- Parameters
  - self: ACubismMotion
  Returns void

_sourceFrameRate

_sourceFrameRate: number

_weight

_weight: number

Methods

doUpdateParameters

doUpdateParameters(model: CubismModel, userTimeSeconds: number, fadeWeight: number, motionQueueEntry: CubismMotionQueueEntry): void
モデルのパラメータの更新の実行
Parameters
- model: CubismModel
  
  対象のモデル
- userTimeSeconds: number
  
  現在の時刻[秒]
- fadeWeight: number
  
  モーションの重み
- motionQueueEntry: CubismMotionQueueEntry
  
  CubismMotionQueueManagerで管理されているモーション
Returns void
Overrides ACubismMotion.doUpdateParameters
- Defined in cubism/src/motion/cubismmotion.ts:268

getDuration

getDuration(): number
モーションの長さを取得する。

Returns
モーションの長さ[秒]

Returns number
Overrides ACubismMotion.getDuration
- Defined in cubism/src/motion/cubismmotion.ts:586

getFadeInTime

getFadeInTime(): number
フェードインにかかる時間の取得

Returns
フェードインにかかる時間[秒]

Returns number
Inherited from ACubismMotion.getFadeInTime
- Defined in cubism/src/motion/acubismmotion.ts:141

getFadeOutTime

getFadeOutTime(): number
フェードアウトにかかる時間の取得

Returns
フェードアウトにかかる時間[秒]

Returns number
Inherited from ACubismMotion.getFadeOutTime
- Defined in cubism/src/motion/acubismmotion.ts:133

getFinishedMotionHandler

getFinishedMotionHandler(): undefined | ((self: ACubismMotion) => void)
モーション再生終了コールバックの取得

モーション再生終了コールバックを取得する。

Returns
登録されているモーション再生終了コールバック関数

Returns undefined | ((self: ACubismMotion) => void)
Inherited from ACubismMotion.getFinishedMotionHandler
- Defined in cubism/src/motion/acubismmotion.ts:249

getFiredEvent

getFiredEvent(beforeCheckTimeSeconds: number, motionTimeSeconds: number): string[]
モデルのパラメータ更新

イベント発火のチェック。入力する時間は呼ばれるモーションタイミングを０とした秒数で行う。
Parameters
- beforeCheckTimeSeconds: number
  
  前回のイベントチェック時間[秒]
- motionTimeSeconds: number
  
  今回の再生時間[秒]
Returns string[]
Overrides ACubismMotion.getFiredEvent
- Defined in cubism/src/motion/cubismmotion.ts:921

getLoopDuration

getLoopDuration(): number
モーションのループ時の長さを取得する。

Returns
モーションのループ時の長さ[秒]

Returns number
Overrides ACubismMotion.getLoopDuration
- Defined in cubism/src/motion/cubismmotion.ts:595

getParameterFadeInTime

getParameterFadeInTime(parameterId: string): number
パラメータに対するフェードインの時間の取得

Returns
フェードインにかかる時間[秒]
Parameters
- parameterId: string
  
  パラメータID
Returns number
- Defined in cubism/src/motion/cubismmotion.ts:643

getParameterFadeOutTime

getParameterFadeOutTime(parameterId: string): number
パラメータに対するフェードアウトの時間を取得

Returns
フェードアウトにかかる時間[秒]
Parameters
- parameterId: string
  
  パラメータID
Returns number
- Defined in cubism/src/motion/cubismmotion.ts:661

getWeight

getWeight(): number
モーション適用の重みの取得

Returns
重み（0.0 - 1.0）

Returns number
Inherited from ACubismMotion.getWeight
- Defined in cubism/src/motion/acubismmotion.ts:157

isLoop

isLoop(): boolean
ループ情報の取得

Returns
true ループする

Returns
false ループしない

Returns boolean
- Defined in cubism/src/motion/cubismmotion.ts:559

isLoopFadeIn

isLoopFadeIn(): boolean
ループ時のフェードイン情報の取得

Returns
true する

Returns
false しない

Returns boolean
- Defined in cubism/src/motion/cubismmotion.ts:577

parse

parse(motionJson: MotionJSON): void
motion3.jsonをパースする。
Parameters
- motionJson: MotionJSON
  
  motion3.jsonが読み込まれているバッファ
Returns void
- Defined in cubism/src/motion/cubismmotion.ts:710

release

release(): void
デストラクタ相当の処理

Returns void
Overrides ACubismMotion.release
- Defined in cubism/src/motion/cubismmotion.ts:701

setEffectIds

setEffectIds(eyeBlinkParameterIds: string[], lipSyncParameterIds: string[]): void
自動エフェクトがかかっているパラメータIDリストの設定
Parameters
- eyeBlinkParameterIds: string[]
  
  自動まばたきがかかっているパラメータIDのリスト
- lipSyncParameterIds: string[]
  
  リップシンクがかかっているパラメータIDのリスト
Returns void
- Defined in cubism/src/motion/cubismmotion.ts:678

setFadeInTime

setFadeInTime(fadeInSeconds: number): void
フェードインの時間を設定する
Parameters
- fadeInSeconds: number
  
  フェードインにかかる時間[秒]
Returns void
Inherited from ACubismMotion.setFadeInTime
- Defined in cubism/src/motion/acubismmotion.ts:117

setFadeOutTime

setFadeOutTime(fadeOutSeconds: number): void
フェードアウトの時間を設定する
Parameters
- fadeOutSeconds: number
  
  フェードアウトにかかる時間[秒]
Returns void
Inherited from ACubismMotion.setFadeOutTime
- Defined in cubism/src/motion/acubismmotion.ts:125

setFinishedMotionHandler

setFinishedMotionHandler(onFinishedMotionHandler?: ((self: ACubismMotion) => void)): void
モーション再生終了コールバックの登録

モーション再生終了コールバックを登録する。 isFinishedフラグを設定するタイミングで呼び出される。以下の状態の際には呼び出されない:
1. 再生中のモーションが「ループ」として設定されているとき
2. コールバックが登録されていない時
Parameters
- Optional onFinishedMotionHandler: ((self: ACubismMotion) => void)
  
  モーション再生終了コールバック関数
  - - (self: ACubismMotion): void
    - Parameters
      
      self: ACubismMotion
      
      Returns void
Returns void
Inherited from ACubismMotion.setFinishedMotionHandler
- Defined in cubism/src/motion/acubismmotion.ts:236

setIsLoop

setIsLoop(loop: boolean): void
ループ情報の設定
Parameters
- loop: boolean
  
  ループ情報
Returns void
- Defined in cubism/src/motion/cubismmotion.ts:550

setIsLoopFadeIn

setIsLoopFadeIn(loopFadeIn: boolean): void
ループ時のフェードイン情報の設定
Parameters
- loopFadeIn: boolean
  
  ループ時のフェードイン情報
Returns void
- Defined in cubism/src/motion/cubismmotion.ts:567

setOffsetTime

setOffsetTime(offsetSeconds: number): void
モーション再生の開始時刻の設定
Parameters
- offsetSeconds: number
  
  モーション再生の開始時刻[秒]
Returns void
Inherited from ACubismMotion.setOffsetTime
- Defined in cubism/src/motion/acubismmotion.ts:189

setParameterFadeInTime

setParameterFadeInTime(parameterId: string, value: number): void
パラメータに対するフェードインの時間を設定する。
Parameters
- parameterId: string
  
  パラメータID
- value: number
  
  フェードインにかかる時間[秒]
Returns void
- Defined in cubism/src/motion/cubismmotion.ts:605

setParameterFadeOutTime

setParameterFadeOutTime(parameterId: string, value: number): void
パラメータに対するフェードアウトの時間の設定
Parameters
- parameterId: string
  
  パラメータID
- value: number
  
  フェードアウトにかかる時間[秒]
Returns void
- Defined in cubism/src/motion/cubismmotion.ts:624

setWeight

setWeight(weight: number): void
モーション適用の重みの設定
Parameters
- weight: number
  
  重み（0.0 - 1.0）
Returns void
Inherited from ACubismMotion.setWeight
- Defined in cubism/src/motion/acubismmotion.ts:149

updateParameters

updateParameters(model: CubismModel, motionQueueEntry: CubismMotionQueueEntry, userTimeSeconds: number): void
モデルのパラメータ
Parameters
- model: CubismModel
  
  対象のモデル
- motionQueueEntry: CubismMotionQueueEntry
  
  CubismMotionQueueManagerで管理されているモーション
- userTimeSeconds: number
  
  デルタ時間の積算値[秒]
Returns void
Inherited from ACubismMotion.updateParameters
- Defined in cubism/src/motion/acubismmotion.ts:44

`Static` create

create(json: MotionJSON, onFinishedMotionHandler?: ((self: ACubismMotion) => void)): CubismMotion
インスタンスを作成する

Returns
作成されたインスタンス
Parameters
- json: MotionJSON
  
  motion3.jsonが読み込まれているバッファ
- Optional onFinishedMotionHandler: ((self: ACubismMotion) => void)
  
  モーション再生終了時に呼び出されるコールバック関数
  - - (self: ACubismMotion): void
    - Parameters
      
      self: ACubismMotion
      
      Returns void
Returns CubismMotion
- Defined in cubism/src/motion/cubismmotion.ts:248

Class CubismMotion

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns CubismMotion

Properties

_eyeBlinkParameterIds

_fadeInSeconds

_fadeOutSeconds

_firedEventValues

_isLoop

_isLoopFadeIn

_lastWeight

_lipSyncParameterIds

_loopDurationSeconds

Optional _modelCurveIdEyeBlink

Optional _modelCurveIdLipSync

_motionData

_offsetSeconds

Optional _onFinishedMotion

Type declaration

Parameters

self: ACubismMotion

Returns void

_sourceFrameRate

_weight

Methods

doUpdateParameters

Parameters

model: CubismModel

userTimeSeconds: number

fadeWeight: number

motionQueueEntry: CubismMotionQueueEntry

Returns void

getDuration

Returns

Returns number

getFadeInTime

Returns

Returns number

getFadeOutTime

Returns

Returns number

getFinishedMotionHandler

Returns

Returns undefined | ((self: ACubismMotion) => void)

getFiredEvent

Parameters

beforeCheckTimeSeconds: number

motionTimeSeconds: number

Returns string[]

getLoopDuration

Returns

Returns number

getParameterFadeInTime

Returns

Parameters

parameterId: string

Returns number

getParameterFadeOutTime

Returns

Parameters

parameterId: string

Returns number

getWeight

Returns

Returns number

isLoop

Returns

Returns

Returns boolean

isLoopFadeIn

Returns

Returns

Returns boolean

parse

`Optional` _modelCurveIdEyeBlink

`Optional` _modelCurveIdLipSync

`Optional` _onFinishedMotion

`Optional` onFinishedMotionHandler: ((self: ACubismMotion) => void)

`Static` create

`Optional` onFinishedMotionHandler: ((self: ACubismMotion) => void)