basilisk-engine 0.1.22__py3-none-any.whl → 0.1.24__py3-none-any.whl

basilisk/__init__.py

@@ -8,7 +8,7 @@ from .render.material import Material
 from .render.shader import Shader
 from .render.shader_handler import ShaderHandler
 from .draw import draw
-from .render.camera import FreeCamera, StaticCamera, FollowCamera, OrbitCamera
+from .render.camera import FreeCamera, StaticCamera, FollowCamera, OrbitCamera, FixedCamera
 from .render.sky import Sky
 from .render.post_process import PostProcess
 from .particles.particle_handler import ParticleHandler

basilisk/config.py

@@ -1,3 +1,4 @@
 class Config():
     def __init__(self) -> None:
-        ...
+        self.chunk_size = 40
+        self.render_distance = 5

basilisk/draw/draw.py

@@ -14,7 +14,7 @@ def rect(engine: Engine, color: tuple, rect: tuple) -> None:
     """
     
     # Get the draw handler from the engine
-    draw_handler = engine.scene.draw_handler
+    draw_handler = engine.draw_handler
     if not draw_handler: return
 
     # Draw the rect
@@ -36,7 +36,7 @@ def circle(engine: Engine, color: tuple, center: tuple, radius: int, resolution:
     """
     
     # Get the draw handler from the engine
-    draw_handler = engine.scene.draw_handler
+    draw_handler = engine.draw_handler
     if not draw_handler: return
 
     # Draw the circle
@@ -57,7 +57,7 @@ def line(engine: Engine, color: tuple, p1: tuple, p2: tuple, thickness: int=1) -
     """
     
     # Get the draw handler from the engine
-    draw_handler = engine.scene.draw_handler
+    draw_handler = engine.draw_handler
     if not draw_handler: return
 
     # Draw the line
@@ -74,10 +74,10 @@ def blit(engine: Engine, image: Image, rect: tuple, alpha: float=1.0):
     """
 
     # Get the draw handler from the engine
-    draw_handler = engine.scene.draw_handler
+    draw_handler = engine.draw_handler
     if not draw_handler: return
 
-    engine.scene.material_handler.image_handler.add(image)
+    engine.material_handler.image_handler.add(image)
 
     # Blit the image
     draw_handler.blit(image, rect, alpha)
@@ -88,7 +88,7 @@ def text(engine: Engine, text: str, position: tuple, scale: float=1.0):
     USE SPARINGLY, INEFFICIENT IMPLAMENTATION
     """
     
-    font_renderer = engine.scene.draw_handler.font_renderer
+    font_renderer = engine.draw_handler.font_renderer
 
     # Render the text if it has not been cached
     if text not in font_renderer.text_renders:

basilisk/draw/draw_handler.py

@@ -9,9 +9,6 @@ from ..generic.input_validation import validate_color, validate_rect, validate_p
 
 class DrawHandler():
     engine: ...
-    """Back reference to the parent engine"""
-    scene: ...
-    """Back reference to the parent scene"""
     ctx: mgl.Context
     """Back reference to the parent context"""
     program: mgl.Program
@@ -23,15 +20,14 @@ class DrawHandler():
     vao: mgl.VertexArray=None
     """VAO for rendering all 2D draw calls"""
     
-    def __init__(self, scene) -> None:
+    def __init__(self, engine) -> None:
         # Back references
-        self.scene  = scene
-        self.engine = scene.engine
-        self.ctx    = scene.engine.ctx
+        self.engine = engine
+        self.ctx    = engine.ctx
 
         # Get the shader
         root = self.engine.root
-        self.shader = self.scene.shader_handler.add(Shader(self.engine, root + '/shaders/draw.vert', root + '/shaders/draw.frag'))
+        self.shader = self.engine.shader_handler.add(Shader(self.engine, root + '/shaders/draw.vert', root + '/shaders/draw.frag'))
 
         # Initialize draw data as blank
         self.draw_data = []

basilisk/engine.py

@@ -1,46 +1,50 @@
 import os
 from sys import platform
-import sys
-import glcontext
-from .input.path import get_root
 os.environ['PYGAME_HIDE_SUPPORT_PROMPT'] = "hide"
 import pygame as pg
 import moderngl as mgl
+import glcontext  # For packaging (so it isnt a hidden import)
+from .render.shader_handler import ShaderHandler
+from .render.material_handler import MaterialHandler
+from .render.frame import Frame
+from .draw.draw_handler import DrawHandler
 from .config import Config
-from .input.mouse import Mouse
+from .input_output.mouse import Mouse
+from .input_output.clock import Clock
+from .input_output.IO_handler import IO
 from .mesh.cube import Cube
-from .render.shader import Shader
-import glcontext
 
 class Engine():
     win_size: tuple
     """Size of the engine window in pixels"""
     ctx: mgl.Context
     """ModernGL context used by the engine"""
-    scene: any
-    """Scene currently being updated and rendered by the engine"""
-    clock: pg.Clock
-    """Pygame clock used to keep track of time between frames"""
+    clock: Clock
+    """Basilisk clock used to keep track of time"""
+    shader_handler: ShaderHandler=None
+    """Handler for all shaders used in all scenes of the engine"""
+    material_handler: MaterialHandler=None
+    """Handler for all materials and images in all scenes"""
+    frame: Frame=None
+    """Default render target for all locations. Rendered to the screen at the end of the frame"""
     config: Config
     """Object containing all global attributes"""
     delta_time: float
     """Time in seconds that passed between the last frame"""
     time: float
     """Total time the engine has been running"""
-    running: bool
+    running: bool=True
     """True if the engine is still running"""
-    events: list
-    """List of all pygame"""
-    keys: list
-    """bool list containing the state of all keys this frame"""
-    previous_keys: list
-    """bool list containing the state of all keys at the previous frame"""
     mouse: Mouse
     """Object containing information about the user's mouse"""
     root: str
     """Path to the root directory containing internal data"""
-    event_resize: bool
-    """Bool for if a resize event has occured this frame"""
+    current_frame_updated: bool=False
+    """Flag for if the engine has been updated this frame"""
+    keys: list[bool]
+    """List of all keyboard inputs as booleans"""
+    previous_keys: list[bool]
+    """List of all keyoard inputs from the last frame as booleans"""
 
     def __init__(self, win_size=(800, 800), title="Basilisk Engine", vsync=None, max_fps=None, grab_mouse=True, headless=False, resizable=True) -> None:
         """
@@ -56,34 +60,31 @@ class Engine():
                 Flag for headless rendering
         """
 
-        if platform == 'win32' : self.platform = 'windows'
-        elif  platform == 'darwin': self.platform = 'mac' 
-        else: self.platform = 'linux'
-
         # Save the window size
         self.win_size = win_size
-        self.event_resize = None
 
+        # Initialize pygame and set OpenGL attributes
         pg.init()  
-        # Initialize pygame and OpenGL attributes
         pg.display.gl_set_attribute(pg.GL_CONTEXT_MAJOR_VERSION, 3)
         pg.display.gl_set_attribute(pg.GL_CONTEXT_MINOR_VERSION, 3)
         pg.display.gl_set_attribute(pg.GL_CONTEXT_PROFILE_MASK, pg.GL_CONTEXT_PROFILE_CORE)
-        # Check vsync against platform defaults
-        if vsync == None: vsync = True if platform == 'linux' else False
-        self.max_fps = max_fps
-        # Pygame display init
+
+        # Platform settings
+        if platform == 'win32' : self.platform = 'windows'
+        elif  platform == 'darwin': self.platform = 'mac' 
+        else: self.platform = 'linux'
+        if vsync == None: vsync = True if self.platform == 'linux' else False
+
+        # Initializae the pygame display
+        self.headless = headless
         if headless:
             pg.display.set_mode((300, 50), vsync=vsync, flags=pg.OPENGL | pg.DOUBLEBUF)
             pg.display.iconify()
         else:
             if resizable: pg.display.set_mode(self.win_size, vsync=vsync, flags=pg.OPENGL | pg.DOUBLEBUF | pg.RESIZABLE)
             else: pg.display.set_mode(self.win_size, vsync=vsync, flags=pg.OPENGL | pg.DOUBLEBUF)
-        
-        self.caption = title
-        if title: pg.display.set_caption(title)
-        
-        # Init sound
+                
+        # Initalize pygame sound moduel sound
         pg.mixer.pre_init(44100, -16, 2, 512)
         pg.mixer.init()
         pg.mixer.set_num_channels(64)
@@ -94,102 +95,62 @@ class Engine():
         self.ctx.enable(flags=mgl.DEPTH_TEST | mgl.CULL_FACE | mgl.BLEND)
 
         # Global attributes referenced by the handlers
-        self.headless = headless
-        self.set_configurations()
+        self.config = Config()
         self.root = os.path.dirname(__file__)
         self.cube = Cube(self)
         self.fbos = []
-
-        # Update the icon
-        pg.display.set_icon(pg.image.load(self.root + '/bsk_assets/basilisk.png'))
         
-        # Time variables
-        self.clock = pg.time.Clock()
-        self.delta_time = 0
-        self.time = 0
+        # Handlers
+        self.clock            = Clock(self, max_fps)
+        self.IO               = IO(self, grab_mouse=grab_mouse, caption=title)
+        self.material_handler = MaterialHandler(self)
+        self.shader_handler   = ShaderHandler(self)
+        self.draw_handler     = DrawHandler(self)
+        self.frame            = Frame(self)
+        self.material_handler.set_base()
+
+    def _update(self) -> None:
+        """
+        Internal engine update.
+        Updates all input, physics, and time variables. Clears the frame.
+        """
 
-        # Initialize input lists
-        self.keys = pg.key.get_pressed()
-        self.previous_keys = self.keys
-        self.mouse = Mouse(grab=grab_mouse)
+        if self.current_frame_updated: return
 
-        # Scene being used by the engine
-        self.scene = None
+        for fbo in self.fbos: fbo.clear()
+        self.clock.update()
+        self.IO.update()
 
-        # Load a default shader
-        self.shader = Shader(self, self.root + '/shaders/batch.vert', self.root + '/shaders/batch.frag')
-        self.shader.hash = self.shader.hash + hash('engine_shader')
+        self.current_frame_updated = True
 
-        # Set the scene to running
-        self.running = True
 
-    def update(self, render=True) -> None:
+    def update(self) -> None:
         """
-        Updates all input, physics, and time variables. Renders the current scene.
+        Calls internal update if needed
+        Renders the draw handler
+        Renders the engine's frame to the screen.
         """
 
-        # Tick the clock and get delta time
-        if self.max_fps: self.delta_time = self.clock.tick(self.max_fps) / 1000
-        else: self.delta_time = self.clock.tick() / 1000
-        self.time += self.delta_time
-        if not self.caption: pg.display.set_caption(f"FPS: {round(self.clock.get_fps())}")
-        self.event_resize = False
 
-        # Update the previous input lists for the next frame
-        self.previous_keys = self.keys
-        
-        # Get inputs and events
-        self.events = pg.event.get()
-        self.keys = pg.key.get_pressed()
-        self.mouse.update(self.events)
-        
-        # Loop through all pygame events
-        for event in self.events:
-            if event.type == pg.QUIT: # Quit the engine
-                self.quit()
-                return
-            if event.type == pg.VIDEORESIZE:
-                # Updates the viewport
-                self.event_resize = True
-                self.win_size = (event.w, event.h)
-                self.ctx.viewport = (0, 0, event.w, event.h)
-                self.scene.camera.use()
-                self.scene.frame.resize()
-                for fbo in self.fbos: fbo.resize()
-
-
-        # Update the scene if possible
-        if self.scene: self.scene.update()
-        # Render after the scene and engine has been updated
-        if render: self.render()
-
-
-    def render(self) -> None:
-        """
-        Renders the scene currently being used by the engine
-        """
-        
-        # Set the ctx for rendering
-        self.ctx.screen.use()
-        self.ctx.clear()
+        # Must update the frame
+        if not self.current_frame_updated: self._update()
+        if not self.running: return
 
-        # Render the scene
-        if self.scene:self.scene.render()
+        # Render all draw calls from the past frame
+        self.frame.use()
+        self.draw_handler.render()
 
-        # Flip pygame display buffer
+        # Clear the screen and render the frame
+        self.ctx.screen.use()
+        self.ctx.clear()
+        self.frame.render()
         pg.display.flip()
 
-    def set_configurations(self):
-        """
-        Sets global configurations. These attributs are not used by the engine, just the handlers
-        """
+        self.frame.clear()
 
-        # Create a config object
-        self.config = Config()
 
-        # Set the attributes on the config object
-        setattr(self.config, "chunk_size", 40)
-        setattr(self.config, "render_distance", 5)
+        # Allow for the engine to take in input again
+        self.current_frame_updated = False
 
     def quit(self) -> None:
         """
@@ -200,18 +161,10 @@ class Engine():
         self.ctx.release()
         self.running = False
 
-    @property
-    def scene(self): return self._scene
+
     @property
     def shader(self): return self._shader
-
-    @scene.setter
-    def scene(self, value):
-        self._scene = value
-        if self._scene: 
-            self._scene.set_engine(self)
-
     @shader.setter
     def shader(self, value):
         self._shader = value
-        if self.scene: value.set_main()
+        value.set_main()

basilisk/input_output/IO_handler.py

@@ -0,0 +1,92 @@
+import pygame as pg
+from .keys import Keys
+from .mouse import Mouse
+
+
+class IO:
+    keys: Keys=None
+    """Handler for all keyboard inputs""" 
+    mouse: Mouse=None
+    """Handler for all mouse inputs and mouse settings"""
+    events: list=[]
+    """List of all the events in the frame"""
+    event_resize: bool=False
+    """Bool for if a resize event has occured this frame"""
+
+    def __init__(self, engine: ..., grab_mouse: bool=True, caption: bool|None="Basilisk") -> None:
+        """
+        Class to handle all inputs and outputs for the engine. 
+        """
+        
+        # Reference to parent engine
+        self.engine = engine
+
+        # Caption attrib
+        self.caption = caption
+        self.update_caption()
+
+        # Handlers for key and mouse input
+        self.keys = Keys(engine)
+        self.mouse = Mouse(grab=grab_mouse)
+
+        # Expose the mouse on the engine level
+        setattr(self.engine, "mouse", self.mouse)
+
+        # Fill in default values for engine attributes
+        self.set_engine_attribiutes()
+
+        # Update the icon for the window
+        pg.display.set_icon(pg.image.load(self.engine.root + '/bsk_assets/basilisk.png'))
+
+    def update(self) -> None:
+        """
+        Update all inputs and check for events
+        """
+
+        # Get events
+        self.events = pg.event.get()
+
+        # Update the keys and the mouse
+        self.keys.update()
+        self.mouse.update(self.events)
+
+        # Handle events and update attributes
+        self.get_events()
+        self.set_engine_attribiutes()
+        self.update_caption()
+
+    def get_events(self) -> None:
+        """
+        Loop through all pygame events and make updates as needed
+        """
+        
+        # Clear global events
+        self.event_resize = False
+
+
+        for event in self.events:
+            if event.type == pg.QUIT: # Quit the engine
+                self.engine.quit()
+                return
+            if event.type == pg.VIDEORESIZE:
+                # Updates the viewport
+                self.event_resize = True
+                self.engine.win_size = (event.w, event.h)
+                self.engine.ctx.viewport = (0, 0, event.w, event.h)
+                for fbo in self.engine.fbos: fbo.resize()
+
+    def update_caption(self) -> None:
+        """
+        Updates the window caption with either the fps or the window name. Set to 'Basilisk Engine' by default
+        """
+        
+        caption = self.caption if self.caption else f"FPS: {round(self.engine.clock.fps)}"
+        pg.display.set_caption(caption)
+
+    def set_engine_attribiutes(self) -> None:
+        """
+        Updates engine attributes with this instance's attributes for ease of use
+        """
+
+        setattr(self.engine, "events", self.events)
+        setattr(self.engine, "event_resize", self.event_resize)

basilisk/input_output/clock.py

@@ -0,0 +1,50 @@
+import pygame as pg
+
+
+class Clock:
+    delta_time: float=0
+    """The amount of time that passed between the last and current frame"""
+    time: float=0
+    """Total time that has passed since the start of the program"""
+
+    def __init__(self, engine, max_fps=None) -> None:
+        """
+        Class to keep track of all time and delta time in the program
+        """
+
+        # Reference to the parent engine
+        self.engine = engine
+
+        # Create a pygame clock
+        self.clock = pg.Clock()
+        self.max_fps = max_fps
+
+        # Default values for attributes
+        self.set_engine_attribiutes()
+
+    def update(self) -> None:
+        """Ticks the clock"""
+        
+        # Tick the clock and get delta time in seconds
+        if self.max_fps: self.delta_time = self.clock.tick(self.max_fps) / 1000
+        else: self.delta_time = self.clock.tick() / 1000
+
+        # Increment the total time by time since last frame
+        self.time += self.delta_time
+
+        self.set_engine_attribiutes()
+
+    def set_engine_attribiutes(self) -> None:
+        """
+        Updates engine attributes with this instance's attributes for ease of use
+        """
+        
+        setattr(self.engine, "delta_time", self.delta_time)
+        setattr(self.engine, "dt", self.delta_time)
+        setattr(self.engine, "time", self.time)
+        setattr(self.engine, "fps", self.fps)
+
+
+    @property
+    def fps(self) -> float:
+        return self.clock.get_fps()

basilisk/input_output/keys.py

@@ -0,0 +1,44 @@
+import pygame as pg
+
+
+class Keys:
+    current_keys: list[bool]
+    """The keys pressed during the current frame""" 
+    previous_keys: list[bool]
+    """The keys pressed in the last frame"""
+
+    def __init__(self, engine: ...) -> None:
+        """
+        Handler for all keyboard inputs. Stores data from current and previous frames
+        """
+        
+        # Reference to the parent engine
+        self.engine = engine
+
+        # Fill in default values for current and previous keys to aviod startup errors
+        self.current_keys = pg.key.get_pressed()
+        self.previous_keys = self.current_keys
+        self.set_engine_attribiutes()
+
+
+    def update(self) -> None:
+        """
+        Gets all keyboard inputs and propogates last frame inputs
+        """
+
+        # Get keyboard input
+        self.previous_keys = self.current_keys
+        # Propogate input to the last frame
+        self.current_keys = pg.key.get_pressed()
+
+        # Expose the attributes on the engine level
+        self.set_engine_attribiutes()
+
+    def set_engine_attribiutes(self) -> None:
+        """
+        Updates engine attributes with this instance's attributes for ease of use
+        """
+
+        setattr(self.engine, "keys", self.current_keys)
+        setattr(self.engine, "previous_keys", self.previous_keys)
+        setattr(self.engine, "prev_keys", self.previous_keys)

basilisk/input_output/mouse.py

@@ -0,0 +1,90 @@
+import pygame as pg
+
+
+class Mouse():
+    def __init__(self, grab=True):
+        self._position = list(pg.mouse.get_pos())
+        self._relative = [0, 0]
+        self.buttons = pg.mouse.get_pressed()
+        self.previous_buttons = pg.mouse.get_pressed()
+        self.grab = grab
+        self.visible = not self.grab
+
+    def update(self, events):
+        """
+        Updates all mouse state variables.
+        Checks for mouse-related events.
+        """
+        
+        self._position = list(pg.mouse.get_pos())
+        self._relative = list(pg.mouse.get_rel())
+        self.previous_buttons = self.buttons
+        self.buttons = pg.mouse.get_pressed()
+
+        for event in events:
+            if event.type == pg.KEYUP:
+                if event.key == pg.K_ESCAPE and self.grab:
+                    # Unlock mouse
+                    self.grab = False
+                    self.visible = True
+            if event.type == pg.MOUSEBUTTONUP and not self.grab:
+                # Lock mouse
+                self.grab = True
+                self.visible = False
+
+    @property
+    def position(self): return self._position
+    @property
+    def x(self): return self._position[0]
+    @property
+    def y(self): return self._position[1]
+    @property
+    def relative(self): return self._relative
+    @property
+    def relative_x(self): return self._relative[0]
+    @property
+    def relative_y(self): return self._relative[1]
+    @property
+    def click(self): return self.buttons[0] and not self.previous_buttons[0]
+    @property
+    def left_click(self): return self.buttons[0] and not self.previous_buttons[0]
+    @property
+    def middle_click(self): return self.buttons[1] and not self.previous_buttons[1]
+    @property
+    def right_click(self): return self.buttons[2] and not self.previous_buttons[2]
+    @property
+    def left_down(self): return self.buttons[0]
+    @property
+    def middle_down(self): return self.buttons[1]
+    @property
+    def right_down(self): return self.buttons[2]
+    @property
+    def grab(self): return self._grab
+    @property
+    def visible(self): return self._visable
+
+    @position.setter
+    def position(self, value: tuple[int]) -> tuple[int]:
+        self._position = value
+        pg.mouse.set_pos(self._position)
+        return self._position
+    @x.setter
+    def x(self, value: int) -> int:
+        self._position[0] = value
+        pg.mouse.set_pos(self._position)
+        return self._position
+    @y.setter
+    def y(self, value: int) -> int:
+        self._position[1] = value
+        pg.mouse.set_pos(self._position)
+        return self._position
+    @grab.setter
+    def grab(self, value) -> bool:
+        self._grab = value
+        pg.event.set_grab(self._grab)
+        return self._grab
+    @visible.setter
+    def visible(self, value) -> bool:
+        self._visible = value
+        pg.mouse.set_visible(self._visible)
+        return self._visible