Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 2141 in orxonox.OLD for orxonox/branches/chris/src/orxonox.cc


Ignore:
Timestamp:
Jul 14, 2004, 3:31:42 PM (20 years ago)
Author:
chris
Message:

orxonox/branches/chris: added lots and lots of doxygen tags

File:
1 edited

Legend:

Unmodified
Added
Removed
  • orxonox/branches/chris/src/orxonox.cc

    r2115 r2141  
    3232using namespace std;
    3333
     34/**
     35        \brief create a new Orxonox
     36*/
    3437Orxonox::Orxonox ()
    3538{
     
    3740}
    3841
    39 
    40 
     42/**
     43        \brief remove Orxonox from memory
     44*/
    4145Orxonox::~Orxonox ()
    4246{
     
    5963}
    6064
     65/**
     66        \brief this finds the config file
     67       
     68        Since the config file varies from user to user and since one may want to specify different config files
     69        for certain occasions or platforms this function finds the right config file for every occasion and stores
     70        it's path and name into configfilename
     71*/
    6172void Orxonox::get_config_file (int argc, char** argv)
    6273{
     
    7586}
    7687
     88/**
     89        \brief initialize Orxonox with command line
     90*/
    7791int Orxonox::init (int argc, char** argv)
    7892{
     
    107121}
    108122
     123/**
     124        \brief initializes SDL and OpenGL
     125*/
    109126int Orxonox::init_video ()
    110127{
     
    148165}
    149166
     167/**
     168        \brief initializes the sound engine
     169*/
    150170int Orxonox::init_sound ()
    151171{
     
    154174}
    155175
     176/**
     177        \brief initializes input functions
     178*/
    156179int Orxonox::init_input ()
    157180{
     
    162185}
    163186
    164 
     187/**
     188        \brief initializes network system
     189*/
    165190int Orxonox::init_networking ()
    166191{
     
    169194}
    170195
     196/**
     197        \brief initializes and loads resource files
     198*/
    171199int Orxonox::init_resources ()
    172200{
     
    175203}
    176204
     205/**
     206        \brief initializes the world
     207*/
    177208int Orxonox::init_world ()
    178209{
     
    185216}
    186217
     218/**
     219        \brief exits Orxonox
     220*/
    187221void Orxonox::quitGame()
    188222{
    189223        bQuitOrxonox = true;
    190224}
     225
     226/**
     227        \brief this runs all of Orxonox
     228*/
    191229void Orxonox::mainLoop()
    192230{
     
    211249}
    212250
     251/**
     252        \brief handles sprecial events from localinput
     253        \param event: an event not handled by the CommandNode
     254*/
    213255void Orxonox::event_handler (SDL_Event* event)
    214256{
     
    216258}
    217259
     260/**
     261        \brief synchronize local data with remote data
     262*/
    218263void Orxonox::synchronize ()
    219264{
     
    222267}
    223268
     269/**
     270        \brief run all input processing
     271*/
    224272void Orxonox::handle_input ()
    225273{
     
    229277}
    230278
     279/**
     280        \brief advance the timeline
     281*/
    231282void Orxonox::time_slice ()
    232283{
     
    241292}
    242293
     294/**
     295        \brief compute collision detection
     296*/
    243297void Orxonox::collision ()
    244298{
     
    246300}
    247301
     302/**
     303        \brief handle keyboard commands that are not meant for WorldEntities
     304        \param cmd: the command to handle
     305        \return true if the command was handled by the system or false if it may be passed to the WorldEntities
     306*/
    248307bool Orxonox::system_command (Command* cmd)
    249308{
    250         if( !strcmp( cmd->cmd, "quit") && !cmd->bUp)
     309        if( !strcmp( cmd->cmd, "quit"))
    251310        {
    252                 bQuitOrxonox = true;
     311                if( !cmd->bUp) bQuitOrxonox = true;
    253312                return true;
    254313        }
     
    256315}
    257316
     317/**
     318        \brief render the current frame
     319*/
    258320void Orxonox::display ()
    259321{
     
    269331}
    270332
     333/**
     334        \brief retrieve a pointer to the local Camera
     335        \return a pointer to localcamera
     336*/
    271337Camera* Orxonox::get_camera ()
    272338{
     
    274340}
    275341
     342/**
     343        \brief retrieve a pointer to the local CommandNode
     344        \return a pointer to localinput
     345*/
    276346CommandNode* Orxonox::get_localinput ()
    277347{
     
    279349}
    280350
     351/**
     352        \brief retrieve a pointer to the local World
     353        \return a pointer to world
     354*/
    281355World* Orxonox::get_world ()
    282356{
     
    296370       
    297371  (*orx).mainLoop();
     372
     373  delete orx;
    298374 
    299375  return 0;
Note: See TracChangeset for help on using the changeset viewer.