Merge pull request #51 from MizunagiKB/finished_cb_with_customdata

Finished cb with customdata

Author: wada-at-live2d-com

CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 
+## [Unreleased]
+
+### added
+
+* Add a function to the `ACubismMotion` class that sets arbitrary data in the callback. by [@MizunagiKB](https://github.com/MizunagiKB)
+
+
 ## [5-r.1-beta.1] - 2023-08-17
 
 ### Added

src/Motion/ACubismMotion.cpp

@@ -24,6 +24,7 @@ ACubismMotion::ACubismMotion()
     , _weight(1.0f)
     , _offsetSeconds(0.0f) //再生の開始時刻
     , _onFinishedMotion(NULL)
+    , _onFinishedMotionCustomData(NULL)
 { }
 
 ACubismMotion::~ACubismMotion()
@@ -151,6 +152,22 @@ ACubismMotion::FinishedMotionCallback ACubismMotion::GetFinishedMotionHandler()
     return this->_onFinishedMotion;
 }
 
+void ACubismMotion::SetFinishedMotionCustomData(void* onFinishedMotionCustomData)
+{
+    this->_onFinishedMotionCustomData = onFinishedMotionCustomData;
+}
+
+void* ACubismMotion::GetFinishedMotionCustomData()
+{
+    return this->_onFinishedMotionCustomData;
+}
+
+void ACubismMotion::SetFinishedMotionHandlerAndMotionCustomData(FinishedMotionCallback onFinishedMotionHandler, void* onFinishedMotionCustomData)
+{
+    this->_onFinishedMotion = onFinishedMotionHandler;
+    this->_onFinishedMotionCustomData = onFinishedMotionCustomData;
+}
+
 csmBool ACubismMotion::IsExistModelOpacity() const
 {
     return false;

src/Motion/ACubismMotion.hpp

@@ -179,6 +179,38 @@ class ACubismMotion
      */
     FinishedMotionCallback GetFinishedMotionHandler();
 
+    /**
+     * @brief ユーザー任意データの登録
+     *
+     * ユーザー任意データを登録します。
+     *
+     * @param[in]   onFinishedMotionCustomData  ユーザー任意データ
+     */
+    void SetFinishedMotionCustomData(void* onFinishedMotionCustomData);
+
+    /**
+     * @brief ユーザー任意データの取得
+     *
+     * ユーザー任意データを取得します。
+     *
+     * @return  登録されているユーザー任意データ。
+     */
+    void* GetFinishedMotionCustomData();
+
+    /**
+     * @brief モーション再生終了コールバックとユーザー任意データの登録
+     *
+     * モーション再生終了コールバックを登録する。
+     * IsFinishedフラグを設定するタイミングで呼び出される。
+     * 以下の状態の際には呼び出されない:
+     *   1. 再生中のモーションが「ループ」として設定されているとき
+     *   2. コールバックにNULLが登録されているとき
+     *
+     * @param[in]   onFinishedMotionHandler     モーション再生終了コールバック関数
+     * @param[in]   onFinishedMotionCustomData  ユーザー任意データ
+     */
+    void SetFinishedMotionHandlerAndMotionCustomData(FinishedMotionCallback onFinishedMotionHandler, void* onFinishedMotionCustomData);
+
     /**
      * @brief        透明度のカーブが存在するかどうかを確認する
      *
@@ -258,8 +290,8 @@ class ACubismMotion
 
     csmVector<const csmString*>    _firedEventValues;
 
-    // モーション再生終了コールバック関数
-    FinishedMotionCallback _onFinishedMotion;
+    FinishedMotionCallback _onFinishedMotion; ///< モーション再生終了コールバック関数ポインタ
+    void* _onFinishedMotionCustomData;        ///< モーション再生終了コールバックに戻されるデータ
 };
 
 }}}