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) 2022 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 // INTERNAL INCLUDES
  21 #include "dali-scene3d/public-api/api.h"
  22
  23 // EXTERNAL INCLUDES
  24 #include <string>
  25 #include "dali/public-api/actors/actor.h"
  26 #include "dali/public-api/rendering/shader.h"
  27
  28 namespace Dali
  29 {
  30 namespace Scene3D
  31 {
  32 namespace Loader
  33 {
  34 struct MeshDefinition;
  35 struct MeshGeometry;
  36
  37 struct DALI_SCENE3D_API BlendShapes
  38 {
  39   enum class Version
  40   {
  41     VERSION_1_0,
  42     VERSION_2_0,
  43     INVALID
  44   };
  45
  46   struct Component
  47   {
  48     enum
  49     {
  50       POSITIONS = 0x1,
  51       NORMALS   = 0x2,
  52       TANGENTS  = 0x4
  53     };
  54   };
  55
  56   // shader properties - animatable (uniforms)
  57   static const std::string NUMBER_OF_BLEND_SHAPES; ///< Integer number of blend shapes loaded.
  58   static const std::string UNNORMALIZE_FACTOR;     ///< Scalar(s) for position components of blend shapes; Version 1.0: float array (1 per blend shape); Version 2.0: single float.
  59   static const std::string COMPONENT_SIZE;         ///< Integer offset from one component (positions / normals / tangents) of a blend shape to the next.
  60
  61   // shader properties - read-only (not available as uniforms)
  62   static const std::string COMPONENTS; ///< Integer bitmask of the blend shape components that the shader uses; refer to the Components enum.
  63
  64   // actor property (instance) - animatable (uniforms)
  65   static const std::string WEIGHTS_UNIFORM; ///< The weight of each blend shape in a float array
  66
  67   /**
  68    * @brief Registers properties based on the mesh definition (and geometry) and identified by the above string constants,
  69    *  on the given @a shader and @a actor.
  70    */
  71   static void ConfigureProperties(const std::pair<MeshDefinition, MeshGeometry>& mesh, Shader shader, Actor actor);
  72
  73   BlendShapes() = delete;
  74 };
  75
  76 } // namespace Loader
  77 } // namespace Scene3D
  78 } // namespace Dali
  79
  80 #endif // DALI_SCENE3D_LOADER_BLEND_SHAPE_DETAILS_H