inc/engine/graphic/FloatDimension.h

   1 //
   2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   3 //
   4 // Licensed under the Apache License, Version 2.0 (the License);
   5 // you may not use this file except in compliance with the License.
   6 // You may obtain a copy of the License at
   7 //
   8 //     http://www.apache.org/licenses/LICENSE-2.0
   9 //
  10 // Unless required by applicable law or agreed to in writing, software
  11 // distributed under the License is distributed on an "AS IS" BASIS,
  12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 // See the License for the specific language governing permissions and
  14 // limitations under the License.
  15 //
  16
  17 #ifndef HERE_GRAPHIC_FLOATDIMENTION_H
  18 #define HERE_GRAPHIC_FLOATDIMENTION_H
  19
  20 #include "common/HereMaps_global.h"
  21 #include "base/BaseObject.h"
  22
  23 TIZEN_MAPS_BEGIN_NAMESPACE
  24
  25 class FloatDimension;
  26
  27 class EXPORT_API FloatDimension :       public Object
  28 {
  29 public:
  30         /**
  31          * This is the default constructor for this class. @n
  32          * This constructor initializes an instance of %FloatDimension with the width and the height set as @c 0.f.
  33          *
  34          * @since 2.0
  35          */
  36         FloatDimension(void);
  37
  38         /**
  39          * This is the copy constructor for the %FloatDimension class.
  40          *
  41          * @since 2.0
  42          *
  43          * @param[in]     rhs                     An instance of %FloatDimension
  44          */
  45         FloatDimension(const FloatDimension& rhs);
  46
  47         /**
  48          * Initializes an instance of %FloatDimension with the specified values of width and height.
  49          *
  50          * @since 2.0
  51          *
  52          * @param[in]   width   The width to set
  53          * @param[in]   height  The height to set
  54          */
  55         FloatDimension(float width, float height);
  56
  57         /**
  58          * This is the destructor for this class.
  59          *
  60          * @since 2.0
  61          */
  62         virtual ~FloatDimension(void);
  63
  64         /**
  65          * This is the default assignment operator for this class.
  66          *
  67          * @since 2.0
  68          *
  69          * @param[in]     rhs                     An instance of %FloatDimension
  70          */
  71         FloatDimension& operator=(const FloatDimension& rhs);
  72
  73         /**
  74          * Checks whether the two instances of %FloatDimension have equal width and height values.
  75          *
  76          * @since 2.0
  77          *
  78          * @return              @c true if the values of the width and height of the two instances of %FloatDimension are equal, @n
  79          *                              else @c false
  80          * @param[in]   rhs             An instance of %FloatDimension
  81          */
  82         bool operator==(const FloatDimension& rhs) const;
  83
  84         /**
  85          * Checks whether the two instances of %FloatDimension have different width and height values.
  86          *
  87          * @since 2.0
  88          *
  89          * @return              @c true if the values of the width and height of the two instances of %FloatDimension are not equal, @n
  90          *                              else @c false
  91          * @param[in]   rhs             An instance of %FloatDimension
  92          */
  93         bool operator!=(const FloatDimension& rhs) const;
  94
  95         /**
  96          * Checks whether the value of the current instance of %FloatDimension equals the value of the specified instance.
  97          *
  98          * @since 2.0
  99          *
 100          * @return              @c true if the value of the current instance equals the value of the specified instance, @n
 101          *                              else @c false
 102          * @param[in]   rhs             An instance of %FloatDimension
 103          * @remarks             The %FloatDimension class has a semantic value, which means that the
 104          *                              Equals() method checks whether the two instances have the same width and height.
 105          */
 106         virtual bool Equals(const Object& rhs) const;
 107
 108         /**
 109          * Gets the hash value of the current instance.
 110          *
 111          * @since 2.0
 112          *
 113          * @return              The hash value of the current instance
 114          * @remarks             Two equal instances must return the same hash value. For better performance,
 115          *                              the used hash function must generate a random distribution for all inputs.
 116          */
 117         virtual long GetHashCode(void) const;
 118
 119         /**
 120          * Sets the size of the current instance of %FloatDimension.
 121          *
 122          * @since 2.0
 123          *
 124          * @param[in]   width           The new width
 125          * @param[in]   height          The new height
 126          */
 127         void SetSize(float width, float height);
 128
 129 public:
 130         /**
 131          * The width of the current instance of %FloatDimension.
 132          *
 133          * @since 2.0
 134          */
 135         float width;
 136
 137         /**
 138          * The height of the current instance of %FloatDimension.
 139          *
 140          * @since 2.0
 141          */
 142         float height;
 143
 144 private:
 145         friend class _FloatDimensionImpl;
 146
 147         //
 148         // This variable is for internal use only.
 149         // Using this variable can cause behavioral, security-related, and consistency-related issues in the application.
 150         //
 151         // @since 2.0
 152         //
 153         class _FloatDimensionImpl* __pImpl;
 154
 155 }; // FloatDimension
 156
 157 TIZEN_MAPS_END_NAMESPACE
 158
 159 #endif /* HERE_GRAPHIC_FLOATDIMENTION_H */