batframework 0.1.13__py3-none-any.whl → 1.0.1__py3-none-any.whl

batFramework/camera.py

@@ -1,95 +1,199 @@
-import batFramework as bf
 import pygame
 from pygame.math import Vector2
+import math
+import batFramework as bf
 
 
 class Camera:
-    def __init__(self, flags=0) -> None:
-        self.rect = pygame.FRect(0, 0, *bf.const.RESOLUTION)
+    _transform_cache = {}  # Cache for transformed surfaces
+
+    def __init__(self, flags=0, size: tuple[int,int] | None = None,convert_alpha:bool=False) -> None:
+        """
+        Initialize the Camera object.
+
+        Args:
+            flags (int): Flags for camera initialization.
+            size (tuple): Optional size for camera (defaults to window size)
+        """
+        # Initialize camera attributes
+        size = size if size else bf.const.RESOLUTION
+        self.rect = pygame.Rect(0, 0, *size)
         self.flags: int = flags
-        # self.blit_special_flags : int =pygame.BLEND_PREMULTIPLIED if (flags & pygame.SRCALPHA) else 0
         self.blit_special_flags: int = pygame.BLEND_ALPHA_SDL2
-        self._clear_color : pygame.Color = pygame.Color(0, 0, 0, 0)
+        self._clear_color: pygame.Color = pygame.Color(0, 0, 0, 0)
         self.zoom_factor = 1
         self.cached_surfaces: dict[float, pygame.Surface] = {}
-        self.surface: pygame.Surface = pygame.Surface((0,0))
+        self.surface: pygame.Surface = pygame.Surface((0, 0))
+        if convert_alpha : 
+            self.surface = self.surface.convert_alpha()
+        else:
+            self.surface = self.surface.convert()
         self.follow_point_func = None
         self.max_zoom = 2
         self.min_zoom = 0.1
         self.zoom(1)
 
-    def set_clear_color(self, color: pygame.Color|tuple):
-        if not isinstance(color,pygame.Color):
+    def set_clear_color(self, color: pygame.Color | tuple | str) -> "Camera":
+        """
+        Set the clear color for the camera surface.
+
+        Args:
+            color (pygame.Color | tuple): Color to set as the clear color.
+
+        Returns:
+            Camera: Returns the Camera object.
+        """
+        if not isinstance(color, pygame.Color):
             color = pygame.Color(color)
         self._clear_color = color
+        return self
+
+    def set_max_zoom(self, value: float) -> "Camera":
+        """
+        Set the maximum zoom value for the camera.
 
-    def set_max_zoom(self,value:float):
+        Args:
+            value (float): Maximum zoom value.
+
+        Returns:
+            Camera: Returns the Camera object.
+        """
         self.max_zoom = value
+        return self
+
+    def set_min_zoom(self, value: float) -> "Camera":
+        """
+        Set the minimum zoom value for the camera.
 
-    def set_min_zoom(self,value:float):
+        Args:
+            value (float): Minimum zoom value.
+
+        Returns:
+            Camera: Returns the Camera object.
+        """
         self.min_zoom = value
+        return self
 
-    def clear(self):
+    def clear(self) -> None:
         """
-        Clear the camera surface with the set clear color
-        (default is tranparent)
+        Clear the camera surface with the set clear color.
         """
         self.surface.fill(self._clear_color)
 
-    def get_center(self):
-        return self.rect.center
+    def get_center(self) -> tuple[float,float]:
+        """
+        Get the center of the camera's view.
 
-    
+        Returns:
+            Vector2: Returns the center coordinates.
+        """
+        return self.rect.center
 
-    def move(self, x, y):
+    def move(self, x, y) -> "Camera":
         """
-        Moves the camera rect by the given coordinates (+=)
+        Moves the camera rect by the given coordinates.
+
+        Args:
+            x: X-coordinate to move.
+            y: Y-coordinate to move.
+
+        Returns:
+            Camera: Returns the Camera object.
         """
         self.rect.topleft += Vector2(x, y)
+        return self
 
-    def set_position(self, x, y):
+    def set_position(self, x, y) -> "Camera":
         """
-        Set the camera rect topleft position
+        Set the camera rect top-left position.
+
+        Args:
+            x: X-coordinate to set.
+            y: Y-coordinate to set.
+
+        Returns:
+            Camera: Returns the Camera object.
         """
         self.rect.topleft = (x, y)
+        return self
 
-    def set_center(self, x, y):
+    def set_center(self, x, y) -> "Camera":
         """
-        Set the camera rect center position
+        Set the camera rect center position.
+
+        Args:
+            x: X-coordinate for the center.
+            y: Y-coordinate for the center.
+
+        Returns:
+            Camera: Returns the Camera object.
         """
         self.rect.center = (x, y)
+        return self
 
-    def set_follow_dynamic_point(self, func):
+    def set_follow_point(self, func) -> "Camera":
         """
-        Set the following function (returns tuple x y)
-        (camera will center its position to the center of the given coordinates)
+        Set the following function (returns tuple x y).
+        Camera will center its position to the center of the given coordinates.
+
+        Args:
+            func: Function returning coordinates to follow.
+
+        Returns:
+            Camera: Returns the Camera object.
         """
         self.follow_point_func = func
+        return self
+
+    def zoom_by(self, amount: float) -> "Camera":
+        """
+        Zooms the camera by the given amount.
 
-    def zoom_by(self, amount:float):
+        Args:
+            amount (float): Amount to zoom.
+
+        Returns:
+            Camera: Returns the Camera object.
+        """
         self.zoom(self.zoom_factor + amount)
+        return self
 
-    def zoom(self, factor):
-        if factor <self.min_zoom:
-            return
-        if factor > self.max_zoom:
-            return
-        factor = round(factor,2)
+    def zoom(self, factor) -> "Camera":
+        """
+        Zooms the camera to the given factor.
+
+        Args:
+            factor: Factor to set for zooming.
+
+        Returns:
+            Camera: Returns the Camera object.
+        """
+        if factor < self.min_zoom or factor > self.max_zoom:
+            return self
+
+        factor = round(factor, 2)
         self.zoom_factor = factor
+
         if factor not in self.cached_surfaces:
-            # if factor != 1 : print("creating new surface in cache : ",tuple(i * factor for i in const.RESOLUTION), self.flags)
             self.cached_surfaces[factor] = pygame.Surface(
                 tuple(i / factor for i in bf.const.RESOLUTION), flags=self.flags
             ).convert_alpha()
-            # c = self.surface.get_colorkey() if self.surface else None
-            # if c : self.cached_surfaces[factor].set_colorkey(c)
             self.cached_surfaces[factor].fill((0, 0, 0, 0))
 
         self.surface = self.cached_surfaces[self.zoom_factor]
-        self.rect = self.surface.get_frect(center=self.rect.center)
-        # if factor != 1 : print(self.cached_surfaces)
+        self.rect = self.surface.get_rect(center=self.rect.center)
+        return self
 
     def intersects(self, rect: pygame.Rect | pygame.FRect) -> bool:
+        """
+        Check if the camera view intersects with the given rectangle.
+
+        Args:
+            rect (pygame.Rect | pygame.FRect): Rectangle to check intersection with.
+
+        Returns:
+            bool: True if intersection occurs, False otherwise.
+        """
         return (
             self.rect.x < rect.right
             and self.rect.right > rect.x
@@ -97,27 +201,53 @@ class Camera:
             and self.rect.bottom > rect.y
         )
 
-
     def transpose(self, rect: pygame.Rect | pygame.FRect) -> pygame.Rect | pygame.FRect:
-        x, y = round(rect.x - self.rect.left), round(rect.y - self.rect.top)
-        return pygame.Rect(x, y, *rect.size)
+        """
+        Transpose the given rectangle coordinates relative to the camera.
+
+        Args:
+            rect (pygame.Rect | pygame.FRect): Rectangle to transpose.
+
+        Returns:
+            pygame.FRect: Transposed rectangle.
+        """
+        return pygame.FRect(rect.x - self.rect.left, rect.y - self.rect.top, *rect.size)
 
     def convert_screen_to_world(self, x, y):
+        """
+        Convert screen coordinates to world coordinates based on camera settings.
+
+        Args:
+            x: X-coordinate in screen space.
+            y: Y-coordinate in screen space.
+
+        Returns:
+            tuple: Converted world coordinates.
+        """
         return x / self.zoom_factor + self.rect.x, y / self.zoom_factor + self.rect.y
 
     def update(self, dt):
+        """
+        Update the camera position based on the follow point function.
+
+        Args:
+            dt: Time delta for updating the camera position.
+        """
         if self.follow_point_func:
             target = self.follow_point_func()
             self.rect.center = Vector2(self.rect.center).lerp(target, ((dt * 60) * 0.1))
 
     def draw(self, surface: pygame.Surface):
-        # pygame.draw.circle(surface,bf.color.ORANGE,self.surface.get_rect().center,4)
+        """
+        Draw the camera view onto the provided surface with proper scaling.
+
+        Args:
+            surface (pygame.Surface): Surface to draw the camera view onto.
+        """
         if self.zoom_factor == 1:
             surface.blit(self.surface, (0, 0), special_flags=self.blit_special_flags)
             return
-        # print("From",self.surface,"Target RESOLUTION",const.RESOLUTION,"Destination",surface)
-        surface.blit(
-            pygame.transform.scale(self.surface, bf.const.RESOLUTION),
-            (0, 0),
-            special_flags=self.blit_special_flags,
-        )
+
+        # Scale the surface to match the resolution
+        scaled_surface = pygame.transform.scale(self.surface, bf.const.RESOLUTION)
+        surface.blit(scaled_surface, (0, 0), special_flags=self.blit_special_flags)

batFramework/constants.py

@@ -3,60 +3,14 @@ from enum import Enum
 import sys, os
 
 
-if getattr(sys, 'frozen', False):
+if getattr(sys, "frozen", False):
     # If the application is run as a bundle, the PyInstaller bootloader
-    # extends the sys module by a flag frozen=True and sets the app 
+    # extends the sys module by a flag frozen=True and sets the app
     # path into variable _MEIPASS'.
     application_path = sys._MEIPASS
 else:
     application_path = os.getcwd()
 
-class Constants:
-    SCREEN = None
-    RESOLUTION: tuple[int, int] = (1280,720)
-    VSYNC = 0
-    FLAGS: int = pygame.SCALED | pygame.RESIZABLE
-    FPS: int = 60
-    RESOURCE_PATH = "."
-    
-    @staticmethod
-    def init_screen(resolution:tuple[int,int],flags:int= 0, vsync:int= 0):
-        Constants.RESOLUTION = resolution
-        Constants.FLAGS = flags
-        Constants.VSYNC = vsync
-        Constants.SCREEN = pygame.display.set_mode(Constants.RESOLUTION, Constants.FLAGS,vsync=Constants.VSYNC)
-        print(f"Window : {resolution[0]}x{resolution[1]}px | flags:{flags.bit_count()}, vsync:{pygame.display.is_vsync()}")
-    MUSIC_END_EVENT = pygame.event.custom_type()
-
-    # ------------GUI SPECIFIC
-    DEFAULT_TEXT_SIZE: int = 8
-
-    GUI_SCALE: int = 1
-    # ---------------------
-
-    @staticmethod
-    def set_resolution(resolution : tuple[int,int]):
-        Constants.RESOLUTION = resolution
-
-    @staticmethod
-    def set_resource_path(path: str):
-        print("set resource path :", path)
-        Constants.RESOURCE_PATH = os.path.join(application_path,path)
-
-    @staticmethod
-    def set_fps_limit(value: int):
-        Constants.FPS = value
-        print("FPS limit to : ", value)
-
-    @staticmethod
-    def set_gui_scale(value: int):
-        Constants.GUI_SCALE = value
-        print("GUI_SCALE to : ", value)
-
-    @staticmethod
-    def set_default_text_size(size:int):
-        Constants.DEFAULT_TEXT_SIZE = size
-
 class Colors:
     LIGHT_CYAN = (179, 229, 252)
     WASHED_BLUE = (52, 73, 94)
@@ -65,11 +19,15 @@ class Colors:
     LIGHT_BLUE = (3, 169, 244)
     DEEP_BLUE = (41, 121, 255)
     DARK_BLUE = (44, 62, 80)
+    
     GREEN = (67, 160, 71)
     DARK_GREEN = (39, 174, 96)
+    
     BROWN = (109, 76, 65)
     DARK_RED = (192, 57, 43)
+    
     ORANGE = (251, 140, 0)
+    
     CLOUD_WHITE = (236, 240, 241)
     SILVER = (189, 195, 199)
     DARK_GRAY = (66, 66, 66)
@@ -79,6 +37,23 @@ class Colors:
     BASE_GB = (73, 107, 34)
     LIGHT_GB = (154, 158, 63)
 
-class Axis(Enum):
-    HORIZONTAL  = 1
-    VERTICAL    = 2
+
+
+class Constants:
+    SCREEN = None
+    RESOLUTION: tuple[int, int] = (1280, 720)
+    VSYNC = 0
+    FLAGS: int = pygame.SCALED | pygame.RESIZABLE
+    FPS: int = 60
+    MUSIC_END_EVENT = pygame.event.custom_type()
+
+    BF_INITIALIZED : bool = False
+    @staticmethod
+    def set_resolution(resolution: tuple[int, int]):
+        Constants.RESOLUTION = resolution
+
+    @staticmethod
+    def set_fps_limit(value: int):
+        Constants.FPS = value
+        print("FPS limit to : ", value)
+

batFramework/cutscene.py

@@ -12,7 +12,7 @@ class Cutscene:
 class CutsceneManager(metaclass=bf.Singleton):
     def __init__(self, manager) -> None:
         self.current_cutscene: Cutscene = None
-        self.cutscenes : list[bf.Cutscene] = [] 
+        self.cutscenes: list[bf.Cutscene] = []
         self.manager: bf.Manager = manager
 
     def get_flag(self, flag):
@@ -22,11 +22,11 @@ class CutsceneManager(metaclass=bf.Singleton):
         if self.current_cutscene:
             self.current_cutscene.process_event(event)
 
-    def queue(self,*cutscenes):
+    def queue(self, *cutscenes):
         self.cutscenes.extend(cutscenes)
         if self.current_cutscene is None:
             self.play(self.cutscenes.pop(0))
-            
+
     def play(self, cutscene: Cutscene):
         if self.current_cutscene is None:
             self.current_cutscene = cutscene
@@ -41,19 +41,21 @@ class CutsceneManager(metaclass=bf.Singleton):
             # print("cutscene manager update")
             if self.current_cutscene.has_ended():
                 self.current_cutscene.on_exit()
-                self.current_cutscene =None
+                self.current_cutscene = None
                 if self.cutscenes:
                     self.play(self.cutscenes.pop(0))
                 else:
                     self.current_cutscene = None
                     self.manager.set_sharedVar("in_cutscene", False)
 
+
 class Cutscene:
-    def __init__(self,*blocks) -> None:
+    def __init__(self, *blocks) -> None:
         self.cutscene_blocks: list[CutsceneBlock] = list(blocks)
         self.block_index = 0
-        self.end_blocks : list[CutsceneBlock] = []
+        self.end_blocks: list[CutsceneBlock] = []
         self.ended = False
+
     def on_enter(self):
         pass
 
@@ -63,22 +65,22 @@ class Cutscene:
     def init_blocks(self):
         pass
 
-    def add_end_block(self,block):
+    def add_end_block(self, block):
         block.set_parent_cutscene(self)
         self.end_blocks.append(block)
 
-    def get_scene_at(self,index):
+    def get_scene_at(self, index):
         return bf.CutsceneManager().manager._scenes[index]
 
     def get_current_scene(self):
         return bf.CutsceneManager().manager.get_current_scene()
-    
-    def set_scene(self,name,index=0):
-        return bf.CutsceneManager().manager.set_scene(name,index)
 
-    def get_scene(self,name):
+    def set_scene(self, name, index=0):
+        return bf.CutsceneManager().manager.set_scene(name, index)
+
+    def get_scene(self, name):
         return bf.CutsceneManager().manager.get_scene(name)
-    
+
     def add_block(self, *blocks: list[CutsceneBlock]):
         for block in blocks:
             block.set_parent_cutscene(self)
@@ -115,5 +117,3 @@ class Cutscene:
 
     def has_ended(self):
         return self.ended
-
-

batFramework/cutsceneBlocks.py

@@ -1,5 +1,5 @@
 import batFramework as bf
-from .cutscene import Cutscene,CutsceneManager
+from .cutscene import Cutscene, CutsceneManager
 
 
 # Define the base CutsceneBlock class
@@ -17,18 +17,18 @@ class CutsceneBlock:
         self.ended = False
         self.started = False
 
-    def get_scene_at(self,index):
+    def get_scene_at(self, index):
         return bf.CutsceneManager().manager._scenes[index]
 
-    def set_scene(self,name,index=0):
-        return CutsceneManager().manager.set_scene(name,index)
-    
+    def set_scene(self, name, index=0):
+        return CutsceneManager().manager.set_scene(name, index)
+
     def get_current_scene(self):
         return CutsceneManager().manager.get_current_scene()
-    
-    def get_scene(self,name):
+
+    def get_scene(self, name):
         return CutsceneManager().manager.get_scene(name)
-    
+
     # Set the parent cutscene for this block
     def set_parent_cutscene(self, parent):
         """
@@ -152,7 +152,9 @@ class SceneTransitionBlock(CutsceneBlock):
         self.duration = duration
         self.kwargs = kwargs
         # Timer to handle the end of the transition
-        self.timer = bf.Timer(name = "scene_transition_block",duration=duration, end_callback=self.end)
+        self.timer = bf.Timer(
+            name="scene_transition_block", duration=duration, end_callback=self.end
+        )
 
     # Start the scene transition block
     def start(self):

batFramework/dynamicEntity.py

@@ -2,15 +2,16 @@ import pygame
 import batFramework as bf
 from typing import Self
 
+
 class DynamicEntity(bf.Entity):
     def __init__(
         self,
-        size : None|tuple[int,int]=None,
-        no_surface : bool   =False,
-        surface_flags : int =0,
-        convert_alpha : bool=False
+        size: None | tuple[int, int] = None,
+        no_surface: bool = False,
+        surface_flags: int = 0,
+        convert_alpha: bool = False,
     ) -> None:
-        super().__init__(size,no_surface,surface_flags,convert_alpha)
+        super().__init__(size, no_surface, surface_flags, convert_alpha)
         self.velocity = pygame.math.Vector2(0, 0)
 
     def on_collideX(self, collider: Self):
@@ -19,5 +20,5 @@ class DynamicEntity(bf.Entity):
     def on_collideY(self, collider: Self):
         return False
 
-    def move_by_velocity(self)->None:
+    def move_by_velocity(self) -> None:
         self.set_position(self.rect.x + self.velocity.x, self.rect.y + self.velocity.y)

batFramework/easing.py

@@ -2,47 +2,51 @@ from enum import Enum
 import pygame
 import batFramework as bf
 
+
 class Easing(Enum):
-    EASE_IN     = (0.12, 0, 0.39, 0)
-    EASE_OUT    = (0.61, 1, 0.88, 1)
+    EASE_IN = (0.12, 0, 0.39, 0)
+    EASE_OUT = (0.61, 1, 0.88, 1)
     EASE_IN_OUT = (0.37, 0, 0.63, 1)
-    EASE_IN_OUT_ELASTIC = (.7,-0.5,.3,1.5)
-    LINEAR      = (1, 1, 0, 0)
+    EASE_IN_OUT_ELASTIC = (0.7, -0.5, 0.3, 1.5)
+    LINEAR = (1, 1, 0, 0)
     # Add more easing functions as needed
 
     def __init__(self, *control_points):
         self.control_points = control_points
 
+
 class EasingAnimation(bf.Timer):
     _cache = {}
+
     def __init__(
         self,
-        name:str=None,
-        easing_function:Easing=Easing.LINEAR,
-        duration:int=100,
+        name: str = '',
+        easing_function: Easing = Easing.LINEAR,
+        duration: int = 100,
         update_callback=None,
         end_callback=None,
-        loop:bool=False,
-        reusable:bool=False
-    ):
+        loop: bool = False,
+        reusable: bool = False,
+    )->None:
         self.easing_function = easing_function
         self.update_callback = update_callback
         self.value = 0.0
-        super().__init__(name,duration,loop,end_callback,reusable)
-        
+        super().__init__(name, duration, loop, end_callback, reusable)
+
     def get_value(self):
         return self.value
 
     def start(self):
-        self.value =  0
-        super().start() # self.elapsed_progress set to 0 here    
-        
-    def update(self)->bool:
-        if super().update():
-            return True# If timer ended now, end() is called. So don't process value.  
+        self.value = 0
+        super().start()  # self.elapsed_progress set to 0 here
+
+    def update(self,dt) -> bool:
+        if super().update(dt):
+            return True  # If timer ended now, end() is called. So don't process value.
         self._process_value()
         # if self.name == 0: print("UPDATING (callback) in easing")
-        if self.update_callback: self.update_callback(self.value)
+        if self.update_callback:
+            self.update_callback(self.value)
         return False
 
     def end(self):
@@ -50,13 +54,14 @@ class EasingAnimation(bf.Timer):
 
         self.elapsed_progress = 1
         self._process_value()
-        if self.update_callback: self.update_callback(self.value)
-        self.value =  0
-        super().end() # sets elapsed_progress to 0
+        if self.update_callback:
+            self.update_callback(self.value)
+        self.value = 0
+        super().end()  # sets elapsed_progress to 0
 
     def _process_value(self):
         p0, p1, p2, p3 = self.easing_function.control_points
-        cache_key = (self.elapsed_progress, p0, p1, p2, p3)
+        cache_key = (self.easing_function,self.elapsed_progress, p0, p1, p2, p3)
         if cache_key in EasingAnimation._cache:
             y = EasingAnimation._cache[cache_key]
         else: