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