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