Ver Fonte

[Core] Grammar, move defs to defs

Math constant definitions belong in `math_defs.h`. Also, the grammer in these files really needed some updating.
Aaron Franke há 7 anos atrás
pai
commit
9170d932e3
4 ficheiros alterados com 54 adições e 56 exclusões
  1. 0 36
      core/math/math_2d.h
  2. 50 9
      core/math/math_defs.h
  3. 0 7
      core/math/math_funcs.h
  4. 4 4
      core/typedefs.h

+ 0 - 36
core/math/math_2d.h

@@ -37,42 +37,6 @@
 /**
 	@author Juan Linietsky <[email protected]>
 */
-enum Margin {
-
-	MARGIN_LEFT,
-	MARGIN_TOP,
-	MARGIN_RIGHT,
-	MARGIN_BOTTOM
-};
-
-enum Corner {
-
-	CORNER_TOP_LEFT,
-	CORNER_TOP_RIGHT,
-	CORNER_BOTTOM_RIGHT,
-	CORNER_BOTTOM_LEFT
-};
-
-enum Orientation {
-
-	HORIZONTAL,
-	VERTICAL
-};
-
-enum HAlign {
-
-	HALIGN_LEFT,
-	HALIGN_CENTER,
-	HALIGN_RIGHT
-};
-
-enum VAlign {
-
-	VALIGN_TOP,
-	VALIGN_CENTER,
-	VALIGN_BOTTOM
-};
-
 struct Transform2D;
 
 struct Rect2 {

+ 50 - 9
core/math/math_defs.h

@@ -36,30 +36,71 @@
 #define CMP_NORMALIZE_TOLERANCE 0.000001
 #define CMP_POINT_IN_PLANE_EPSILON 0.00001
 
+#define Math_SQRT12 0.7071067811865475244008443621048490
+#define Math_SQRT2 1.4142135623730950488016887242
+#define Math_LN2 0.6931471805599453094172321215
+#define Math_TAU 6.2831853071795864769252867666
+#define Math_PI 3.1415926535897932384626433833
+#define Math_E 2.7182818284590452353602874714
+#define Math_INF INFINITY
+#define Math_NAN NAN
+
 #ifdef DEBUG_ENABLED
 #define MATH_CHECKS
 #endif
 
 #define USEC_TO_SEC(m_usec) ((m_usec) / 1000000.0)
-/**
-  * "Real" is a type that will be translated to either floats or fixed depending
-  * on the compilation setting
-  */
 
 enum ClockDirection {
-
 	CLOCKWISE,
 	COUNTERCLOCKWISE
 };
 
-#ifdef REAL_T_IS_DOUBLE
+enum Orientation {
 
-typedef double real_t;
+	HORIZONTAL,
+	VERTICAL
+};
 
-#else
+enum HAlign {
 
-typedef float real_t;
+	HALIGN_LEFT,
+	HALIGN_CENTER,
+	HALIGN_RIGHT
+};
+
+enum VAlign {
+
+	VALIGN_TOP,
+	VALIGN_CENTER,
+	VALIGN_BOTTOM
+};
 
+enum Margin {
+
+	MARGIN_LEFT,
+	MARGIN_TOP,
+	MARGIN_RIGHT,
+	MARGIN_BOTTOM
+};
+
+enum Corner {
+
+	CORNER_TOP_LEFT,
+	CORNER_TOP_RIGHT,
+	CORNER_BOTTOM_RIGHT,
+	CORNER_BOTTOM_LEFT
+};
+
+/**
+  * The "Real" type is an abstract type used for real numbers, such as 1.5, 
+  * in contrast to integer numbers. Precision can be controlled with the
+  * presence or absence of the REAL_T_IS_DOUBLE define. 
+  */
+#ifdef REAL_T_IS_DOUBLE
+typedef double real_t;
+#else
+typedef float real_t;
 #endif
 
 #endif // MATH_DEFS_H

+ 0 - 7
core/math/math_funcs.h

@@ -39,13 +39,6 @@
 #include <float.h>
 #include <math.h>
 
-#define Math_PI 3.14159265358979323846
-#define Math_TAU 6.28318530717958647692
-#define Math_SQRT12 0.7071067811865475244008443621048490
-#define Math_LN2 0.693147180559945309417
-#define Math_INF INFINITY
-#define Math_NAN NAN
-
 class Math {
 
 	static pcg32_random_t default_pcg;

+ 4 - 4
core/typedefs.h

@@ -33,7 +33,7 @@
 
 #include <stddef.h>
 /**
- * Basic definitions and simple functions to be used everywhere..
+ * Basic definitions and simple functions to be used everywhere.
  */
 
 #include "platform_config.h"
@@ -71,7 +71,7 @@ T *_nullptr() {
 #define OFFSET_OF(st, m) \
 	((size_t)((char *)&(_nullptr<st>()->m) - (char *)0))
 /**
- * Some platforms (devices) not define NULL
+ * Some platforms (devices) don't define NULL
  */
 
 #ifndef NULL
@@ -79,7 +79,7 @@ T *_nullptr() {
 #endif
 
 /**
- * Windows defines a lot of badly stuff we'll never ever use. undefine it.
+ * Windows badly defines a lot of stuff we'll never use. Undefine it.
  */
 
 #ifdef _WIN32
@@ -296,4 +296,4 @@ struct _GlobalLock {
 #define unlikely(x) x
 #endif
 
-#endif /* typedefs.h */
+#endif // TYPEDEFS_H