Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changes between Version 10 and Version 11 of code/doc/Core


Ignore:
Timestamp:
Sep 17, 2008, 5:29:48 PM (16 years ago)
Author:
landauf
Comment:

—

Legend:

Unmodified
Added
Removed
Modified

  • code/doc/Core

    v10 v11  
    44=== Description ===
    55
    6 The core is a library of Orxonox, containing all central classes of the framework. It provides several functions and features, used by most of the objects in Orxonox and other libraries (network). Some functions are encapsuled in macros, defined in [wiki:CoreIncludes CoreIncludes.h], others must be included separately. Read the detailed descriptions and examples of the core-classes for more informations.
     6The core is a library of Orxonox, containing all central classes of the framework. It provides several functions and features, used by most of the objects in Orxonox and other libraries (network). Some functions are encapsuled in macros. Read the detailed descriptions and examples of the core-classes for more informations.
    77
    88
    … …  
    1010
    1111|| '''Name''' || '''Description''' ||
     12|| [wiki:ArgumentCompleter] || Completes arguments of a [wiki:ConsoleCommand], based on a [wiki:ArgumentCompletionFunctions list] ||
     13|| [wiki:ArgumentCompletionFunctions] || Returns a list of possible [wiki:ConsoleCommand] arguments ||
    1214|| [wiki:BaseObject] || The common base of all objects in Orxonox ||
    13 || [wiki:ClassFactory] || Creates new objects of a given classname ||
     15|| [wiki:ClassFactory] || Creates a new object of a given class ||
    1416|| [wiki:ClassIdentifier] || Derivative of the [wiki:Identifier], contains class-specific stuff ||
    15 || [wiki:ClassManager] || A helper class to get a unique [wiki:ClassIdentifier] ||
    1617|| [wiki:ClassTreeMask] || Includes or excludes classes from the class-tree ||
    1718|| [wiki:Clock] || Global timer objects that captures time via Ogre::Timer ||
     19|| [wiki:CommandEvaluation] || Evaluates the function and the arguments of a [wiki:ConsoleCommand] string ||
     20|| [wiki:CommandExecutor] || Executes a [wiki:ConsoleCommand] string ||
    1821|| [wiki:CommandLine] || Reads arguments from the shell and start.ini ||
     22|| [wiki:ConfigFileManager] || Parses a config file and creates [wiki:ConfigValueContainers] for each value ||
    1923|| [wiki:ConfigValueContainer] || Defines name and default-value of a configurable value ||
    20 || [wiki:CoreIncludes] || Defines several macros ||
    21 || [wiki:Debug] || Defines macros for [wiki:DebugLevel leveled] [wiki:OutputHandler debug-output] ||
    22 || [wiki:DebugLevel] || A helper class to configure the level of [wiki:Debug debug-output] ||
    23 || [wiki:Exception Messages, Exceptions and Assertions] || Defines exceptions and assertions ||
     24|| [wiki:ConfigValueIncludes] || Declares helper macros for easy use of config values ||
     25|| [wiki:ConsoleCommand] || Defines a command, which is basically a link between a string and a function ||
     26|| [wiki:ConsoleCommandCompilation] || A compilation of basic [wiki:ConsoleCommand ConsoleCommands] ||
     27|| [wiki:CoreSettings] || Stores some core-related settings and makes them configurable ||
     28|| [wiki:CoreIncludes] || Defines several macros needed to create the class hierarchy ||
     29|| [wiki:Executor] || Uses a [wiki:Functor] to execute functions with several features ||
    2430|| [wiki:Factory] || Stores [wiki:ClassIdentifier ClassIdentifiers] and the names of their classes ||
     31|| [wiki:Functor] || Encapsules a function pointer with parameters and a return value ||
    2532|| [wiki:GameStates] || Manages the possible states of the game ||
    2633|| [wiki:Identifier] || Identifies the class of an object ||
    27 || [wiki:IdentifierDistributor] || Provides unique [wiki:ClassIdentifier ClassIdentifiers] ||
     34|| [wiki:IRC] || Chat in IRC through a [wiki:TclBind Tcl] library ||
    2835|| [wiki:Iterator] || Iterates through all objects of a class ||
    2936|| [wiki:Language] || Handles strings in different languages ||
    … …  
    3138|| [wiki:Loader] || Loads a [wiki:Level] ||
    3239|| [wiki:MetaObjectList] || Intern class for fast removal of objects from the [wiki:ObjectList] ||
     40|| [wiki:Namespace] || Used in [wiki:Level Levels] to group objects ||
    3341|| [wiki:ObjectList] || Stores all objects of a class ||
     42|| [wiki:ObjectListIterator] || Iterates through all objects of a given [wiki:ObjectList] ||
    3443|| [wiki:OrxonoxClass] || The base class of all objects and interfaces that use [wiki:Identifier Identifiers] ||
    35 || [wiki:OutputHandler] || Handles [wiki:Debug output] and distributes it to console and logfile ||
    36 || [wiki:SignalHandler] || Handles signals from the OS and writes a backtrace to the log if the game crashes ||
     44|| [wiki:RootGameState] || The root of all [wiki:GameStates] ||
     45|| [wiki:Script] || Used for interaction between Orxonox and Lua ||
     46|| [wiki:Shell] || The technical part of the ingame console ||
    3747|| [wiki:SubclassIdentifier] || Acts like an [wiki:Identifier], but has a base-class ||
     48|| [wiki:Super] || Easy and save call of a virtual parent function ||
     49|| [wiki:TclBind] || Used for interaction betweeen Orxonox and Tcl ||
     50|| [wiki:TclThreadManager] || Creates threads for parallel execution of [wiki:TclBind Tcl] scripts ||
     51|| [wiki:XMLPort] || Defines some macros and classes for easy XML parsing ||