lib/mnit/mnit_app.nit

   1 # This file is part of NIT ( http://www.nitlanguage.org ).
   2 #
   3 # Copyright 2011-2013 Alexis Laferrière <alexis.laf@xymus.net>
   4 #
   5 # Licensed under the Apache License, Version 2.0 (the "License");
   6 # you may not use this file except in compliance with the License.
   7 # You may obtain a copy of the License at
   8 #
   9 #     http://www.apache.org/licenses/LICENSE-2.0
  10 #
  11 # Unless required by applicable law or agreed to in writing, software
  12 # distributed under the License is distributed on an "AS IS" BASIS,
  13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 # See the License for the specific language governing permissions and
  15 # limitations under the License.
  16
  17 # General Mnit application structure
  18 module mnit_app
  19
  20 import ::app
  21 import mnit_display
  22
  23 # An App instance serves as base to every Mnit projects.
  24 #
  25 # This class is redefed by plateforme modules and so
  26 # App can be specialized directly in the user app.
  27 redef class App
  28         type IE: InputEvent
  29         type D: Display
  30         type I: Image
  31
  32         # Display to use by apps
  33         # Is null if the display is not available or not yet ready
  34         var display: nullable D protected writable = null
  35
  36         # Received quit order
  37         var quit: Bool writable = false
  38
  39         init do end
  40
  41         # App is visible? (vs minimized or in background)
  42         fun visible: Bool is abstract
  43
  44         # Invoqued at each frame
  45         # Usually you want to redef frame_core instead of this
  46         fun full_frame
  47         do
  48                 var display = self.display
  49                 if display != null then
  50                         display.begin
  51                         frame_core( display )
  52                         display.finish
  53                 end
  54         end
  55
  56         # Main frame method to redef
  57         # Is called between readying display and flipping it
  58         fun frame_core( display: D ) is abstract
  59
  60         #fun start do end
  61         #fun stop do end
  62         #fun destroy do end
  63
  64         # Called when asked by the system (mainly for Android)
  65         fun save do end
  66
  67         # Called when asked by the system (mainly for Android)
  68         fun pause do end
  69
  70         # Called when asked by the system (mainly for Android)
  71         fun resume do end
  72
  73         # System notification
  74         fun gained_focus do end
  75
  76         # System notification
  77         fun lost_focus do end
  78
  79         # Main init method for graphical stuff
  80         # Is called when display is ready so graphical assets
  81         # can be loaded at this time.
  82         fun init_window do end
  83
  84         # Called before destroying the window
  85         fun term_window do end
  86
  87         # Receive and deal with all inputs
  88         fun input( event: InputEvent ): Bool
  89         do
  90                 return false
  91         end
  92
  93         # Internal method to generate inputs
  94         protected fun generate_input is abstract
  95
  96         # Main app loop
  97         # Usually you want to redef framw_core instead of this
  98         fun main_loop
  99         do
 100                 while not quit do
 101                         generate_input
 102                         full_frame
 103                 end
 104         end
 105 end