dali-scene3d/internal/common/environment-map-load-task.h

   1 #ifndef DALI_SCENE3D_ENVIRONMENT_MAP_LOAD_TASK_H
   2 #define DALI_SCENE3D_ENVIRONMENT_MAP_LOAD_TASK_H
   3
   4 /*
   5  * Copyright (c) 2023 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  */
  19
  20 // EXTERNAL INCLUDES
  21 #include <dali/public-api/common/intrusive-ptr.h>
  22 #include <dali/public-api/images/pixel-data.h>
  23 #include <dali/public-api/adaptor-framework/async-task-manager.h>
  24 #include <memory>
  25
  26 // INTERNAL INCLUDES
  27 #include <dali-scene3d/public-api/loader/load-result.h>
  28 #include <dali-scene3d/public-api/loader/scene-definition.h>
  29 #include <dali-scene3d/public-api/common/environment-map.h>
  30 #include <dali-scene3d/public-api/loader/environment-map-data.h>
  31
  32 namespace Dali
  33 {
  34 namespace Scene3D
  35 {
  36 namespace Internal
  37 {
  38 class EnvironmentMapLoadTask;
  39 typedef IntrusivePtr<EnvironmentMapLoadTask> EnvironmentMapLoadTaskPtr;
  40
  41 class EnvironmentMapLoadTask : public AsyncTask
  42 {
  43 public:
  44   /**
  45    * Constructor
  46    * @param[in] environmentMapUrl The url of the environment map image file.
  47    * @param[in] callback The callback that is called when the operation is completed.
  48    */
  49   EnvironmentMapLoadTask(const std::string& environmentMapUrl, Dali::Scene3D::EnvironmentMapType environmentMapType, CallbackBase* callback);
  50
  51   /**
  52    * Destructor.
  53    */
  54   ~EnvironmentMapLoadTask();
  55
  56   /**
  57    * Process the task
  58    */
  59   void Process() override;
  60
  61   /**
  62    * Whether the task is ready to process.
  63    * @return True if the task is ready to process.
  64    */
  65   bool IsReady() override;
  66
  67   /**
  68    * Whether the task has succeeded.
  69    * @return True if the task has succeeded.
  70    */
  71   bool HasSucceeded() const;
  72
  73   /**
  74    * Retrieves loaded Environment Map
  75    * @return EnvironmentMapData that is loaded from url.
  76    */
  77   Dali::Scene3D::Loader::EnvironmentMapData& GetEnvironmentMap();
  78
  79 private:
  80   // Undefined
  81   EnvironmentMapLoadTask(const EnvironmentMapLoadTask& task) = delete;
  82
  83   // Undefined
  84   EnvironmentMapLoadTask& operator=(const EnvironmentMapLoadTask& task) = delete;
  85
  86 private:
  87   std::string                               mEnvironmentMapUrl;
  88   Dali::Scene3D::Loader::EnvironmentMapData mEnvironmentMapData;
  89   Dali::Scene3D::EnvironmentMapType         mEnvironmentMapType{Dali::Scene3D::EnvironmentMapType::AUTO};
  90
  91   bool mIsReady;
  92   bool mHasSucceeded;
  93 };
  94
  95 } // namespace Internal
  96
  97 } // namespace Scene3D
  98
  99 } // namespace Dali
 100
 101 #endif // DALI_SCENE3D_ENVIRONMENT_MAP_LOAD_TASK_H