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) 2015 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 Copy constructor.
  75    * @SINCE_1_0.0
  76    * @param rhs to copy from
  77    */
  78   Uint16Pair( const Uint16Pair& rhs )
  79   {
  80     mData = rhs.mData;
  81   }
  82
  83   /**
  84    * @brief Sets the width.
  85    * @SINCE_1_1.13
  86    * @param[in] width The x dimension to be stored in this 2-tuple.
  87    */
  88   void SetWidth( uint16_t width )
  89   {
  90     mComponents[0] = width;
  91   }
  92
  93   /**
  94    * @brief @returns the x dimension stored in this 2-tuple.
  95    * @SINCE_1_0.0
  96    */
  97   uint16_t GetWidth() const
  98   {
  99     return mComponents[0];
 100   }
 101
 102   /**
 103    * @brief Sets the height.
 104    * @SINCE_1_1.13
 105    * @param[in] height The y dimension to be stored in this 2-tuple.
 106    */
 107   void SetHeight( uint16_t height )
 108   {
 109     mComponents[1] = height;
 110   }
 111
 112   /**
 113    * @brief @returns the y dimension stored in this 2-tuple.
 114    * @SINCE_1_0.0
 115    */
 116   uint16_t GetHeight() const
 117   {
 118     return mComponents[1];
 119   }
 120
 121   /**
 122    * @brief Sets the x dimension (same as width).
 123    * @SINCE_1_1.14
 124    * @param[in] x The x dimension to be stored in this 2-tuple.
 125    */
 126   void SetX( uint16_t x )
 127   {
 128     mComponents[0] = x;
 129   }
 130
 131   /**
 132    * @brief @returns the x dimension stored in this 2-tuple.
 133    * @SINCE_1_0.0
 134    */
 135   uint16_t GetX()  const
 136   {
 137     return mComponents[0];
 138   }
 139
 140   /**
 141    * @brief Sets the y dimension (same as height).
 142    * @SINCE_1_1.14
 143    * @param[in] y The y dimension to be stored in this 2-tuple.
 144    */
 145   void SetY( uint16_t y )
 146   {
 147     mComponents[1] = y;
 148   }
 149
 150   /**
 151    * @brief @returns the y dimension stored in this 2-tuple.
 152    * @SINCE_1_0.0
 153    */
 154   uint16_t GetY() const
 155   {
 156     return mComponents[1];
 157   }
 158
 159   /**
 160    * @brief Assignment operator.
 161    * @SINCE_1_0.0
 162    */
 163   Uint16Pair& operator=( const Uint16Pair& rhs )
 164   {
 165     if( rhs != *this )
 166     {
 167       mData = rhs.mData;
 168     }
 169     return *this;
 170   }
 171
 172   /**
 173    * @brief Equality operator.
 174    * @SINCE_1_0.0
 175    */
 176   bool operator==( const Uint16Pair& rhs ) const
 177   {
 178     return mData == rhs.mData;
 179   }
 180
 181   /**
 182    * @brief Inequality operator.
 183    * @SINCE_1_0.0
 184    */
 185   bool operator!=( const Uint16Pair& rhs ) const
 186   {
 187     return mData != rhs.mData;
 188   }
 189
 190   /**
 191    * @brief Less than comparison operator for storing in collections (not geometrically
 192    * meaningful).
 193    * @SINCE_1_0.0
 194    */
 195   bool operator<( const Uint16Pair& rhs ) const
 196   {
 197     return mData < rhs.mData;
 198   }
 199
 200   /**
 201    * @brief Greater than comparison operator for storing in collections (not
 202    * geometrically meaningful).
 203    * @SINCE_1_0.0
 204    */
 205   bool operator>( const Uint16Pair& rhs ) const
 206   {
 207     return mData > rhs.mData;
 208   }
 209
 210   /**
 211    * @brief Create an instance by rounding a floating point vector to closest
 212    * integers.
 213    *
 214    * Uses a template for loose coupling, to save a header include, and allow any
 215    * vector type with .x and .y members to be converted.
 216    * @SINCE_1_0.0
 217    */
 218   template<typename FLOAT_VECTOR_N_TYPE>
 219   static Uint16Pair FromFloatVec2( const FLOAT_VECTOR_N_TYPE& from )
 220   {
 221     DALI_ASSERT_DEBUG( from.x + 0.5f < 65536.0f );
 222     DALI_ASSERT_DEBUG( from.y + 0.5f < 65536.0f );
 223     return Uint16Pair( from.x + 0.5f, from.y + 0.5f );
 224   }
 225
 226   /**
 227    * @brief Create an instance by rounding a floating point array to closest
 228    * integers.
 229    *
 230    * Uses a template to allow any vector type with operator [] to be converted
 231    * in addition to plain arrays.
 232    * @SINCE_1_0.0
 233    */
 234   template<typename FLOAT_ARRAY>
 235   static Uint16Pair FromFloatArray( const FLOAT_ARRAY& from )
 236   {
 237     DALI_ASSERT_DEBUG( from[0] + 0.5f < 65536.0f );
 238     DALI_ASSERT_DEBUG( from[1] + 0.5f < 65536.0f );
 239     return Uint16Pair( from[0] + 0.5f, from[1] + 0.5f );
 240   }
 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__