Fix comments for MotionData 39/295339/1
authorEunki Hong <eunkiki.hong@samsung.com>
Wed, 5 Jul 2023 15:58:19 +0000 (00:58 +0900)
committerEunki Hong <eunkiki.hong@samsung.com>
Wed, 5 Jul 2023 15:58:19 +0000 (00:58 +0900)
Change-Id: I87b9e98de2a5ef690d85029996bbafdad7a9c554
Signed-off-by: Eunki Hong <eunkiki.hong@samsung.com>
dali-scene3d/public-api/model-motion/motion-data.h
dali-scene3d/public-api/model-motion/motion-index/blend-shape-index.h
dali-scene3d/public-api/model-motion/motion-index/motion-transform-index.h

index c3e367890bcea218e9be36fe6e6fa88d6a3210af..1bdd463fdb6eff5a6bf5d29f120b831ccc192230 100644 (file)
@@ -71,7 +71,8 @@ class MotionData;
  * @endcode
  *
  * We can request to load MotionData from file or buffer asynchronously.
- * If load completed, LoadCompetedSignal will be emmited.
+ * If load completed, LoadCompletedSignal will be emitted.
+ * If we try to load before LoadCompletedSignal emitted, previous load request cancel and only latest request loaded.
  *
  * @code
  *
@@ -95,6 +96,7 @@ class MotionData;
  *
  * @endcode
  * @note We don't check duplicated MotionIndex internally.
+ * @note We don't check MotionValue type is matched with MotionIndex.
  * @SINCE_2_2.34
  */
 class DALI_SCENE3D_API MotionData : public Dali::BaseHandle
index f633a421ce8fd19a9ce83c2057261fd5db5ff535..4ad77add565bd9ebf95f3917b8e4aef7d95367ba 100644 (file)
@@ -40,8 +40,10 @@ class BlendShapeIndex;
 
 /**
  * @brief Specialized MotionIndex to control blend shape.
- * We can control the blend shape by index (when we set BlendShapeId as IndexKey)
- * or by name (when we set BlendShapeId as StringKey)
+ * We can control the blend shape by index (when we set BlendShapeId as IndexKey),
+ * or by name (when we set BlendShapeId as StringKey).
+ *
+ * MotionValue should be float type.
  *
  * @code
  *
index c3723a9ac4e3f1694aa6076ab88bfee28ce134b4..8dff8f17633f2d5a5398c1fc890329ad061ef9aa 100644 (file)
@@ -43,6 +43,8 @@ class MotionTransformIndex;
  * It will be used when app developer don't care about Dali::Actor::Property list,
  * but want to change the transform properties anyway fast enough.
  *
+ * Each TransformType has their own matched MotionValue type.
+ *
  * @code
  *
  * MotionTransformIndex position = MotionTransformIndex::New("nodeName", MotionTransformIndex::TransformType::POSITION);