Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changes between Version 6 and Version 7 of code/doc/OrxonoxClass


Ignore:
Timestamp:
Sep 27, 2008, 2:43:32 AM (12 years ago)
Author:
landauf
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • code/doc/OrxonoxClass

    v6 v7  
    44== Description ==
    55
    6 OrxonoxClass is the base class of all objects and interfaces having [wiki:Identifier Identifiers]. Therefore OrxonoxClass is the direct parent of BaseObject and several interfaces like [wiki:Tickable] or [wiki:Synchronisable].
     6!OrxonoxClass is the base class of all objects and interfaces in the class hierarchy. Therefore !OrxonoxClass is the direct parent of [wiki:BaseObject] and several interfaces like [wiki:Tickable] or [wiki:network/Synchronisable Synchronisable].
    77
    8 OrxonoxClass itself isn't of any use to the game-logic. All functions and variables are only there to create a common base for [wiki:Identifier Identifiers]. Some functions are used in macros (see CoreIncludes).
     8!OrxonoxClass itself isn't of any use for the game-logic. All functions and variables are only there to create a common base for [wiki:Identifier Identifiers] and to create the class hierarchy. Some functions are used in macros (see [wiki:CoreIncludes]).
    99
    1010== Inheriting from !OrxonoxClass ==
    1111
    12 Classes inheriting from OrxonoxClass '''must''' use '''virtual public''' derivation to avoid problems in the class-tree (diamond shape):
     12Classes inheriting from !OrxonoxClass '''must''' use '''virtual public''' derivation to avoid problems in the class-tree (diamond shape):
    1313
    1414{{{
     
    2424
    2525 * '''Identifier''':
    26    * getIdentifier(): Returns the [wiki:Identifier] of an object
    27    * setIdentifier(...): Sets the [wiki:Identifier] of the class (used by a macro, see [wiki:CoreIncludes]
     26   * '''getIdentifier()''': Returns the [wiki:Identifier] of an object
     27   * '''setIdentifier('''''identifier''''')''': Sets the [wiki:Identifier] of the class (used by a macro, see [wiki:CoreIncludes]
    2828
    2929 * '''Parents''':
    30    * getParents() and createParents() are functions used by macros (see [wiki:CoreIncludes]) to create the class-tree
     30   * '''getParents()''' and '''createParents()''' are functions used by macros (see [wiki:CoreIncludes]) to create the class-tree
    3131
    3232 * '''Comparison''': see [wiki:Identifier] for more information
    33    * isA(...)
    34    * isExactlyA(...)
    35    * isChildOf(...)
    36    * isDirectChildOf(...)
    37    * isParentOf(...)
    38    * isDirectParentOf(...)
     33   * '''isA(...)'''
     34   * '''isExactlyA(...)'''
     35   * '''isChildOf(...)'''
     36   * '''isDirectChildOf(...)'''
     37   * '''isParentOf(...)'''
     38   * '''isDirectParentOf(...)'''
    3939
    4040== Illustration ==
    4141
    42 As you can see, OrxonoxClass is on the top of the class-tree. Every other object or interface is a derivative.
     42As you can see, !OrxonoxClass is on the top of the class-tree. Every other object or interface is a derivative:
    4343
    4444[[Image(Core:testclass_interface_orxonoxclass_tree.gif)]]