From 2b278fb08595b2b2757b3c2655bc9312f7cd5190 Mon Sep 17 00:00:00 2001 From: Eunki Hong Date: Thu, 6 Jul 2023 00:58:19 +0900 Subject: [PATCH] Fix comments for MotionData Change-Id: I87b9e98de2a5ef690d85029996bbafdad7a9c554 Signed-off-by: Eunki Hong --- dali-scene3d/public-api/model-motion/motion-data.h | 4 +++- .../public-api/model-motion/motion-index/blend-shape-index.h | 6 ++++-- .../public-api/model-motion/motion-index/motion-transform-index.h | 2 ++ 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/dali-scene3d/public-api/model-motion/motion-data.h b/dali-scene3d/public-api/model-motion/motion-data.h index c3e3678..1bdd463 100644 --- a/dali-scene3d/public-api/model-motion/motion-data.h +++ b/dali-scene3d/public-api/model-motion/motion-data.h @@ -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 diff --git a/dali-scene3d/public-api/model-motion/motion-index/blend-shape-index.h b/dali-scene3d/public-api/model-motion/motion-index/blend-shape-index.h index f633a42..4ad77ad 100644 --- a/dali-scene3d/public-api/model-motion/motion-index/blend-shape-index.h +++ b/dali-scene3d/public-api/model-motion/motion-index/blend-shape-index.h @@ -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 * diff --git a/dali-scene3d/public-api/model-motion/motion-index/motion-transform-index.h b/dali-scene3d/public-api/model-motion/motion-index/motion-transform-index.h index c3723a9..8dff8f1 100644 --- a/dali-scene3d/public-api/model-motion/motion-index/motion-transform-index.h +++ b/dali-scene3d/public-api/model-motion/motion-index/motion-transform-index.h @@ -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); -- 2.7.4