dali-scene3d/public-api/loader/blend-shape-details.h

   1 #ifndef DALI_SCENE3D_LOADER_BLEND_SHAPE_DETAILS_H
   2 #define DALI_SCENE3D_LOADER_BLEND_SHAPE_DETAILS_H
   3 /*
   4  * Copyright (c) 2023 Samsung Electronics Co., Ltd.
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  * http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  */
  19
  20 // EXTERNAL INCLUDES
  21 #include <dali/public-api/actors/actor.h>
  22 #include <dali/public-api/common/vector-wrapper.h>
  23 #include <dali/public-api/object/weak-handle.h>
  24 #include <dali/public-api/rendering/shader.h>
  25 #include <string>
  26
  27 // INTERNAL INCLUDES
  28 #include <dali-scene3d/public-api/api.h>
  29
  30 namespace Dali::Scene3D::Loader
  31 {
  32 struct MeshDefinition;
  33 struct MeshGeometry;
  34
  35 struct DALI_SCENE3D_API BlendShapes
  36 {
  37   enum class Version
  38   {
  39     VERSION_1_0,
  40     VERSION_2_0,
  41     INVALID
  42   };
  43
  44   struct Component
  45   {
  46     enum
  47     {
  48       POSITIONS = 0x1,
  49       NORMALS   = 0x2,
  50       TANGENTS  = 0x4
  51     };
  52   };
  53
  54   struct BlendShapeData
  55   {
  56     std::vector<float>      weights;
  57     std::vector<float>      unnormalizeFactors;
  58     Version                 version{Scene3D::Loader::BlendShapes::Version::INVALID};
  59     uint32_t                bufferOffset{0};
  60     int32_t                 components{0x0};
  61     Dali::WeakHandle<Actor> mActor;
  62   };
  63
  64   // shader properties - animatable (uniforms)
  65   static const char* NUMBER_OF_BLEND_SHAPES; ///< Integer number of blend shapes loaded.
  66   static const char* UNNORMALIZE_FACTOR;     ///< Scalar(s) for position components of blend shapes; Version 1.0: float array (1 per blend shape); Version 2.0: single float.
  67   static const char* COMPONENT_SIZE;         ///< Integer offset from one component (positions / normals / tangents) of a blend shape to the next.
  68
  69   // shader properties - read-only (not available as uniforms)
  70   static const char* COMPONENTS; ///< Integer bitmask of the blend shape components that the shader uses; refer to the Components enum.
  71
  72   // actor property (instance) - animatable (uniforms)
  73   static const char* WEIGHTS_UNIFORM; ///< The weight of each blend shape in a float array
  74
  75   /**
  76    * @brief Registers properties based on the mesh definition (and geometry) and identified by the above string constants,
  77    *  on the given @a shader and @a actor.
  78    */
  79   static void ConfigureProperties(const BlendShapeData& data, Shader shader);
  80
  81   BlendShapes() = delete;
  82 };
  83
  84 } // namespace Dali::Scene3D::Loader
  85
  86 #endif // DALI_SCENE3D_LOADER_BLEND_SHAPE_DETAILS_H