Console.h - DOOM-3-BFG - DOOM 3 BFG Edition

Console.h (3310B)
      1 /*
      2 ===========================================================================
      3 
      4 Doom 3 BFG Edition GPL Source Code
      5 Copyright (C) 1993-2012 id Software LLC, a ZeniMax Media company. 
      6 
      7 This file is part of the Doom 3 BFG Edition GPL Source Code ("Doom 3 BFG Edition Source Code").  
      8 
      9 Doom 3 BFG Edition 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 BFG Edition 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 BFG Edition Source Code.  If not, see <http://www.gnu.org/licenses/>.
     21 
     22 In addition, the Doom 3 BFG Edition 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 BFG Edition 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 enum justify_t {
     33 	JUSTIFY_LEFT,
     34 	JUSTIFY_RIGHT,
     35 	JUSTIFY_CENTER_LEFT,
     36 	JUSTIFY_CENTER_RIGHT
     37 };
     38 
     39 class idOverlayHandle {
     40 friend class idConsoleLocal;
     41 public:
     42 			idOverlayHandle() : index( -1 ), time( 0 ) {}
     43 private:
     44 	int		index;
     45 	int		time;
     46 };
     47 
     48 /*
     49 ===============================================================================
     50 
     51 	The console is strictly for development and advanced users. It should
     52 	never be used to convey actual game information to the user, which should
     53 	always be done through a GUI.
     54 
     55 	The force options are for the editor console display window, which
     56 	doesn't respond to pull up / pull down
     57 
     58 ===============================================================================
     59 */
     60 
     61 class idConsole {
     62 public:
     63 	virtual			~idConsole() {}
     64 
     65 	virtual void	Init() = 0;
     66 	virtual void	Shutdown() = 0;
     67 
     68 	virtual bool	ProcessEvent( const sysEvent_t * event, bool forceAccept ) = 0;
     69 
     70 	// the system code can release the mouse pointer when the console is active
     71 	virtual bool	Active() = 0;
     72 
     73 	// clear the timers on any recent prints that are displayed in the notify lines
     74 	virtual void	ClearNotifyLines() = 0;
     75 
     76 	// some console commands, like timeDemo, will force the console closed before they start
     77 	virtual void	Close() = 0;
     78 
     79 	virtual void	Draw( bool forceFullScreen ) = 0;
     80 	virtual void	Print( const char *text ) = 0;
     81 
     82 	virtual void	PrintOverlay( idOverlayHandle & handle, justify_t justify, VERIFY_FORMAT_STRING const char * text, ... ) = 0;
     83 
     84 	virtual idDebugGraph *	CreateGraph( int numItems ) = 0;
     85 	virtual void			DestroyGraph( idDebugGraph * graph ) = 0;
     86 };
     87 
     88 extern idConsole *	console;	// statically initialized to an idConsoleLocal
     89 
     90 #endif /* !__CONSOLE_H__ */