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         # App is visible? (vs minimized or in background)
  40         fun visible: Bool is abstract
  41
  42         # Invoqued at each frame
  43         # Usually you want to redef frame_core instead of this
  44         fun full_frame
  45         do
  46                 var display = self.display
  47                 if display != null then
  48                         display.begin
  49                         frame_core( display )
  50                         display.finish
  51                 end
  52         end
  53
  54         # Main frame method to redef
  55         # Is called between readying display and flipping it
  56         fun frame_core( display: D ) is abstract
  57
  58         # Receive and deal with all inputs
  59         fun input( event: InputEvent ): Bool
  60         do
  61                 return false
  62         end
  63
  64         # Internal method to generate inputs
  65         protected fun generate_input is abstract
  66
  67         # Main app loop
  68         # Usually you want to redef frame_core instead of this
  69         redef fun run
  70         do
  71                 while not quit do
  72                         generate_input
  73                         full_frame
  74                 end
  75         end
  76 end