Source code for rubato.structure.gameobject.component

"""
The component abstraction that represents a template for all component types.

Attention:
    Each component can only be attached to one game object. To add one component to multiple game objects, use the
    ``clone()`` method.
"""
from __future__ import annotations
from typing import TYPE_CHECKING

from ... import Vector, Camera

if TYPE_CHECKING:
    from .. import GameObject


class Component:
    """
    A component adds functionality to the game object it is attached to. Note that this is a template class and should
    not be used directly. Instead, create another class and extend from this one.

    Args:
        offset: The offset of the component from the game object. Defaults to (0, 0).
        rot_offset: The rotation offset of the component from the game object. Defaults to 0.
        z_index: The vertical offset of where to draw the component. Defaults to 0.
        hidden: Whether the component is hidden or not. Defaults to False.
    """

    def __init__(
        self,
        offset: Vector | tuple[float, float] = (0, 0),
        rot_offset: float = 0,
        z_index: int = 0,
        hidden: bool = False
    ):
        self.singular: bool = False
        """Whether multiple components of the same type are allowed on a game object."""
        self.offset: Vector = Vector.create(offset)
        """The offset from the center of the game object that the hitbox should be placed."""
        self.rot_offset: float = rot_offset
        """The rotational offset from the game object's rotation."""
        self.z_index: int = z_index
        """Where to draw the component in the z direction."""
        self.hidden = hidden
        """Whether the component is hidden (not drawn)."""
        self.gameobj: GameObject
        """The game object this component is attached to."""
        self.__started = False

    def true_z(self) -> int:
        """Returns the z_index of the component offset by its parent gameobject z_index."""
        return self.z_index + self.gameobj.z_index

    def true_pos(self) -> Vector:
        """Returns the world position of the component."""
        return self.gameobj.pos + self.offset.rotate(self.gameobj.rotation)

    def true_rotation(self) -> float:
        """Returns the rotation of the component offset by its parent gameobject rotation."""
        return self.rot_offset + self.gameobj.rotation

    def _setup(self):
        self.__started = True
        self.setup()

    def _update(self):
        if not self.__started:
            self._setup()

        self.update()

    def setup(self):
        """The setup function for a component."""
        pass

    def update(self):
        """The update function for a component."""
        pass

    def draw(self, camera: Camera):
        """
        The draw function for a component.

        Args:
            camera: The camera to draw the component with.
        """
        pass

    def fixed_update(self):
        """The physics function for a component."""
        pass

    def clone(self) -> Component:
        """Clones the component."""
        new = Component(
            offset=self.offset.clone(), rot_offset=self.rot_offset, z_index=self.z_index, hidden=self.hidden
        )
        new.singular = self.singular
        return new

    def __repr__(self):
        return (
            f"Component(offset={self.offset}, rot_offset={self.rot_offset}, "
            f"z_index={self.z_index}, hidden={self.hidden})"
        )

    def __str__(self):
        if hasattr(self, "gameobj"):
            return f"<{type(self).__name__} with GameObject '{self.gameobj.name}' at {hex(id(self))}>"
        else:
            return f"<{type(self).__name__} with no GameObject at {hex(id(self))}>"