neo/framework/Console.h

   1 /*
   2 ===========================================================================
   3
   4 Doom 3 GPL Source Code
   5 Copyright (C) 1999-2011 id Software LLC, a ZeniMax Media company.
   6
   7 This file is part of the Doom 3 GPL Source Code (?Doom 3 Source Code?).
   8
   9 Doom 3 Source Code is free software: you can redistribute it and/or modify
  10 it under the terms of the GNU General Public License as published by
  11 the Free Software Foundation, either version 3 of the License, or
  12 (at your option) any later version.
  13
  14 Doom 3 Source Code is distributed in the hope that it will be useful,
  15 but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 GNU General Public License for more details.
  18
  19 You should have received a copy of the GNU General Public License
  20 along with Doom 3 Source Code.  If not, see <http://www.gnu.org/licenses/>.
  21
  22 In addition, the Doom 3 Source Code is also subject to certain additional terms. You should have received a copy of these additional terms immediately following the terms and conditions of the GNU General Public License which accompanied the Doom 3 Source Code.  If not, please request a copy in writing from id Software at the address below.
  23
  24 If you have questions concerning this license or the applicable additional terms, you may contact in writing id Software LLC, c/o ZeniMax Media Inc., Suite 120, Rockville, Maryland 20850 USA.
  25
  26 ===========================================================================
  27 */
  28
  29 #ifndef __CONSOLE_H__
  30 #define __CONSOLE_H__
  31
  32 /*
  33 ===============================================================================
  34
  35         The console is strictly for development and advanced users. It should
  36         never be used to convey actual game information to the user, which should
  37         always be done through a GUI.
  38
  39         The force options are for the editor console display window, which
  40         doesn't respond to pull up / pull down
  41
  42 ===============================================================================
  43 */
  44
  45 class idConsole {
  46 public:
  47         virtual                 ~idConsole( void ) {}
  48
  49         virtual void    Init( void ) = 0;
  50         virtual void    Shutdown( void ) = 0;
  51
  52         // can't be combined with Init, because Init happens before renderer is started
  53         virtual void    LoadGraphics() = 0;
  54
  55         virtual bool    ProcessEvent( const struct sysEvent_s *event, bool forceAccept ) = 0;
  56
  57         // the system code can release the mouse pointer when the console is active
  58         virtual bool    Active( void ) = 0;
  59
  60         // clear the timers on any recent prints that are displayed in the notify lines
  61         virtual void    ClearNotifyLines( void ) = 0;
  62
  63         // some console commands, like timeDemo, will force the console closed before they start
  64         virtual void    Close( void ) = 0;
  65
  66         virtual void    Draw( bool forceFullScreen ) = 0;
  67         virtual void    Print( const char *text ) = 0;
  68 };
  69
  70 extern idConsole *      console;        // statically initialized to an idConsoleLocal
  71
  72 #endif /* !__CONSOLE_H__ */