dali-scene3d/public-api/loader/load-result.h

   1 #ifndef DALI_SCENE3D_LOADER_OUTPUT_H
   2 #define DALI_SCENE3D_LOADER_OUTPUT_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 // INTERNAL INCLUDES
  21 #include <dali-scene3d/public-api/api.h>
  22 #include <dali-scene3d/public-api/loader/animation-definition.h>
  23 #include <dali-scene3d/public-api/loader/camera-parameters.h>
  24 #include <dali-scene3d/public-api/loader/light-parameters.h>
  25 #include <dali-scene3d/public-api/loader/load-scene-metadata.h>
  26
  27 namespace Dali::Scene3D::Loader
  28 {
  29 class ResourceBundle;
  30 class SceneDefinition;
  31
  32 /**
  33  * @brief The outputs from loading and processing a scene.
  34  */
  35 struct DALI_SCENE3D_API LoadResult
  36 {
  37   /**
  38    * @brief The bundle to store resources in.
  39    */
  40   ResourceBundle& mResources;
  41
  42   /**
  43    * @brief The scene definition to populate.
  44    */
  45   SceneDefinition& mScene;
  46
  47   /**
  48    * @brief The metadata of the scene.
  49    */
  50   SceneMetadata& mSceneMetadata;
  51
  52   /**
  53    * @brief The list of animation definitions, in lexicographical order of their names.
  54    */
  55   std::vector<AnimationDefinition>& mAnimationDefinitions;
  56
  57   /**
  58    * @brief The list of animation group definitions, in lexicographical order of their names.
  59    */
  60   std::vector<AnimationGroupDefinition>& mAnimationGroupDefinitions;
  61
  62   /**
  63    * @brief The camera parameters that were loaded from the scene.
  64    */
  65   std::vector<CameraParameters>& mCameraParameters;
  66
  67   /**
  68    * @brief The light parameters that were loaded from the scene.
  69    */
  70   std::vector<LightParameters>& mLightParameters;
  71 };
  72
  73 } // namespace Dali::Scene3D::Loader
  74
  75 #endif //DALI_SCENE3D_LOADER_OUTPUT_H