Source code for mini_arcade_core.spaces.d2.kinematics2d

"""
Kinematic helpers for mini_arcade_core (position + size + velocity).
"""

from __future__ import annotations

from dataclasses import dataclass
from typing import Optional

from ..geometry.bounds import Position2D, Size2D
from .collision2d import Collider2D
from .physics2d import Velocity2D




@dataclass
class KinematicData:
    """
    Simple data structure to hold position, size, and velocity.

    :ivar position (Position2D): Top-left position of the object.
    :ivar size (Size2D): Size of the object.
    :ivar velocity (Velocity2D): Velocity of the object.
    :ivar color (Optional[Color]): Optional color for rendering.
    """

    position: Position2D
    size: Size2D
    velocity: Velocity2D
    time_scale: float = 1.0
    collider: Optional[Collider2D] = None

    # Justification: Convenience factory with many params.
    # pylint: disable=too-many-arguments,too-many-positional-arguments


    @classmethod
    def rect(
        cls,
        x: float,
        y: float,
        width: int,
        height: int,
        vx: float = 0.0,
        vy: float = 0.0,
        time_scale: float = 1.0,
    ) -> "KinematicData":
        """
        Convenience factory for rectangular kinematic data.

        :param x: Top-left X position.
        :type x: float

        :param y: Top-left Y position.
        :type y: float

        :param width: Width of the object.
        :type width: int

        :param height: Height of the object.
        :type height: int

        :param vx: Velocity in the X direction.
        :type vx: float

        :param vy: Velocity in the Y direction.
        :type vy: float

        :return: KinematicData instance with the specified parameters.
        :rtype: KinematicData
        """
        return cls(
            position=Position2D(float(x), float(y)),
            size=Size2D(int(width), int(height)),
            velocity=Velocity2D(float(vx), float(vy)),
            time_scale=time_scale,
        )



    # pylint: enable=too-many-arguments,too-many-positional-arguments