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

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