dali-scene3d/public-api/algorithm/path-finder-waypoint.h

   1 #ifndef DALI_SCENE3D_PATH_FINDER_WAYPOINT_H
   2 #define DALI_SCENE3D_PATH_FINDER_WAYPOINT_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/math/vector2.h>
  22 #include <dali/public-api/math/vector3.h>
  23
  24 #include <cinttypes>
  25 #include <memory>
  26
  27 // INTERNAL INCLUDES
  28 #include <dali-scene3d/public-api/api.h>
  29
  30 namespace Dali::Scene3D::Internal::Algorithm
  31 {
  32 struct WayPointData;
  33 }
  34
  35 namespace Dali::Scene3D::Algorithm
  36 {
  37 /**
  38  * @class WayPoint
  39  *
  40  * The class represents a public interface to the WayPoint object
  41  */
  42 class DALI_SCENE3D_API WayPoint
  43 {
  44 public:
  45   /**
  46    * @brief Constructor
  47    */
  48   WayPoint();
  49
  50   /**
  51    * @brief Destructor
  52    */
  53   ~WayPoint();
  54
  55   /**
  56    * @brief Returns index of bounding face within the NavigationMesh
  57    *
  58    * Function returns index of face withing the NavigationMesh
  59    * that the waypoint is associated with.
  60    *
  61    * @return Valid index of the face
  62    */
  63   [[nodiscard]] uint32_t GetNavigationMeshFaceIndex() const;
  64
  65   /**
  66    * @brief Returns local 2D position in face space
  67    *
  68    * The face space uses the face barycentre as an origin. The x-axis is
  69    * aligned with x-axis of the NavigationMesh.
  70    *
  71    * @return Valid 2D location vector
  72    */
  73   [[nodiscard]] Dali::Vector2 GetFaceLocalSpacePosition() const;
  74
  75   /**
  76    * @brief Returns waypoint 3D position in scene space
  77    *
  78    * Returns the 3D position of the waypoint in the scene space
  79    * of associated NavigationMesh object (using transformation set with
  80    * NavigationMesh::SetSceneTransform()).
  81    *
  82    * @return Valid 3D location vector
  83    */
  84   [[nodiscard]] Dali::Vector3 GetScenePosition() const;
  85
  86   /**
  87    * @brief Copy constructor
  88    *
  89    * Only copy semantics is allowed on the WayPoint object
  90    */
  91   WayPoint(const WayPoint&);
  92
  93   /**
  94    * @brief Copy assignment operator
  95    *
  96    * Only copy semantics is allowed on the WayPoint object
  97    *
  98    * @return Copy of source object
  99    */
 100   WayPoint& operator=(const WayPoint&);
 101
 102 private:
 103   std::unique_ptr<Internal::Algorithm::WayPointData> mImpl;
 104
 105 public:
 106   DALI_INTERNAL operator Internal::Algorithm::WayPointData&();
 107 };
 108 } // namespace Dali::Scene3D::Algorithm
 109
 110 #endif // DALI_SCENE3D_PATH_FINDER_WAYPOINT_H