1/**************************************************************************/
2/* math_defs.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef MATH_DEFS_H
32#define MATH_DEFS_H
33
34#define CMP_EPSILON 0.00001
35#define CMP_EPSILON2 (CMP_EPSILON * CMP_EPSILON)
36
37#define CMP_NORMALIZE_TOLERANCE 0.000001
38#define CMP_POINT_IN_PLANE_EPSILON 0.00001
39
40#define Math_SQRT12 0.7071067811865475244008443621048490
41#define Math_SQRT2 1.4142135623730950488016887242
42#define Math_LN2 0.6931471805599453094172321215
43#define Math_TAU 6.2831853071795864769252867666
44#define Math_PI 3.1415926535897932384626433833
45#define Math_E 2.7182818284590452353602874714
46
47#ifdef DEBUG_ENABLED
48#define MATH_CHECKS
49#endif
50
51//this epsilon is for values related to a unit size (scalar or vector len)
52#ifdef PRECISE_MATH_CHECKS
53#define UNIT_EPSILON 0.00001
54#else
55//tolerate some more floating point error normally
56#define UNIT_EPSILON 0.001
57#endif
58
59#define USEC_TO_SEC(m_usec) ((m_usec) / 1000000.0)
60
61enum ClockDirection {
62 CLOCKWISE,
63 COUNTERCLOCKWISE
64};
65
66enum Orientation {
67 HORIZONTAL,
68 VERTICAL
69};
70
71enum HorizontalAlignment {
72 HORIZONTAL_ALIGNMENT_LEFT,
73 HORIZONTAL_ALIGNMENT_CENTER,
74 HORIZONTAL_ALIGNMENT_RIGHT,
75 HORIZONTAL_ALIGNMENT_FILL,
76};
77
78enum VerticalAlignment {
79 VERTICAL_ALIGNMENT_TOP,
80 VERTICAL_ALIGNMENT_CENTER,
81 VERTICAL_ALIGNMENT_BOTTOM,
82 VERTICAL_ALIGNMENT_FILL,
83};
84
85enum InlineAlignment {
86 // Image alignment points.
87 INLINE_ALIGNMENT_TOP_TO = 0b0000,
88 INLINE_ALIGNMENT_CENTER_TO = 0b0001,
89 INLINE_ALIGNMENT_BASELINE_TO = 0b0011,
90 INLINE_ALIGNMENT_BOTTOM_TO = 0b0010,
91 INLINE_ALIGNMENT_IMAGE_MASK = 0b0011,
92
93 // Text alignment points.
94 INLINE_ALIGNMENT_TO_TOP = 0b0000,
95 INLINE_ALIGNMENT_TO_CENTER = 0b0100,
96 INLINE_ALIGNMENT_TO_BASELINE = 0b1000,
97 INLINE_ALIGNMENT_TO_BOTTOM = 0b1100,
98 INLINE_ALIGNMENT_TEXT_MASK = 0b1100,
99
100 // Presets.
101 INLINE_ALIGNMENT_TOP = INLINE_ALIGNMENT_TOP_TO | INLINE_ALIGNMENT_TO_TOP,
102 INLINE_ALIGNMENT_CENTER = INLINE_ALIGNMENT_CENTER_TO | INLINE_ALIGNMENT_TO_CENTER,
103 INLINE_ALIGNMENT_BOTTOM = INLINE_ALIGNMENT_BOTTOM_TO | INLINE_ALIGNMENT_TO_BOTTOM
104};
105
106enum Side {
107 SIDE_LEFT,
108 SIDE_TOP,
109 SIDE_RIGHT,
110 SIDE_BOTTOM
111};
112
113enum Corner {
114 CORNER_TOP_LEFT,
115 CORNER_TOP_RIGHT,
116 CORNER_BOTTOM_RIGHT,
117 CORNER_BOTTOM_LEFT
118};
119
120enum class EulerOrder {
121 XYZ,
122 XZY,
123 YXZ,
124 YZX,
125 ZXY,
126 ZYX
127};
128
129/**
130 * The "Real" type is an abstract type used for real numbers, such as 1.5,
131 * in contrast to integer numbers. Precision can be controlled with the
132 * presence or absence of the REAL_T_IS_DOUBLE define.
133 */
134#ifdef REAL_T_IS_DOUBLE
135typedef double real_t;
136#else
137typedef float real_t;
138#endif
139
140#endif // MATH_DEFS_H
141