Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changes between Version 60 and Version 61 of code/doc/ModulesDescription


Ignore:
Timestamp:
Oct 1, 2008, 5:12:59 AM (11 years ago)
Author:
landauf
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • code/doc/ModulesDescription

    v60 v61  
    11= Module Description =
    2 
    32[[TracNav(TracNav/TOC_Development)]]
    43
    5 [[TOC]]
     4A list of the most important modules in the framework of Orxonox.
    65
    7 How to use certain modules in the Orxonox framework. This list is not complete, ask the programmers in named in the .cc files for more information.
    8 [[br]]
    9 [wiki:DevModTemplate Template for creating Module Descriptions] [[br]]
    10 For an alphabetical list of all code related pages [wiki:code see].
     6== Util ==
     7 * [wiki:Debug Debug Output] and [wiki:OutputHandler]
     8    An easy way to write output to the console, the logfile and the ingame shell
     9 * [wiki:Convert] and [wiki:MultiType]
     10    Convert values and pass them to functions without caring about the type
    1111
    12 == Framework ==
    13  * [wiki:Core Core Elements] - (location:/src/orxonox/core)
    14  * [wiki:Network] - (location:/src/network)
     12== Core ==
     13 * [wiki:Identifier], [wiki:ClassIdentifier], [wiki:CoreIncludes]
     14    Identify classes and store information in a "virtual static" manner
     15 * [wiki:ConfigValueIncludes], [wiki:ConfigValueContainer], [wiki:ConfigFileManager]
     16    Make values configurable in a config-file
     17 * [wiki:CommandLine]
     18    Use command line arguments to control Orxonox
     19 * [wiki:Functor] and [wiki:Executor]
     20    Bind functions, objects and arguments to call a function whenever and wherever you want
     21 * [wiki:ConsoleCommand], [wiki:CommandExecutor], [wiki:Shell]
     22    Execute functions through a string
     23 * [wiki:Factory]
     24    Create objects through a string
     25 * [wiki:Input Input Management]
     26    Handle input and bind functions
     27 * [wiki:ObjectListBase], [wiki:ObjectList], [wiki:ObjectListIterator], [wiki:Iterator]
     28    Register all existing objects in lists and iterate through them
     29 * [wiki:GameStates]
     30    Initialize the different parts of the engine in a controlled way
     31 * [wiki:Loader], [wiki:Level], [wiki:Namespace], [wiki:XMLPort]
     32    Load and save objects and whole levels with XML files
     33 * [wiki:Super]
     34    Call functions of the baseclass without caring about the class hierarchy
    1535
    16 == Input ==
    17  * [wiki:Input Input Management] - (location:/src/orxonox/core/input)
     36== Network ==
     37 * [wiki:Network]
     38    Play the game with other people
    1839
    19 == Rendering ==
    20  * [wiki:Particles] - (location:/src/orxonox/tools)
    21  * [wiki:ShaderEffects Shader Effects]
     40== Scripting ==
     41 * [wiki:Scripting]
     42    How to use the Lua script engine of Orxonox
     43 * [wiki:TclBind] and [wiki:TclThreadManager]
     44    Use a powerful console by activating Tcl
    2245
    2346== Graphical Interfaces ==
    24  * [wiki:HUD] - (location:/src/orxonox/hud)
    25  * [wiki:GUI] - (location:/src/orxonox/gui)
     47 * [wiki:HUD]
     48    Show some information on the screen
    2649
    27 == Game Modules ==
    28  * [wiki:Scripting] - How to use the script engine of Orxonox
    29  * [wiki:Weapon] - our weapon system
    30 
    31 [[OutdatedPage]]
    32 
    33  * BaseObject ClassID and ObjectList - (source:/trunk/src/lib/lang)
    34  * [wiki:DebugOutput Debug Output] - ([source:/trunk/src/defs/debug.h#HEAD debug.h])
    35  * [wiki:GenList Lists and Stacks] - using the List
    36  * [wiki:ResourceManager Resource Manager] - ([source:/trunk/src/util/resource_manager.h#HEAD resource_manager.h])
    37  * [wiki:EventHandler Event Handler] - the event-handling system of orxonox (lib/event)
    38  * [wiki:NetworkManager Network Manager] - The network interface for the orxonox framework
    39  * [wiki:CollisionDetection Collision Detection] - The module checking for collisions
    40  * [wiki:CollisionReaction Collision Reaction] - The module registering collisions and reacting to them
    41  * [wiki:ObjectManager Object Manager] - The Manager of all the Entitites in the world
    42 
    43 
    44 == Rendering ==
    45  * [wiki:Render2D Render 2D] - (lib/graphics/render_2d) 
    46  * [wiki:MD2Model MD2 Model] - (the md2 model class and functions: md2Model.cc, md2Model.h, abstract_model.h)
    47  * [wiki:HeightMap Height Map] - (a Height map model)
    48  * [wiki:TextEngine Text Engine] - ([source:/trunk/src/lib/graphics/text_engine text_engine])
    49  * [wiki:AnimatedTextures Animated Textures] - animated textures for rendering movies
    50  * [wiki:ParticleEngine Particle Engine] - (lib/particle)
    51  * [wiki:SoundEngine Sound Engine] - (sound_engine.h)
    52  * [wiki:AnimationPlayer Animation Player] - (animation_player.h, animation.h and derived classes)
    53  * [wiki:PhysicsEngine Physics Engine] - (lib/physics)
    54  * [wiki:BspModel] - (a QuakeIII level loader)
    55  * [wiki:AtmosphericEngine Atmospheric Engine] - Manages the weather, sun etc
    56 
    57 
    58 
    59 == Loading ==
    60  * [wiki:IniParser INI Parser] - (an ini-file-parser ini_parser.h)
    61  * [wiki:LoadParam Load Parameter] - (a fully featured loading engine load_param.h)
    62  * [wiki:objImporter OBJ Importer] - module to import obj files (alias wavefront file format)
    63 
    64 == Graphical Interfaces ==
    65  * [wiki:Shell Shell] - an Interface to the debug.h
    66  * [wiki:UserInterface UserInterface] - the orxonox GUI framework
    67 
    68 == Game Modules ==
    69  * [wiki:Weapon Weapon] shoot and load support
    70  * [wiki:Control Spaceship Control] to control the Spaceship
    71  * [wiki:PowerUpEngine Power-Up Engine] an engine that handles picked up items
    72  * [wiki:ScriptingHowTo] How to use the scriptengine of orxonox