PixelLightAPI: ConsoleDefaultCommands.h Source File

Go to the documentation of this file.
00001 /*********************************************************\
00002  *  File: ConsoleDefaultCommands.h                       *
00003  *      Console default execution function headers
00004  *
00005  *  Copyright (C) 2002-2012 The PixelLight Team (http://www.pixellight.org/)
00006  *
00007  *  This file is part of PixelLight.
00008  *
00009  *  PixelLight is free software: you can redistribute it and/or modify
00010  *  it under the terms of the GNU Lesser General Public License as published by
00011  *  the Free Software Foundation, either version 3 of the License, or
00012  *  (at your option) any later version.
00013  *
00014  *  PixelLight is distributed in the hope that it will be useful,
00015  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00016  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
00017  *  GNU Lesser General Public License for more details.
00018  *
00019  *  You should have received a copy of the GNU Lesser General Public License
00020  *  along with PixelLight. If not, see <http://www.gnu.org/licenses/>.
00021 \*********************************************************/
00022 
00023 
00024 #ifndef __PLENGINE_COMPOSITING_CONSOLEDEFAULTCOMMANDS_H__
00025 #define __PLENGINE_COMPOSITING_CONSOLEDEFAULTCOMMANDS_H__
00026 #pragma once
00027 
00028 
00029 //[-------------------------------------------------------]
00030 //[ Namespace                                             ]
00031 //[-------------------------------------------------------]
00032 namespace PLEngine {
00033 
00034 
00035 //[-------------------------------------------------------]
00036 //[ Forward declarations                                  ]
00037 //[-------------------------------------------------------]
00038 class ConsoleCommand;
00039 
00040 
00041 //[-------------------------------------------------------]
00042 //[ Global functions                                      ]
00043 //[-------------------------------------------------------]
00044 // Standard commands
00045 extern void PLConsoleCommandHelp(ConsoleCommand &cCommand);             /**< Show console help text */
00046 extern void PLConsoleCommandList(ConsoleCommand &cCommand);             /**< List all console commands */
00047 extern void PLConsoleCommandBulkyList(ConsoleCommand &cCommand);        /**< Detailed list all console commands */
00048 extern void PLConsoleCommandClear(ConsoleCommand &cCommand);            /**< Clear console history */
00049 extern void PLConsoleCommandAbout(ConsoleCommand &cCommand);            /**< Display some info about the engine */
00050 extern void PLConsoleCommandVersion(ConsoleCommand &cCommand);          /**< Version information */
00051 extern void PLConsoleCommandFPS(ConsoleCommand &cCommand);              /**< Toggle FPS display */
00052 extern void PLConsoleCommandFPSLimit(ConsoleCommand &cCommand);         /**< Sets the FPS limit, 0 if there's no FPS limitation */
00053 extern void PLConsoleCommandProfiling(ConsoleCommand &cCommand);        /**< Activates/deactivates the profiling system */
00054 extern void PLConsoleCommandNextProfile(ConsoleCommand &cCommand);      /**< Selects the next profile group */
00055 extern void PLConsoleCommandPreviousProfile(ConsoleCommand &cCommand);  /**< Selects the previous profile group */
00056 // Debug commands
00057 extern void PLConsoleCommandWireframes(ConsoleCommand &cCommand);       /**< Toggle render wireframe mode */
00058 extern void PLConsoleCommandPoints(ConsoleCommand &cCommand);           /**< Toggle render point mode */
00059 extern void PLConsoleCommandCoordinateAxis(ConsoleCommand &cCommand);   /**< Toggle coordinate axis visualization */
00060 extern void PLConsoleCommandXZPlane(ConsoleCommand &cCommand);          /**< Toggle xz-plane visualization */
00061 extern void PLConsoleCommandXYPlane(ConsoleCommand &cCommand);          /**< Toggle xy-plane visualization */
00062 extern void PLConsoleCommandYZPlane(ConsoleCommand &cCommand);          /**< Toggle yz-plane visualization */
00063 extern void PLConsoleCommandSetLogLevel(ConsoleCommand &cCommand);      /**< Set log level */
00064 extern void PLConsoleCommandPause(ConsoleCommand &cCommand);            /**< Toggle pause modus */
00065 extern void PLConsoleCommandTimeScale(ConsoleCommand &cCommand);        /**< Time scale */
00066 
00067 
00068 //[-------------------------------------------------------]
00069 //[ Namespace                                             ]
00070 //[-------------------------------------------------------]
00071 } // PLEngine
00072 
00073 
00074 #endif // __PLENGINE_COMPOSITING_CONSOLEDEFAULTCOMMANDS_H__