Merge pull request #209 from pygame-community/align_object_attributes

Align attributes across objects

Author: itzpr3d4t0r

benchmarks/GEOMETRY_polygon_benchmark.py

@@ -72,10 +72,10 @@ def polygon(self):
     ("verts_num 3", "po3.verts_num"),
     ("vertices 4", "po4.vertices"),
     ("verts_num 4", "po4.verts_num"),
-    ("c_x 3", "po3.c_x"),
-    ("c_y 3", "po3.c_y"),
-    ("c_x 4", "po4.c_x"),
-    ("c_y 4", "po4.c_y"),
+    ("centerx 3", "po3.centerx"),
+    ("centery 3", "po3.centery"),
+    ("centerx 4", "po4.centerx"),
+    ("centery 4", "po4.centery"),
     ("center 3", "po3.center"),
     ("center 4", "po4.center"),
     ("perimeter 3", "po3.perimeter"),
@@ -88,10 +88,10 @@ def polygon(self):
     # ("vertices float", "po4.vertices = [p1_f, p2_f, p3_f, p4_f]"),
     ("center int", "po4.center = p1_i"),
     ("center float", "po4.center = p1_f"),
-    ("c_x int", "po4.c_x = 50"),
-    ("c_y int", "po4.c_y = 50"),
-    ("c_x float", "po4.c_x = 50.0"),
-    ("c_y float", "po4.c_y = 50.0"),
+    ("centerx int", "po4.centerx = 50"),
+    ("centery int", "po4.centery = 50"),
+    ("centerx float", "po4.centerx = 50.0"),
+    ("centery float", "po4.centery = 50.0"),
 ]
 
 copy_tests = [

docs/geometry.rst

@@ -88,11 +88,11 @@ other objects.
 
     angle: The angle of the line.
 
-    midpoint: The midpoint of the line.
+    center: The center of the line.
 
-    midpoint_x: The x coordinate of the midpoint of the line.
+    centerx: The x coordinate of the center of the line.
 
-    midpoint_y: The y coordinate of the midpoint of the line.
+    centery: The y coordinate of the center of the line.
 
     slope: The slope of the line.
 
@@ -160,9 +160,9 @@ other objects.
 
     center: The center point of the polygon.
 
-    c_x: The x coordinate of the center of the polygon.
+    centerx: The x coordinate of the center of the polygon.
 
-    c_y: The y coordinate of the center of the polygon.
+    centery: The y coordinate of the center of the polygon.
 
     perimeter: The perimeter of the polygon.
 

docs/line.rst

@@ -111,32 +111,32 @@ Line Attributes
         This attribute is read-only, it cannot be reassigned. To change the line's slope
         use the `rotate` method or change its `a` or `b` attributes.
 
-    .. attribute:: midpoint
+    .. attribute:: center
         | :sl:`the coordinate of the middle point of the line`
-        | :sg:`midpoint -> (float, float)`
+        | :sg:`center -> (float, float)`
 
-        The midpoint of the line. Calculated using the `((x1 + x2) / 2, (y1 + y2) / 2)` formula.
+        The center of the line. Calculated using the `((x1 + x2) / 2, (y1 + y2) / 2)` formula.
         It can be reassigned to move the `Line`. If reassigned the `x1`, `y1`, `x2`, `y2`
-        attributes will be changed in order to produce a `Line` with matching midpoint.
+        attributes will be changed in order to produce a `Line` with matching center.
 
-    .. attribute:: midpoint_x
+    .. attribute:: centerx
         | :sl:`the x coordinate of the middle point of the line`
-        | :sg:`midpoint_x -> float`
+        | :sg:`centerx -> float`
 
-        The `x` coordinate of the midpoint of the line, it's calculated using
+        The `x` coordinate of the center of the line, it's calculated using
         the `((x1 + x2) / 2)` formula. It can be reassigned to move the `Line`.
         If reassigned the `x1` and `x2` attributes will be changed in order to
-        produce a `Line` with matching midpoint. The `y1` and `y2` attributes will not
+        produce a `Line` with matching center. The `y1` and `y2` attributes will not
         be affected.
 
-    .. attribute:: midpoint_y
+    .. attribute:: centery
         | :sl:`the y coordinate of the middle point of the line`
-        | :sg:`midpoint_y -> float`
+        | :sg:`centery -> float`
 
-        The `y` coordinate of the midpoint of the `Line`, it's calculated using
+        The `y` coordinate of the center of the `Line`, it's calculated using
         the `((y1 + y2) / 2)` formula. It can be reassigned to move the `Line`.
         If reassigned the `y1` and `y2` attributes will be changed in order to
-        produce a `Line` with matching midpoint. The `x1` and `x2` attributes will not
+        produce a `Line` with matching center. The `x1` and `x2` attributes will not
         be affected.
 
 Line Methods
@@ -220,7 +220,7 @@ Line Methods
         | :sg:`scale(factor_and_origin) -> Line`
 
         Returns a new `Line` which is scaled by the given factor from the specified origin with 0.0 being
-        the startpoint, 0.5 being the midpoint and 1.0 being the end point.
+        the startpoint, 0.5 being the center and 1.0 being the end point.
         The original `Line` is not modified.
 
       .. ## Line.scale ##
@@ -232,7 +232,7 @@ Line Methods
         | :sg:`scale_ip(factor_and_origin) -> None`
 
         Scales the `Line` by the given factor from the specified origin with 0.0 being
-        the startpoint, 0.5 being the midpoint and 1.0 being the end point.
+        the startpoint, 0.5 being the center and 1.0 being the end point.
         The original `Line` is modified.
 
       .. ## Line.scale_ip ##

docs/polygon.rst

@@ -79,18 +79,18 @@ Polygon Attributes
         move the `Polygon`. If reassigned, the `Polygon`'s vertices will be moved to
         create a `Polygon` with matching center.
 
-    .. attribute:: c_x
+    .. attribute:: centerx
         | :sl:`the x coordinate of the center of the polygon`
-        | :sg:`c_x -> float`
+        | :sg:`centerx -> float`
 
         It's the x coordinate of the center of the `Polygon`. It is calculated as the
         average of all the x coordinates of the vertices. It can be reassigned to move
         the `Polygon`. If reassigned, the polygon's vertices will be moved to
         create a `Polygon` with matching center.
 
-    .. attribute:: c_y
+    .. attribute:: centery
         | :sl:`the y coordinate of the center of the polygon`
-        | :sg:`c_y -> float`
+        | :sg:`centery -> float`
 
         It's the y coordinate of the center of the `Polygon`. It is calculated as the
         average of all the y coordinates of the vertices. It can be reassigned to move

examples/polygon_line_collision.py

@@ -5,11 +5,11 @@
 from geometry import Line, regular_polygon
 
 
-# using this because we're missing line.rotate(), rotates a line around its midpoint
+# using this because we're missing line.rotate(), rotates a line around its center
 def rotate_line(line, d_ang):
     angle = radians(d_ang)
     ca, sa = cos(angle), sin(angle)
-    xm, ym = line.midpoint
+    xm, ym = line.center
     ax, ay = line.a
     bx, by = line.b
     ax -= xm
@@ -64,7 +64,7 @@ def rotate_line(line, d_ang):
 while running:
     delta = (clock.tick(FPS) / 1000) * 60
 
-    line.midpoint = pygame.mouse.get_pos()
+    line.center = pygame.mouse.get_pos()
 
     colliding = line.collidepolygon(polygon, only_edges)
     # Alternative:

geometry.pyi

@@ -54,9 +54,9 @@ class Line(Sequence[float]):
     a: Tuple[float, float]
     b: Tuple[float, float]
     length: float
-    midpoint: Tuple[float, float]
-    midpoint_x: float
-    midpoint_y: float
+    center: Tuple[float, float]
+    centerx: float
+    centery: float
     slope: float
     __safe_for_unpickling__: Literal[True]
     __hash__: None  # type: ignore
@@ -205,8 +205,8 @@ class Polygon:
     vertices: List[Coordinate]
     verts_num: int
     perimeter: float
-    c_x: float
-    c_y: float
+    centerx: float
+    centery: float
     center: Tuple[float, float]
     __safe_for_unpickling__: Literal[True]
     __hash__: None  # type: ignore

src_c/geometry.c

@@ -257,8 +257,8 @@ geometry_regular_polygon(PyObject *_null, PyObject *const *args,
 
     ret->polygon.vertices = vertices;
     ret->polygon.verts_num = sides;
-    ret->polygon.c_x = Cx;
-    ret->polygon.c_y = Cy;
+    ret->polygon.centerx = Cx;
+    ret->polygon.centery = Cy;
 
     return (PyObject *)ret;
 }

src_c/include/geometry.h

@@ -63,7 +63,7 @@ static PyTypeObject pgPolygon_Type;
 typedef struct {
     Py_ssize_t verts_num;
     double *vertices;
-    double c_x, c_y;
+    double centerx, centery;
 } pgPolygonBase;
 
 typedef struct {
@@ -75,8 +75,8 @@ typedef struct {
 #define pgPolygon_AsPolygon(o) (pgPolygon_CAST(o)->polygon)
 #define pgPolygon_GETVERTICES(o) (pgPolygon_AsPolygon(o).vertices)
 #define pgPolygon_GETVERTSNUM(o) (pgPolygon_AsPolygon(o).verts_num)
-#define pgPolygon_GETCENTER_X(o) (pgPolygon_AsPolygon(o).c_x)
-#define pgPolygon_GETCENTER_Y(o) (pgPolygon_AsPolygon(o).c_y)
+#define pgPolygon_GETCENTER_X(o) (pgPolygon_AsPolygon(o).centerx)
+#define pgPolygon_GETCENTER_Y(o) (pgPolygon_AsPolygon(o).centery)
 
 // return 1 if success and 0 if failure
 static int

src_c/line.c

@@ -1236,21 +1236,21 @@ pg_line_getsafepickle(pgLineObject *self, void *closure)
 }
 
 static PyObject *
-pg_line_get_midpoint(pgLineObject *self, void *closure)
+pg_line_get_center(pgLineObject *self, void *closure)
 {
     return pg_TupleFromDoublePair((self->line.x1 + self->line.x2) / 2,
                                   (self->line.y1 + self->line.y2) / 2);
 }
 
 static int
-pg_line_set_midpoint(pgLineObject *self, PyObject *value, void *closure)
+pg_line_set_center(pgLineObject *self, PyObject *value, void *closure)
 {
     double m_x, m_y;
     DEL_ATTR_NOT_SUPPORTED_CHECK_NO_NAME(value);
     if (!pg_TwoDoublesFromObj(value, &m_x, &m_y)) {
         PyErr_SetString(
             PyExc_TypeError,
-            "Invalid midpoint value, expected a sequence of 2 numbers");
+            "Invalid center value, expected a sequence of 2 numbers");
         return -1;
     }
 
@@ -1266,19 +1266,19 @@ pg_line_set_midpoint(pgLineObject *self, PyObject *value, void *closure)
 }
 
 static PyObject *
-pg_line_get_midpoint_x(pgLineObject *self, void *closure)
+pg_line_get_centerx(pgLineObject *self, void *closure)
 {
     return PyFloat_FromDouble((self->line.x1 + self->line.x2) / 2);
 }
 
 static int
-pg_line_set_midpoint_x(pgLineObject *self, PyObject *value, void *closure)
+pg_line_set_centerx(pgLineObject *self, PyObject *value, void *closure)
 {
     double m_x;
     DEL_ATTR_NOT_SUPPORTED_CHECK_NO_NAME(value);
     if (!pg_DoubleFromObj(value, &m_x)) {
         PyErr_SetString(PyExc_TypeError,
-                        "Invalid midpoint_x value, expected a numeric value");
+                        "Invalid centerx value, expected a numeric value");
         return -1;
     }
 
@@ -1289,19 +1289,19 @@ pg_line_set_midpoint_x(pgLineObject *self, PyObject *value, void *closure)
 }
 
 static PyObject *
-pg_line_get_midpoint_y(pgLineObject *self, void *closure)
+pg_line_get_centery(pgLineObject *self, void *closure)
 {
     return PyFloat_FromDouble((self->line.y1 + self->line.y2) / 2);
 }
 
 static int
-pg_line_set_midpoint_y(pgLineObject *self, PyObject *value, void *closure)
+pg_line_set_centery(pgLineObject *self, PyObject *value, void *closure)
 {
     double m_y;
     DEL_ATTR_NOT_SUPPORTED_CHECK_NO_NAME(value);
     if (!pg_DoubleFromObj(value, &m_y)) {
         PyErr_SetString(PyExc_TypeError,
-                        "Invalid midpoint_y value, expected a numeric value");
+                        "Invalid centery value, expected a numeric value");
         return -1;
     }
 
@@ -1320,12 +1320,12 @@ static PyGetSetDef pg_line_getsets[] = {
     {"b", (getter)pg_line_getb, (setter)pg_line_setb, NULL, NULL},
     {"length", (getter)pg_line_getlength, NULL, NULL, NULL},
     {"slope", (getter)pg_line_getslope, NULL, NULL, NULL},
-    {"midpoint", (getter)pg_line_get_midpoint, (setter)pg_line_set_midpoint,
+    {"center", (getter)pg_line_get_center, (setter)pg_line_set_center,
      NULL, NULL},
-    {"midpoint_x", (getter)pg_line_get_midpoint_x,
-     (setter)pg_line_set_midpoint_x, NULL, NULL},
-    {"midpoint_y", (getter)pg_line_get_midpoint_y,
-     (setter)pg_line_set_midpoint_y, NULL, NULL},
+    {"centerx", (getter)pg_line_get_centerx,
+     (setter)pg_line_set_centerx, NULL, NULL},
+    {"centery", (getter)pg_line_get_centery,
+     (setter)pg_line_set_centery, NULL, NULL},
     {"angle", (getter)pg_line_getangle, NULL, NULL, NULL},
     {"__safe_for_unpickling__", (getter)pg_line_getsafepickle, NULL, NULL,
      NULL},