Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/orxonox/Orxonox.h @ 1214

Last change on this file since 1214 was 1214, checked in by landauf, 16 years ago

merged console-branch back to trunk.
IMPORTANT: update your media directory!

you need TCL to compile. TCL is available here: http://www.tcl.tk/
another option is to check out https://svn.orxonox.net/ogre/tcl8.5.2/ and compile it by yourself. makefiles are in the 'macosx', 'unix' and 'win' subfolders.
FindTCL.cmake searches in the usual locations and in ../libs/tcl8.5.2/

the orxonox console can be activated with numpad-enter. whatever you enter will be parsed by TCL. if TCL doesn't know a command, it gets executed by orxonox.

simple tcl commands are: "puts text" to write "text" into the console, "expr 1+1" to calculate the result of the given expression. just try it by yourself with "puts [expr 1+1]".
[x] means: evaluate x and use the returnvalue as an argument. in this case the returned value is "2" and the resulting command therefore "puts 2".

you can combine orxonox and tcl commands. a simple orxonox command is "log text" that writes text into the console and the logfile. test it with "log [expr 1+1]" to write "2" into all output channels of orxonox. something more advanced: "log [clock seconds]" writes the seconds since 1970 into the logfile. feel free to combine both: "log [clock seconds]: 1+1 is [expr 1+1]"

TCL uses variables. to set a new variable, use "set varname value". you can use the variable wherever you want with $varname. with this we can make the above command a bit more elegant:
set myexpression 1+1
log [clock seconds]: $myexpression is [expr $myexpression]

read more about tcl in the wiki: http://wiki.tcl.tk/

File size: 3.7 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      ...
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30 @file  Orxonox.h
31 @brief Main Orxonox Class File
32 @author Benjamin Knecht <beni_at_orxonox.net>
33 */
34
35#ifndef _Orxonox_H__
36#define _Orxonox_H__
37
38#include "OrxonoxPrereqs.h"
39
40#include <string>
41
42#include <OgrePrerequisites.h>
43#include "audio/AudioPrereqs.h"
44
45#include "GraphicsEngine.h"
46#include "core/InputEventListener.h"
47
48
49namespace orxonox {
50
51  enum gameMode{
52    SERVER,
53    CLIENT,
54    STANDALONE
55  };
56
57  //! Orxonox singleton class
58  class _OrxonoxExport Orxonox : public InputEventListener
59  {
60    public:
61      void init(int argc, char **argv, std::string path);
62      void start();
63      void abortImmediateForce();
64      void abortRequest();
65      inline audio::AudioManager* getAudioManagerPointer() { return auMan_; };
66
67      static Orxonox* getSingleton();
68      static void destroySingleton();
69
70      static inline void slomo(float factor) { Orxonox::getSingleton()->timefactor_ = factor; }
71      static inline void setTimeFactor(float factor = 1.0) { Orxonox::getSingleton()->timefactor_ = factor; }
72      static inline float getTimeFactor() { return Orxonox::getSingleton()->timefactor_; }
73      static inline void exit() { Orxonox::getSingleton()->abortRequest(); }
74
75   private:
76      // don't mess with singletons
77      Orxonox();
78      Orxonox(Orxonox& instance);
79      Orxonox& operator=(const Orxonox& instance);
80      ~Orxonox();
81
82      // init functions
83      void serverInit(std::string path);
84      void clientInit(std::string path);
85      void standaloneInit(std::string path);
86
87      // run functions
88      void serverStart();
89      void clientStart();
90      void standaloneStart();
91
92      void createScene();
93      void setupInputSystem();
94      void startRenderLoop();
95      float calculateEventTime(unsigned long, std::deque<unsigned long>&);
96
97      void eventOccured(InputEvent &evt);
98
99    private:
100      GraphicsEngine*       ogre_;          //!< our dearest graphics engine <3
101      std::string           dataPath_;      //!< path to data
102      audio::AudioManager*  auMan_;         //!< audio manager
103      InputManager*         inputHandler_;  //!< Handles input with key bindings
104      Ogre::Timer*          timer_;         //!< Main loop timer
105      // TODO: make this a config-value by creating a config class for orxonox
106      float                 frameSmoothingTime_;
107      InGameConsole*        orxonoxConsole_;
108      HUD*                  orxonoxHUD_;
109      bool                  bAbort_;        //!< aborts the render loop if true
110      float                 timefactor_;    //!< A factor to change the gamespeed
111
112      // this is used to identify the mode (server/client/...) we're in
113      gameMode              mode_;
114      std::string           serverIp_;
115
116      static Orxonox *singletonRef_s;
117  };
118}
119#endif /* _Orxonox_H__ */
Note: See TracBrowser for help on using the repository browser.