Source code for rubato.misc

"""Miscellaneous helper functions for rubato developers."""
from typing import List

from . import Vector, GameObject, Component, Game, Input

def world_mouse() -> Vector:
    """
    Returns the mouse position in world-coordinates.

    Returns:
        Vector: The mouse position in world coordinates.
    """
    return Game.camera.i_transform(Input.get_mouse_pos())

def wrap(
    comp: Component | List[Component],
    name: str = "",
    pos: Vector = Vector(),
    rotation: float = 0,
    z_index: int = 0,
    debug: bool = False
):
    """
    Wraps a component or list of components in a GameObject.

    Args:
        comp: The component or list of components to wrap.
        name: The name of the GameObject. Defaults to "".
        pos: The position of the GameObject. Defaults to Vector().
        rotation: The rotation of the GameObject. Defaults to 0.
        z_index: The z_index of the GameObject. Defaults to 0.
        debug: Whether the GameObject is in debug mode. Defaults to False.

    Raises:
        TypeError: If comp is not a Component or a list of Components.

    Returns:
        The wrapped GameObject.
    """
    go = GameObject(name=name, pos=pos, rotation=rotation, z_index=z_index, debug=debug)
    if isinstance(comp, Component):
        go.add(comp)
    elif isinstance(comp, list):
        go.add(*comp)
    else:
        raise TypeError("comp must be a Component or a list of Components.")
    return go