inc/FGrpCoordinateSystem.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Flora License, Version 1.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://floralicense.org/license/
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an AS IS BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17
  18 /**
  19  * @file        FGrpCoordinateSystem.h
  20  * @brief       This is the header file for the %CoordinateSystem class.
  21  *
  22  * This header file contains the declarations of the %CoordinateSystem class.
  23  */
  24
  25 #ifndef _FGRP_COORDINATE_SYSTEM_H_
  26 #define _FGRP_COORDINATE_SYSTEM_H_
  27
  28
  29 #include <FGrpDimension.h>
  30
  31
  32 namespace Tizen { namespace Graphics
  33 {
  34
  35 /**
  36  * @class       CoordinateSystem
  37  * @brief       This class provides various utility methods for coordinate handling.
  38  *
  39  * @since 2.0
  40  *
  41  * The %CoordinateSystem class provides various utility methods for coordinate handling.
  42  *
  43  */
  44 class _OSP_EXPORT_ CoordinateSystem
  45 {
  46 public:
  47         /**
  48          * Returns the screen resolution in logical coordinates.
  49          *
  50          * @since 2.0
  51          *
  52          * @return                      The screen resolution in logical coordinates
  53          */
  54         static Dimension GetLogicalResolution(void);
  55
  56         /**
  57          * Returns the screen resolution in physical coordinates.
  58          *
  59          * @since 2.0
  60          *
  61          * @return                      The screen resolution in physical coordinates
  62          */
  63         static Dimension GetPhysicalResolution(void);
  64
  65         /**
  66          * Converts the physical value along x-axis to the logical one.
  67          *
  68          * @since 2.0
  69          *
  70          * @return                      The converted logical value for the physical one
  71          * @param[in]                   physicalX       An input physical value to be converted
  72          */
  73         static int ConvertToLogicalX(int physicalX);
  74
  75         /**
  76          * Converts the physical value along y-axis to the logical one.
  77          *
  78          * @since 2.0
  79          *
  80          * @return                      The converted logical value for the physical one
  81          * @param[in]                   physicalY       An input physical value to be converted
  82          */
  83         static int ConvertToLogicalY(int physicalY);
  84
  85         /**
  86          * Converts the logical value along x-axis to the physical one.
  87          *
  88          * @since 2.0
  89          *
  90          * @return                      The converted physical X value
  91          * @param[in]                   logicalX        An input logical value to be converted
  92          */
  93         static int ConvertToPhysicalX(int logicalX);
  94
  95         /**
  96          * Converts the logical value along y-axis to the physical one.
  97          *
  98          * @since 2.0
  99          *
 100          * @return                      The converted physical Y value
 101          * @param[in]                   logicalY        An input logical value to be converted
 102          */
 103         static int ConvertToPhysicalY(int logicalY);
 104
 105 private:
 106         //
 107         // This default constructor is intentionally declared as private because this class cannot be constructed.
 108         //
 109         CoordinateSystem(void);
 110
 111         //
 112         // This destructor is intentionally declared as private because this class cannot be constructed.
 113         //
 114         ~CoordinateSystem(void);
 115
 116 }; // CoordinateSystem
 117
 118 }} // Tizen::Graphics
 119
 120 #endif // _FGRP_COORDINATE_SYSTEM_H_