aboutsummaryrefslogtreecommitdiffstats
path: root/include/rba/RBABasePoint.hpp
blob: de5eb9a1c64fd3e8377f049219d50f2b3e0bc924 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
/**
 * Copyright (c) 2019 DENSO CORPORATION.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * Base point class
 */

#ifndef RBABASEPOINT_HPP
#define RBABASEPOINT_HPP

namespace rba
{

/**
 * @enum RBABasePoint
 * Base point for object having size. For example Area.
 */
enum class RBABasePoint : std::uint8_t
{
  /**
   * @brief Defines Left-Top coordinate as the base point of (x, y)
   * The rectangle is represented by (x, y)-(x+width, y+height)
   */
  LEFT_TOP,

  /**
   * @brief Defines Left-Middle coordinate as the base point of (x, y)
   * The rectangle is represented by (x, y-height/2)-(x+width, y+height/2)
   */
  LEFT_MIDDLE,

  /**
   * @brief Defines Left-Bottom coordinate as the base point of (x, y)
   * The rectangle is represented by (x, y-height)-(x+width, y)
   */
  LEFT_BOTTOM,

  /**
   * @brief Defines Right-Top coordinate as the base point of (x, y)
   * The rectangle is represented by (x-width, y)-(x, y+height)
   */
  RIGHT_TOP,

  /**
   * @brief Defines Right-Middle coordinate as the base point of (x, y)
   * The rectangle is represented by (x-width, y-height/2)-(x, y+height/2)
   */
  RIGHT_MIDDLE,

  /**
   * @brief Defines Right-Bottom coordinate as the base point of (x, y)
   * The rectangle is represented by (x-width, y-height)-(x, y)
   */
  RIGHT_BOTTOM,

  /**
   * @brief Defines Center-Top coordinate as the base point of (x, y)
   * The rectangle is represented by (x-width/2, y)-(x+width/2, y+height)
   */
  CENTER_TOP,

  /**
   * @brief Defines Center-Middle coordinate as the base point of (x, y)
   * The rectangle is represented by (x-width/2, y-height/2)-(x+width/2, y+height/2)
   */
  CENTER_MIDDLE,

  /**
   * @brief Defines Center-Bottom coordinate as the base point of (x, y)
   * The rectangle is represented by (x-width/2, y-height)-(x+width/2, y)
   */
  CENTER_BOTTOM
};

}

#endif