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