dali-scene3d/public-api/model-motion/motion-index/blend-shape-index.h

   1 #ifndef DALI_SCENE3D_MODEL_MOTION_BLEND_SHAPE_INDEX_H
   2 #define DALI_SCENE3D_MODEL_MOTION_BLEND_SHAPE_INDEX_H
   3
   4 /*
   5  * Copyright (c) 2023 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22
  23 // INTERNAL INCLUDES
  24 #include <dali-scene3d/public-api/model-motion/motion-index/motion-index.h>
  25
  26 namespace Dali
  27 {
  28 namespace Scene3D
  29 {
  30 //Forward declarations.
  31 namespace Internal
  32 {
  33 class BlendShapeIndex;
  34 } // namespace Internal
  35
  36 /**
  37  * @addtogroup dali_scene3d_model_motion_blend_shape_index
  38  * @{
  39  */
  40
  41 /**
  42  * @brief Specialized MotionIndex to control blend shape.
  43  * We can control the blend shape by index (when we set BlendShapeId as IndexKey)
  44  * or by name (when we set BlendShapeId as StringKey)
  45  *
  46  * @code
  47  *
  48  * BlendShapeIndex blendShapeIndex0 = BlendShapeIndex::New("nodeName", 0u);
  49  * BlendShapeIndex blendShapeIndex1 = BlendShapeIndex::New("nodeName", "Target_1");
  50  *
  51  * // We can change the property later.
  52  * BlendShapeIndex blendShapeIndex2 = BlendShapeIndex::New();
  53  * blendShapeIndex2.SetModelNodeId("nodeName");
  54  * blendShapeIndex2.SetBlendShapeId("Target_2");
  55  *
  56  * @endcode
  57  *
  58  * Specially, if ModelNodeId is Property::INVALID_KEY and BlendShapeId is StringKey,
  59  * It will control all ModelNode that has the inputed BlendShape name.
  60  *
  61  * @code
  62  *
  63  * // If "node0" and "node1" has same BlendShape named "Smile",
  64  * // blendShapeIndexAll will control both nodes.
  65  * BlendShapeIndex blendShapeIndexAll = BlendShapeIndex::New("Smile");
  66  *
  67  * BlendShapeIndex blendShapeIndex0 = BlendShapeIndex::New("node0", "Smile");
  68  * BlendShapeIndex blendShapeIndex1 = BlendShapeIndex::New("node1", "Smile");
  69  *
  70  * @endcode
  71  *
  72  * @SINCE_2_2.34
  73  */
  74 class DALI_SCENE3D_API BlendShapeIndex : public MotionIndex
  75 {
  76 public: // Creation & Destruction
  77   /**
  78    * @brief Create an initialized BlendShapeIndex.
  79    *
  80    * @SINCE_2_2.34
  81    * @return A handle to a newly allocated Dali resource
  82    */
  83   static BlendShapeIndex New();
  84
  85   /**
  86    * @brief Create an initialized BlendShapeIndex with values. It will hold invalid ModelNodeId.
  87    *
  88    * @SINCE_2_2.34
  89    * @param[in] blendShapeId The id of blend shape what this motion index looks.
  90    * @return A handle to a newly allocated Dali resource
  91    */
  92   static BlendShapeIndex New(Property::Key blendShapeId);
  93
  94   /**
  95    * @brief Create an initialized BlendShapeIndex with values.
  96    *
  97    * @SINCE_2_2.34
  98    * @param[in] modelNodeId The id of model node what this motion index looks.
  99    * @param[in] blendShapeId The id of blend shape what this motion index looks.
 100    * @return A handle to a newly allocated Dali resource
 101    */
 102   static BlendShapeIndex New(Property::Key modelNodeId, Property::Key blendShapeId);
 103
 104   /**
 105    * @brief Creates an uninitialized BlendShapeIndex.
 106    *
 107    * Only derived versions can be instantiated. Calling member
 108    * functions with an uninitialized Dali::Object is not allowed.
 109    *
 110    * @SINCE_2_2.34
 111    */
 112   BlendShapeIndex();
 113
 114   /**
 115    * @brief Destructor.
 116    *
 117    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 118    *
 119    * @SINCE_2_2.34
 120    */
 121   ~BlendShapeIndex();
 122
 123   /**
 124    * @brief Copy constructor.
 125    *
 126    * @SINCE_2_2.34
 127    * @param[in] blendShapeIndex Handle to an object
 128    */
 129   BlendShapeIndex(const BlendShapeIndex& blendShapeIndex);
 130
 131   /**
 132    * @brief Move constructor
 133    *
 134    * @SINCE_2_2.34
 135    * @param[in] rhs A reference to the moved handle
 136    */
 137   BlendShapeIndex(BlendShapeIndex&& rhs) noexcept;
 138
 139   /**
 140    * @brief Assignment operator.
 141    *
 142    * @SINCE_2_2.34
 143    * @param[in] blendShapeIndex Handle to an object
 144    * @return reference to this
 145    */
 146   BlendShapeIndex& operator=(const BlendShapeIndex& blendShapeIndex);
 147
 148   /**
 149    * @brief Move assignment
 150    *
 151    * @SINCE_2_2.34
 152    * @param[in] rhs A reference to the moved handle
 153    * @return A reference to this
 154    */
 155   BlendShapeIndex& operator=(BlendShapeIndex&& rhs) noexcept;
 156
 157   /**
 158    * @brief Downcasts an Object handle to BlendShapeIndex.
 159    *
 160    * If handle points to a BlendShapeIndex, the downcast produces valid handle.
 161    * If not, the returned handle is left uninitialized.
 162    *
 163    * @SINCE_2_2.34
 164    * @param[in] handle Handle to an object
 165    * @return Handle to a BlendShapeIndex or an uninitialized handle
 166    */
 167   static BlendShapeIndex DownCast(BaseHandle handle);
 168
 169 public: // Public Method
 170   /**
 171    * @brief Set the id of BlendShape what this motion index looks.
 172    *
 173    * @SINCE_2_2.34
 174    * @param[in] blendShapeId The blend shape id.
 175    */
 176   void SetBlendShapeId(Property::Key blendShapeId);
 177
 178   /**
 179    * @brief Get the id of BlendShape what this motion index looks.
 180    *
 181    * @SINCE_2_2.34
 182    * @return The blend shape id.
 183    */
 184   Property::Key GetBlendShapeId() const;
 185
 186 public: // Not intended for application developers
 187   /// @cond internal
 188   /**
 189    * @brief Creates a handle using the Scene3D::Internal implementation.
 190    *
 191    * @param[in] implementation The BlendShapeIndex implementation
 192    */
 193   DALI_INTERNAL BlendShapeIndex(Dali::Scene3D::Internal::BlendShapeIndex* implementation);
 194   /// @endcond
 195 };
 196
 197 /**
 198  * @}
 199  */
 200
 201 } // namespace Scene3D
 202
 203 } // namespace Dali
 204
 205 #endif // DALI_SCENE3D_MODEL_MOTION_BLEND_SHAPE_INDEX_H