dali/public-api/math/uint-16-pair.h

   1 #ifndef DALI_UINT_16_PAIR_H
   2 #define DALI_UINT_16_PAIR_H
   3
   4 /*
   5  * Copyright (c) 2020 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
  21 // EXTERNAL INCLUDES
  22 #include <stdint.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/public-api/common/dali-common.h>
  26 #include <dali/public-api/common/type-traits.h>
  27
  28 namespace Dali
  29 {
  30 /**
  31  * @addtogroup dali_core_math
  32  * @{
  33  */
  34
  35 /**
  36  * @brief Simple class for passing around pairs of small unsigned integers.
  37  *
  38  * Use this for integer dimensions and points with limited range such as image
  39  * sizes and pixel coordinates where a pair of floating point numbers is
  40  * inefficient and illogical (i.e. the data is inherently integer).
  41  * One of these can be passed in a single 32 bit integer register on
  42  * common architectures.
  43  * @SINCE_1_0.0
  44  */
  45 class Uint16Pair
  46 {
  47 public:
  48   /**
  49    * @brief Default constructor for the (0, 0) tuple.
  50    * @SINCE_1_0.0
  51    */
  52   Uint16Pair() : mData(0) {}
  53
  54   /**
  55    * @brief Constructor taking separate x and y (width and height) parameters.
  56    * @SINCE_1_0.0
  57    * @param[in] width The width or X dimension of the tuple. Make sure it is less than 65536
  58    * @param[in] height The height or Y dimension of the tuple. Make sure it is less than 65536
  59    */
  60   Uint16Pair( uint32_t width, uint32_t height )
  61   {
  62     DALI_ASSERT_DEBUG( width < ( 1u << 16 ) && "Width parameter not representable." );
  63     DALI_ASSERT_DEBUG( height < ( 1u << 16 ) && "Height parameter not representable." );
  64
  65     /* Do equivalent of the code below with one aligned memory access:
  66      * mComponents[0] = width;
  67      * mComponents[1] = height;
  68      * Unit tests make sure this is equivalent.
  69      **/
  70     mData = (height << 16u) + width;
  71   }
  72
  73   /**
  74    * @brief Sets the width.
  75    * @SINCE_1_1.13
  76    * @param[in] width The x dimension to be stored in this 2-tuple
  77    */
  78   void SetWidth( uint16_t width )
  79   {
  80     mComponents[0] = width;
  81   }
  82
  83   /**
  84    * @brief Get the width.
  85    * @SINCE_1_0.0
  86    * @return the x dimension stored in this 2-tuple
  87    */
  88   uint16_t GetWidth() const
  89   {
  90     return mComponents[0];
  91   }
  92
  93   /**
  94    * @brief Sets the height.
  95    * @SINCE_1_1.13
  96    * @param[in] height The y dimension to be stored in this 2-tuple
  97    */
  98   void SetHeight( uint16_t height )
  99   {
 100     mComponents[1] = height;
 101   }
 102
 103   /**
 104    * @brief Returns the y dimension stored in this 2-tuple.
 105    * @SINCE_1_0.0
 106    * @return Height
 107    */
 108   uint16_t GetHeight() const
 109   {
 110     return mComponents[1];
 111   }
 112
 113   /**
 114    * @brief Sets the x dimension (same as width).
 115    * @SINCE_1_1.14
 116    * @param[in] x The x dimension to be stored in this 2-tuple
 117    */
 118   void SetX( uint16_t x )
 119   {
 120     mComponents[0] = x;
 121   }
 122
 123   /**
 124    * @brief Returns the x dimension stored in this 2-tuple.
 125    * @SINCE_1_0.0
 126    * @return X
 127    */
 128   uint16_t GetX()  const
 129   {
 130     return mComponents[0];
 131   }
 132
 133   /**
 134    * @brief Sets the y dimension (same as height).
 135    * @SINCE_1_1.14
 136    * @param[in] y The y dimension to be stored in this 2-tuple
 137    */
 138   void SetY( uint16_t y )
 139   {
 140     mComponents[1] = y;
 141   }
 142
 143   /**
 144    * @brief Returns the y dimension stored in this 2-tuple.
 145    * @SINCE_1_0.0
 146    * @return Y
 147    */
 148   uint16_t GetY() const
 149   {
 150     return mComponents[1];
 151   }
 152
 153   /**
 154    * @brief Equality operator.
 155    * @SINCE_1_0.0
 156    * @param[in] rhs A reference for comparison
 157    * @return True if same
 158    */
 159   bool operator==( const Uint16Pair& rhs ) const
 160   {
 161     return mData == rhs.mData;
 162   }
 163
 164   /**
 165    * @brief Inequality operator.
 166    * @SINCE_1_0.0
 167    * @param[in] rhs A reference for comparison
 168    * @return True if different
 169    */
 170   bool operator!=( const Uint16Pair& rhs ) const
 171   {
 172     return mData != rhs.mData;
 173   }
 174
 175   /**
 176    * @brief Less than comparison operator for storing in collections (not geometrically
 177    * meaningful).
 178    * @SINCE_1_0.0
 179    * @param[in] rhs A reference for comparison
 180    * @return True if less
 181    */
 182   bool operator<( const Uint16Pair& rhs ) const
 183   {
 184     return mData < rhs.mData;
 185   }
 186
 187   /**
 188    * @brief Greater than comparison operator for storing in collections (not
 189    * geometrically meaningful).
 190    * @SINCE_1_0.0
 191    * @param[in] rhs A reference for comparison
 192    * @return True if greater
 193    */
 194   bool operator>( const Uint16Pair& rhs ) const
 195   {
 196     return mData > rhs.mData;
 197   }
 198
 199   /**
 200    * @brief Creates an instance by rounding a floating point vector to closest
 201    * integers.
 202    *
 203    * Uses a template for loose coupling, to save a header include, and allow any
 204    * vector type with .x and .y members to be converted.
 205    * @SINCE_1_0.0
 206    * @param[in] from Floating point vector2
 207    * @return Closest integer value
 208    */
 209   template<typename FLOAT_VECTOR_N_TYPE>
 210   static Uint16Pair FromFloatVec2( const FLOAT_VECTOR_N_TYPE& from )
 211   {
 212     DALI_ASSERT_DEBUG( from.x + 0.5f < 65536.0f );
 213     DALI_ASSERT_DEBUG( from.y + 0.5f < 65536.0f );
 214     return Uint16Pair( from.x + 0.5f, from.y + 0.5f );
 215   }
 216
 217   /**
 218    * @brief Creates an instance by rounding a floating point array to closest
 219    * integers.
 220    *
 221    * Uses a template to allow any vector type with operator [] to be converted
 222    * in addition to plain arrays.
 223    * @SINCE_1_0.0
 224    * @param[in] from Floating point array
 225    * @return Closest integer value
 226    */
 227   template<typename FLOAT_ARRAY>
 228   static Uint16Pair FromFloatArray( const FLOAT_ARRAY& from )
 229   {
 230     DALI_ASSERT_DEBUG( from[0] + 0.5f < 65536.0f );
 231     DALI_ASSERT_DEBUG( from[1] + 0.5f < 65536.0f );
 232     return Uint16Pair( from[0] + 0.5f, from[1] + 0.5f );
 233   }
 234
 235 public:
 236
 237   Uint16Pair( const Uint16Pair& ) = default; ///< Default copy constructor
 238   Uint16Pair( Uint16Pair&& ) = default; ///< Default move constructor
 239   Uint16Pair& operator=( const Uint16Pair& ) = default; ///< Default copy assignment operator
 240   Uint16Pair& operator=( Uint16Pair&& ) = default; ///< Default move assignment operator
 241
 242 private:
 243   union
 244   {
 245     // Addressable view of X and Y:
 246     uint16_t mComponents[2];
 247     // Packed view of X and Y to force alignment and allow a faster copy:
 248     uint32_t mData;
 249   };
 250 };
 251
 252 // Allow Uint16Pair to be treated as a POD type
 253 template <> struct TypeTraits< Uint16Pair > : public BasicTypes< Uint16Pair > { enum { IS_TRIVIAL_TYPE = true }; };
 254
 255 /**
 256  * @}
 257  */
 258 } // namespace Dali
 259
 260 #endif // DALI_UINT_16_PAIR_H