Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 4836 in orxonox.OLD for orxonox/trunk/src/lib/graphics


Ignore:
Timestamp:
Jul 12, 2005, 12:33:16 AM (20 years ago)
Author:
bensch
Message:

orxonox/trunk: renamed all the \param → @param and so on in Doxygen tags.
Thanks a lot to the kDevelop team. this took since the last commit :)

Location:
orxonox/trunk/src/lib/graphics
Files:
25 edited

Legend:

Unmodified
Added
Removed

  • orxonox/trunk/src/lib/graphics/graphics_engine.cc

    r4835 r4836  
    3030
    3131/**
    32    \brief standard constructor
    33    \todo this constructor is not jet implemented - do it
     32 * standard constructor
     33   @todo this constructor is not jet implemented - do it
    3434*/
    3535GraphicsEngine::GraphicsEngine ()
    … …  
    4848
    4949/**
    50    \brief The Pointer to this GraphicsEngine
     50 * The Pointer to this GraphicsEngine
    5151*/
    5252GraphicsEngine* GraphicsEngine::singletonRef = NULL;
    5353
    5454/**
    55    \brief destructs the graphicsEngine.
     55 * destructs the graphicsEngine.
    5656*/
    5757GraphicsEngine::~GraphicsEngine ()
    … …  
    103103
    104104/**
    105    \brief initializes the Video for openGL.
     105 * initializes the Video for openGL.
    106106
    107107   This has to be done only once when starting orxonox.
    … …  
    170170
    171171/**
    172    \brief Sets the GL-attributes
     172 * Sets the GL-attributes
    173173*/
    174174int GraphicsEngine::setGLattribs()
    … …  
    192192
    193193/**
    194    \brief sets the Resolution of the Screen to display the Graphics to.
    195    \param width The width of the window
    196    \param height The height of the window
    197    \param bpp bits per pixel
     194 * sets the Resolution of the Screen to display the Graphics to.
     195 * @param width The width of the window
     196 * @param height The height of the window
     197 * @param bpp bits per pixel
    198198*/
    199199int GraphicsEngine::setResolution(int width, int height, int bpp)
    … …  
    212212
    213213/**
    214    \brief sets Fullscreen mode
    215    \param fullscreen true if fullscreen, false if windowed
     214 * sets Fullscreen mode
     215 * @param fullscreen true if fullscreen, false if windowed
    216216*/
    217217void GraphicsEngine::setFullscreen(bool fullscreen)
    … …  
    225225
    226226/**
    227    \brief sets the background color
    228    \param red the red part of the background
    229    \param blue the blue part of the background
    230    \param green the green part of the background
    231    \param alpha the alpha part of the background
     227 * sets the background color
     228 * @param red the red part of the background
     229 * @param blue the blue part of the background
     230 * @param green the green part of the background
     231 * @param alpha the alpha part of the background
    232232*/
    233233void GraphicsEngine::setBackgroundColor(GLclampf red, GLclampf green, GLclampf blue, GLclampf alpha)
    … …  
    238238
    239239/**
    240    \brief Signalhandler, for when the resolution has changed
    241    \param resizeInfo SDL information about the size of the new screen size
     240 * Signalhandler, for when the resolution has changed
     241 * @param resizeInfo SDL information about the size of the new screen size
    242242*/
    243243int GraphicsEngine::resolutionChanged(const SDL_ResizeEvent& resizeInfo)
    … …  
    308308
    309309/**
    310    \brief entering 2D Mode
     310 * entering 2D Mode
    311311
    312312   this is a GL-Projection-mode, that is orthogonal, for placing the font in fron of everything else
    … …  
    341341
    342342/**
    343    \brief leaves the 2DMode again also \see Font::enter2DMode()
     343 * leaves the 2DMode again also \see Font::enter2DMode()
    344344*/
    345345void GraphicsEngine::leave2DMode()
    … …  
    355355
    356356/**
    357    \brief stores the GL_matrices
     357 * stores the GL_matrices
    358358*/
    359359void GraphicsEngine::storeMatrices()
    … …  
    374374
    375375/**
    376    \brief outputs all the Fullscreen modes.
     376 * outputs all the Fullscreen modes.
    377377*/
    378378void GraphicsEngine::listModes()
    … …  
    400400
    401401/**
    402    \brief ticks the Text
    403    \param dt the time passed
     402 * ticks the Text
     403 * @param dt the time passed
    404404*/
    405405void GraphicsEngine::tick(float dt)
    … …  
    426426
    427427/**
    428    \brief displays the Frames per second
    429    \param display if the text should be displayed
    430 
    431    \todo this is dangerous
     428 * displays the Frames per second
     429 * @param display if the text should be displayed
     430
     431   @todo this is dangerous
    432432*/
    433433void GraphicsEngine::displayFPS(bool display)
    … …  
    453453/**
    454454  \brief processes the events for orxonox main class
    455   \param the event to handle
     455* @param the event to handle
    456456 */
    457457void GraphicsEngine::process(const Event &event)

  • orxonox/trunk/src/lib/graphics/graphics_engine.h

    r4834 r4836  
    22    \file graphics_engine.h
    33
    4     \brief defines a Interface between orxonox and graphical input
     4  * defines a Interface between orxonox and graphical input
    55
    66    handles graphical SDL-initialisation, textures, resolutions, and so on
    … …  
    2727  public:
    2828    virtual ~GraphicsEngine();
    29     /** \returns a Pointer to the only object of this Class */
     29    /** @returns a Pointer to the only object of this Class */
    3030    inline static GraphicsEngine* getInstance() { if (!singletonRef) singletonRef = new GraphicsEngine();  return singletonRef; };
    3131
    … …  
    4040
    4141
    42     /** \returns the x resolution */
     42    /** @returns the x resolution */
    4343    inline int getResolutionX() const { return this->resolutionX; };
    44     /** \returns the y resolution */
     44    /** @returns the y resolution */
    4545    inline int getResolutionY() const { return this->resolutionY; };
    46     /** \returns the Bits Per Pixel */
     46    /** @returns the Bits Per Pixel */
    4747    inline int getbbp() const { return this->bitsPerPixel; };
    4848

  • orxonox/trunk/src/lib/graphics/importer/abstract_model.h

    r4809 r4836  
    1616/*!
    1717    \file abstract_model.h
    18     \brief Definition of an abstract model. containing all needed for other model
     18  * Definition of an abstract model. containing all needed for other model
    1919*/
    2020

  • orxonox/trunk/src/lib/graphics/importer/array.h

    r4799 r4836  
    3636    void addEntry(T entry0, T entry1, T entry2);
    3737
    38     /** \returns The array */
     38    /** @returns The array */
    3939    inline const T* getArray () const { return this->array; };
    40     /**   \returns The Count of entries in the Array*/
     40    /** * @returns The Count of entries in the Array*/
    4141    inline unsigned int getCount()const { return this->entryCount; };
    4242    inline int getIndex(T* entry) const;
    … …  
    6161
    6262/**
    63    \brief creates a new Array
     63 * creates a new Array
    6464*/
    6565template<class T>
    … …  
    7575
    7676/**
    77    \brief deletes an Array.
     77 * deletes an Array.
    7878   It does this by first deleting all the array-entries, and then delete the array[] itself
    7979*/
    … …  
    9595
    9696/**
    97    \brief finalizes an array.
     97 * finalizes an array.
    9898   This Function creates the array, and makes it ready to be sent to the application.
    9999*/
    … …  
    124124
    125125/**
    126    \brief adds a new Entry to the Array
    127    \param entry Entry to add.
     126 * adds a new Entry to the Array
     127 * @param entry Entry to add.
    128128*/
    129129template<class T>
    … …  
    145145
    146146/**
    147    \brief Adds 3 entries at once (convenience)
     147 * Adds 3 entries at once (convenience)
    148148*/
    149149template<class T>
    … …  
    157157
    158158/**
    159    \brief gets back the index of the entry in the array. value check
    160    \param entry: the entry to look up
    161    \returns the index in the array, -1 if not found
     159 * gets back the index of the entry in the array. value check
     160 * @param entry: the entry to look up
     161 * @returns the index in the array, -1 if not found
    162162 */
    163163template<class T>
    … …  
    176176
    177177/**
    178    \brief Simple debug info about the Array
     178 * Simple debug info about the Array
    179179*/
    180180template<class T>

  • orxonox/trunk/src/lib/graphics/importer/material.cc

    r4834 r4836  
    2525#include <string.h>
    2626
    27 //! \todo check if we are in RESOURCE MANAGER-mode
     27//! @todo check if we are in RESOURCE MANAGER-mode
    2828#include "resource_manager.h"
    2929
    … …  
    3131
    3232/**
    33    \brief creates a Material.
    34    \param mtlName Name of the Material to be added to the Material List
     33 * creates a Material.
     34 * @param mtlName Name of the Material to be added to the Material List
    3535*/
    3636Material::Material (const char* mtlName)
    … …  
    5252
    5353/**
    54     \brief deletes a Material
     54  * deletes a Material
    5555*/
    5656Material::~Material()
    … …  
    6767
    6868/**
    69    \brief sets the material with which the following Faces will be painted
     69 * sets the material with which the following Faces will be painted
    7070*/
    7171bool Material::select ()
    … …  
    9999
    100100  // setting illumination Model
    101   if (this->illumModel == 1) //! \todo make this work, if no vertex-normals are read.
     101  if (this->illumModel == 1) //! @todo make this work, if no vertex-normals are read.
    102102    glShadeModel(GL_FLAT);
    103103  else if (this->illumModel >= 2)
    … …  
    124124
    125125/**
    126    \brief Sets the Material Illumination Model.
    127    \brief illu illumination Model in int form
     126 * Sets the Material Illumination Model.
     127 * illu illumination Model in int form
    128128*/
    129129void Material::setIllum (int illum)
    … …  
    133133}
    134134/**
    135    \brief Sets the Material Illumination Model.
    136    \brief illu illumination Model in char* form
     135 * Sets the Material Illumination Model.
     136 * illu illumination Model in char* form
    137137*/void Material::setIllum (char* illum)
    138138{
    … …  
    141141
    142142/**
    143    \brief Sets the Material Diffuse Color.
    144    \param r Red Color Channel.
    145    \param g Green Color Channel.
    146    \param b Blue Color Channel.
     143 * Sets the Material Diffuse Color.
     144 * @param r Red Color Channel.
     145 * @param g Green Color Channel.
     146 * @param b Blue Color Channel.
    147147*/
    148148void Material::setDiffuse (float r, float g, float b)
    … …  
    156156}
    157157/**
    158    \brief Sets the Material Diffuse Color.
    159    \param rgb The red, green, blue channel in char format (with spaces between them)
     158 * Sets the Material Diffuse Color.
     159 * @param rgb The red, green, blue channel in char format (with spaces between them)
    160160*/
    161161void Material::setDiffuse (char* rgb)
    … …  
    167167
    168168/**
    169    \brief Sets the Material Ambient Color.
    170    \param r Red Color Channel.
    171    \param g Green Color Channel.
    172    \param b Blue Color Channel.
     169 * Sets the Material Ambient Color.
     170 * @param r Red Color Channel.
     171 * @param g Green Color Channel.
     172 * @param b Blue Color Channel.
    173173*/
    174174void Material::setAmbient (float r, float g, float b)
    … …  
    181181}
    182182/**
    183    \brief Sets the Material Ambient Color.
    184    \param rgb The red, green, blue channel in char format (with spaces between them)
     183 * Sets the Material Ambient Color.
     184 * @param rgb The red, green, blue channel in char format (with spaces between them)
    185185*/
    186186void Material::setAmbient (char* rgb)
    … …  
    192192
    193193/**
    194    \brief Sets the Material Specular Color.
    195    \param r Red Color Channel.
    196    \param g Green Color Channel.
    197    \param b Blue Color Channel.
     194 * Sets the Material Specular Color.
     195 * @param r Red Color Channel.
     196 * @param g Green Color Channel.
     197 * @param b Blue Color Channel.
    198198*/
    199199void Material::setSpecular (float r, float g, float b)
    … …  
    206206 }
    207207/**
    208    \brief Sets the Material Specular Color.
    209    \param rgb The red, green, blue channel in char format (with spaces between them)
     208 * Sets the Material Specular Color.
     209 * @param rgb The red, green, blue channel in char format (with spaces between them)
    210210*/
    211211void Material::setSpecular (char* rgb)
    … …  
    217217
    218218/**
    219    \brief Sets the Material Shininess.
    220    \param shini stes the Shininess from float.
     219 * Sets the Material Shininess.
     220 * @param shini stes the Shininess from float.
    221221*/
    222222void Material::setShininess (float shini)
    … …  
    225225}
    226226/**
    227    \brief Sets the Material Shininess.
    228    \param shini stes the Shininess from char*.
     227 * Sets the Material Shininess.
     228 * @param shini stes the Shininess from char*.
    229229*/
    230230void Material::setShininess (char* shini)
    … …  
    234234
    235235/**
    236    \brief Sets the Material Transparency.
    237    \param trans stes the Transparency from int.
     236 * Sets the Material Transparency.
     237 * @param trans stes the Transparency from int.
    238238*/
    239239void Material::setTransparency (float trans)
    … …  
    243243}
    244244/**
    245    \brief Sets the Material Transparency.
    246    \param trans stes the Transparency from char*.
     245 * Sets the Material Transparency.
     246 * @param trans stes the Transparency from char*.
    247247*/
    248248void Material::setTransparency (char* trans)
    … …  
    252252
    253253/**
    254    \brief Adds a Texture Path to the List of already existing Paths
    255    \param pathName The Path to add.
     254 * Adds a Texture Path to the List of already existing Paths
     255 * @param pathName The Path to add.
    256256*/
    257257void Material::addTexturePath(const char* pathName)
    … …  
    263263
    264264/**
    265    \brief Sets the Materials Diffuse Map
    266    \param dMap the Name of the Image to Use
     265 * Sets the Materials Diffuse Map
     266 * @param dMap the Name of the Image to Use
    267267*/
    268268void Material::setDiffuseMap(const char* dMap)
    … …  
    281281
    282282/**
    283    \brief Sets the Materials Ambient Map
    284    \param aMap the Name of the Image to Use
    285    \todo implement this
     283 * Sets the Materials Ambient Map
     284 * @param aMap the Name of the Image to Use
     285   @todo implement this
    286286*/
    287287void Material::setAmbientMap(const char* aMap)
    … …  
    292292
    293293/**
    294    \brief Sets the Materials Specular Map
    295    \param sMap the Name of the Image to Use
    296    \todo implement this
     294 * Sets the Materials Specular Map
     295 * @param sMap the Name of the Image to Use
     296   @todo implement this
    297297*/
    298298void Material::setSpecularMap(const char* sMap)
    … …  
    303303
    304304/**
    305    \brief Sets the Materials Bumpiness
    306    \param bump the Name of the Image to Use
    307    \todo implemet this
     305 * Sets the Materials Bumpiness
     306 * @param bump the Name of the Image to Use
     307   @todo implemet this
    308308*/
    309309void Material::setBump(const char* bump)

  • orxonox/trunk/src/lib/graphics/importer/material.h

    r4746 r4836  
    22  \file material.h
    33  \brief Contains the Material Class that handles Material for 3D-Objects.
    4   \todo free SDL-surface when deleting Material.
    5   \todo delete imgNameWithPath after use creation.
     4  @todo free SDL-surface when deleting Material.
     5  @todo delete imgNameWithPath after use creation.
    66*/
    77

  • orxonox/trunk/src/lib/graphics/importer/md2Model.cc

    r4787 r4836  
    101101
    102102/**
    103    \brief initializes an array of vert with the current frame scaled vertices
    104    \param verticesList: the list of vertices to interpolate between
     103 * initializes an array of vert with the current frame scaled vertices
     104 * @param verticesList: the list of vertices to interpolate between
    105105
    106106   we won't use the pVertices array directly, since its much easier and we need
    … …  
    126126/**
    127127  \brief sets the animation type
    128   \param type: animation type
     128* @param type: animation type
    129129
    130130  the animation types can be looked up in the animationType table
    … …  
    150150/**
    151151  \brief sets the time in seconds passed since the last tick
    152   \param time: in sec
     152* @param time: in sec
    153153*/
    154154void MD2Model::tick(float time)
    … …  
    320320/**
    321321  \brief this will load the whole model data (vertices, opengl command list, ...)
    322   \param fileName: the name of the model file
     322* @param fileName: the name of the model file
    323323  \return true if success
    324324*/
    … …  
    418418/**
    419419  \brief loads the skin/material stuff
    420   \param fileName: name of the skin file
     420* @param fileName: name of the skin file
    421421  \return true if success
    422422*/

  • orxonox/trunk/src/lib/graphics/importer/md2Model.h

    r4787 r4836  
    11/*!
    22    \file md2Model.h
    3     \brief Definition of an MD2 Model, a model format invented by ID Software.
     3  * Definition of an MD2 Model, a model format invented by ID Software.
    44
    55    We are deeply thankfull for all the wunderfull things id software made for us gamers!
    … …  
    142142  void setAnim(int type);
    143143  /**
    144      \brief scales the current model
    145      \param scaleFactor: the factor [0..1] to use for scaling
     144   * scales the current model
     145   * @param scaleFactor: the factor [0..1] to use for scaling
    146146  */
    147147  void scaleModel(float scaleFactor) { this->scaleFactor = scaleFactor;}

  • orxonox/trunk/src/lib/graphics/importer/model.cc

    r4834 r4836  
    3333////////////////////
    3434/**
    35    \brief creates a new ModelFaceElement
     35 * creates a new ModelFaceElement
    3636*/
    3737ModelFaceElement::ModelFaceElement()
    … …  
    4545
    4646/**
    47    \brief destroys a ModelFaceElement
     47 * destroys a ModelFaceElement
    4848*/
    4949ModelFaceElement::~ModelFaceElement()
    … …  
    5454
    5555/**
    56    \brief creates a new ModelFace
     56 * creates a new ModelFace
    5757*/
    5858ModelFace::ModelFace()
    … …  
    6969
    7070/**
    71    \brief deletes a ModelFace
     71 * deletes a ModelFace
    7272*/
    7373ModelFace::~ModelFace()
    … …  
    8383
    8484/**
    85    \brief Creates a new ModelGroup
     85 * Creates a new ModelGroup
    8686*/
    8787ModelGroup::ModelGroup()
    … …  
    9898
    9999/**
    100    \brief deletes a ModelGroup
     100 * deletes a ModelGroup
    101101*/
    102102ModelGroup::~ModelGroup()
    … …  
    111111
    112112/**
    113    \brief cleans up a ModelGroup
     113 * cleans up a ModelGroup
    114114
    115115   actually does the same as the delete Operator, but does not delete the predecessing group
    … …  
    130130/////////////
    131131/**
    132    \brief Creates a 3D-Model.
     132 * Creates a 3D-Model.
    133133
    134134   assigns it a Name and a Type
    … …  
    166166
    167167/**
    168    \brief deletes an Model.
     168 * deletes an Model.
    169169
    170170   Looks if any from model allocated space is still in use, and if so deleted it.
    … …  
    206206
    207207/**
    208    \brief Finalizes an Object. This can be done outside of the Class.
     208 * Finalizes an Object. This can be done outside of the Class.
    209209*/
    210210void Model::finalize()
    … …  
    237237//////////
    238238/**
    239    \brief Draws the Models of all Groups.
     239 * Draws the Models of all Groups.
    240240   It does this by just calling the Lists that must have been created earlier.
    241241*/
    … …  
    280280
    281281/**
    282    \brief Draws the Model number groupNumber
    283    \param groupNumber The number of the group that will be displayed.
     282 * Draws the Model number groupNumber
     283 * @param groupNumber The number of the group that will be displayed.
    284284
    285285   It does this by just calling the List that must have been created earlier.
    … …  
    312312
    313313/**
    314    \brief Draws the Model with a specific groupName
    315    \param groupName The name of the group that will be displayed.
     314 * Draws the Model with a specific groupName
     315 * @param groupName The name of the group that will be displayed.
    316316
    317317   It does this by just calling the List that must have been created earlier.
    … …  
    339339//////////
    340340/**
    341    \brief deletes all the arrays
     341 * deletes all the arrays
    342342*/
    343343bool Model::deleteArrays()
    … …  
    359359
    360360/**
    361    \brief finalizes an Model.
     361 * finalizes an Model.
    362362 * This funcion is needed, to delete all the Lists, and arrays that are no more
    363363 * needed because they are already imported into openGL.
    … …  
    375375//////////
    376376/**
    377    \brief adds a new Material to the Material List
    378    \param material the Material to add
    379    \returns the added material
     377 * adds a new Material to the Material List
     378 * @param material the Material to add
     379 * @returns the added material
    380380 *
    381381 * this also tells this Model, that all the Materials are handled externally
    … …  
    391391
    392392/**
    393    \brief adds a new Material to the Material List
    394    \param materialName the name of the Material to add
    395    \returns the added material
     393 * adds a new Material to the Material List
     394 * @param materialName the name of the Material to add
     395 * @returns the added material
    396396*/
    397397Material* Model::addMaterial(const char* materialName)
    … …  
    406406
    407407/**
    408    \brief finds a Material by its name and returns it
    409    \param materialName the Name of the material to search for.
    410    \returns the Material if found, NULL otherwise
     408 * finds a Material by its name and returns it
     409 * @param materialName the Name of the material to search for.
     410 * @returns the Material if found, NULL otherwise
    411411*/
    412412Material* Model::findMaterialByName(const char* materialName)
    … …  
    428428
    429429/**
    430    \brief parses a group String
    431    \param groupString the new Group to create
     430 * parses a group String
     431 * @param groupString the new Group to create
    432432
    433433   This function initializes a new Group.
    … …  
    452452
    453453/**
    454    \brief parses a vertex-String
    455    \param vertexString The String that will be parsed.
     454 * parses a vertex-String
     455 * @param vertexString The String that will be parsed.
    456456
    457457   If a vertex line is found this function will inject it into the vertex-Array
    … …  
    470470
    471471/**
    472    \brief parses a vertex-String
    473    \param x the X-coordinate of the Vertex to add.
    474    \param y the Y-coordinate of the Vertex to add.
    475    \param z the Z-coordinate of the Vertex to add.
     472 * parses a vertex-String
     473 * @param x the X-coordinate of the Vertex to add.
     474 * @param y the Y-coordinate of the Vertex to add.
     475 * @param z the Z-coordinate of the Vertex to add.
    476476
    477477*/
    … …  
    485485
    486486/**
    487    \brief parses a vertexNormal-String
    488    \param normalString The String that will be parsed.
     487 * parses a vertexNormal-String
     488 * @param normalString The String that will be parsed.
    489489
    490490   If a vertexNormal line is found this function will inject it into the vertexNormal-Array
    … …  
    503503
    504504/**
    505    \brief adds a VertexNormal.
    506    \param x The x coordinate of the Normal.
    507    \param y The y coordinate of the Normal.
    508    \param z The z coordinate of the Normal.
     505 * adds a VertexNormal.
     506 * @param x The x coordinate of the Normal.
     507 * @param y The y coordinate of the Normal.
     508 * @param z The z coordinate of the Normal.
    509509
    510510   If a vertexNormal line is found this function will inject it into the vertexNormal-Array
    … …  
    519519
    520520/**
    521    \brief parses a vertexTextureCoordinate-String
    522    \param vTextureString The String that will be parsed.
     521 * parses a vertexTextureCoordinate-String
     522 * @param vTextureString The String that will be parsed.
    523523
    524524   If a vertexTextureCoordinate line is found,
    … …  
    540540
    541541/**
    542    \brief adds a Texture Coordinate
    543    \param u The u coordinate of the TextureCoordinate.
    544    \param v The y coordinate of the TextureCoordinate.
     542 * adds a Texture Coordinate
     543 * @param u The u coordinate of the TextureCoordinate.
     544 * @param v The y coordinate of the TextureCoordinate.
    545545
    546546   If a TextureCoordinate line is found this function will inject it into the TextureCoordinate-Array
    … …  
    556556
    557557/**
    558    \brief parses a face-string
    559    \param faceString The String that will be parsed.
     558 * parses a face-string
     559 * @param faceString The String that will be parsed.
    560560
    561561   If a face line is found this function will add it to the glList.
    … …  
    615615
    616616/**
    617    \brief adds a new Face
    618    \param faceElemCount the number of Vertices to add to the Face.
    619    \param type The information Passed with each Vertex
     617 * adds a new Face
     618 * @param faceElemCount the number of Vertices to add to the Face.
     619 * @param type The information Passed with each Vertex
    620620*/
    621621bool Model::addFace(int faceElemCount, VERTEX_FORMAT type, ...)
    … …  
    648648
    649649/**
    650    \brief Function that selects a material, if changed in the obj file.
    651    \param matString the Material that will be set.
     650 * Function that selects a material, if changed in the obj file.
     651 * @param matString the Material that will be set.
    652652*/
    653653bool Model::setMaterial(const char* matString)
    … …  
    663663
    664664/**
    665    \brief Function that selects a material, if changed in the obj file.
    666    \param mtl the Material that will be set.
     665 * Function that selects a material, if changed in the obj file.
     666 * @param mtl the Material that will be set.
    667667*/
    668668bool Model::setMaterial(Material* mtl)
    … …  
    678678
    679679/**
    680    \brief A routine that is able to create normals.
     680 * A routine that is able to create normals.
    681681
    682682   The algorithm does the following:
    … …  
    757757////////////
    758758/**
    759    \brief reads and includes the Faces/Materials into the openGL state Machine
     759 * reads and includes the Faces/Materials into the openGL state Machine
    760760*/
    761761bool Model::importToDisplayList()
    … …  
    849849
    850850/**
    851    \brief reads and includes the Faces/Materials into the openGL state Machine
     851 * reads and includes the Faces/Materials into the openGL state Machine
    852852*/
    853853bool Model::importToVertexArray()
    … …  
    869869
    870870/**
    871    \brief builds an array of triangles, that can later on be used for obb separation and octree separation
     871 * builds an array of triangles, that can later on be used for obb separation and octree separation
    872872 */
    873873bool Model::buildTriangleList()
    … …  
    993993
    994994/**
    995    \brief Adds a Face-element (one vertex of a face) with all its information.
    996    \param elem The FaceElement to add to the OpenGL-environment.
     995 * Adds a Face-element (one vertex of a face) with all its information.
     996 * @param elem The FaceElement to add to the OpenGL-environment.
    997997
    998998   It does this by searching:
    … …  
    10341034
    10351035/**
    1036    \brief Includes a default model
     1036 * Includes a default model
    10371037
    10381038   This will inject a Cube, because this is the most basic model.

  • orxonox/trunk/src/lib/graphics/importer/model.h

    r4834 r4836  
    2424   MODEL_DISPLAY_LIST means, that a DisplayList will be built out of the model. This model will be STATIC, meaning it cannot be changed after initialisation.
    2525   MODEL_VERTEX_ARRAY means, that a VertexArray will be built out of the model. This moel will be DYNAMIX, meaning that one can change the properties from outside of the model.
    26  * \todo implement this stuff
     26 * @todo implement this stuff
    2727*/
    2828typedef enum MODEL_TYPE {
    … …  
    9090  ModelFace*   firstFace;      //!< The first Face in this group.
    9191  ModelFace*   currentFace;    //!< The current Face in this Group (the one we are currently working with.)
    92   int          faceMode;       //!< The Mode the Face is in: initially -1, 0 for FaceList opened, 1 for Material,  3 for triangle, 4 for Quad, 5+ for Poly \todo ENUM...
     92  int          faceMode;       //!< The Mode the Face is in: initially -1, 0 for FaceList opened, 1 for Material,  3 for triangle, 4 for Quad, 5+ for Poly @todo ENUM...
    9393  int          faceCount;      //!< The Number of Faces this Group holds.
    9494
    … …  
    111111  void draw(char* groupName) const;
    112112
    113   /** \returns Count of the Models (Groups) in this File */
     113  /** @returns Count of the Models (Groups) in this File */
    114114  inline int getGroupCount() const { return this->groupCount; };
    115115
    116   /** \returns a Pointer to the Vertex-Array, if it was deleted it returns NULL */
     116  /** @returns a Pointer to the Vertex-Array, if it was deleted it returns NULL */
    117117  inline const GLfloat* getVertexArray() const { return this->vertices->getArray(); };
    118   /** \returns the VertexCount of this Model */
     118  /** @returns the VertexCount of this Model */
    119119  inline unsigned int getVertexCount() const { return this->vertexCount; };
    120120
    121   /** \returns a Pointer to the Normals-Array, if it was deleted it returns NULL */
     121  /** @returns a Pointer to the Normals-Array, if it was deleted it returns NULL */
    122122  inline const GLfloat* getNormalsArray() const { return this->normals->getArray(); };
    123   /** \returns the NormalsCount of this Model */
     123  /** @returns the NormalsCount of this Model */
    124124  inline unsigned int getNormalsCount() const { return this->normalCount; };
    125125
    126   /** \returns a Pointer to the TexCoord-Array, if it was deleted it returns NULL */
     126  /** @returns a Pointer to the TexCoord-Array, if it was deleted it returns NULL */
    127127  inline const GLfloat* getTexCoordArray() const { return this->vTexture->getArray(); };
    128   /** \returns the TexCoord-Count of this Model */
     128  /** @returns the TexCoord-Count of this Model */
    129129  inline unsigned int getTexCoordCount() const { return this->texCoordCount; };
    130130
    131   /** \returns the Count of Faces of this Model */
     131  /** @returns the Count of Faces of this Model */
    132132  inline unsigned int getFaceCount() const { return this->faceCount; };
    133133
    … …  
    157157
    158158 protected:
    159   float            scaleFactor;     //!< The Factor with which the Model should be scaled. \todo maybe one wants to scale the Model after Initialisation
     159  float            scaleFactor;     //!< The Factor with which the Model should be scaled. @todo maybe one wants to scale the Model after Initialisation
    160160
    161161 private:

  • orxonox/trunk/src/lib/graphics/importer/objModel.cc

    r4371 r4836  
    2828
    2929/**
    30    \brief Crates a 3D-Model, loads in a File and scales it.
    31    \param fileName file to parse and load (must be a .obj file)
    32    \param scaling The factor that the model will be scaled with.
     30 * Crates a 3D-Model, loads in a File and scales it.
     31 * @param fileName file to parse and load (must be a .obj file)
     32 * @param scaling The factor that the model will be scaled with.
    3333*/
    3434OBJModel::OBJModel(const char* fileName, float scaling) : Model(fileName)
    … …  
    4444
    4545/**
    46    \brief deletes an OBJModel.
     46 * deletes an OBJModel.
    4747
    4848   Looks if any from model allocated space is still in use, and if so deleted it.
    … …  
    5656
    5757/**
    58    \brief Imports a obj file and handles the the relative location
    59    \param fileName The file to import
     58 * Imports a obj file and handles the the relative location
     59 * @param fileName The file to import
    6060
    6161   Splits the FileName from the DirectoryName
    … …  
    8686
    8787/**
    88    \brief Reads in the .obj File and sets all the Values.
     88 * Reads in the .obj File and sets all the Values.
    8989   This function does read the file, parses it for the occurence of things like vertices, faces and so on, and executes the specific tasks
    9090*/
    … …  
    143143          this->addGroup (buffer+2);
    144144        }
    145       else if (!strncmp(buffer, "s ", 2)) //! \todo smoothing groups have to be implemented
     145      else if (!strncmp(buffer, "s ", 2)) //! @todo smoothing groups have to be implemented
    146146        {
    147147          PRINTF(2)("smoothing groups not supportet yet. line: %s\n", buffer);
    … …  
    153153
    154154/**
    155     \brief Function to read in a mtl File.
    156     \param mtlFile The .mtl file to read
     155  * Function to read in a mtl File.
     156  * @param mtlFile The .mtl file to read
    157157
    158158    This Function parses all Lines of an mtl File.

  • orxonox/trunk/src/lib/graphics/importer/primitive_model.cc

    r4678 r4836  
    2525
    2626/**
    27    \brief Creates a 3D-Model of Primitive-Type type
     27 * Creates a 3D-Model of Primitive-Type type
    2828
    2929   if you want to just display a Cube/Sphere/Cylinder/... without any material.
    3030
    31    \todo implement Cube/Sphere/Cylinder/...
     31   @todo implement Cube/Sphere/Cylinder/...
    3232*/
    3333PrimitiveModel::PrimitiveModel(PRIMITIVE type, float size, unsigned int detail)
    … …  
    5656
    5757/**
    58    \brief standard deconstructor
     58 * standard deconstructor
    5959
    6060*/
    … …  
    6565
    6666/**
    67    \brief Builds a Sphere into the Model.
    68    \param size The diameter of the Sphere.
    69    \param detail The detail of the Sphere.
     67 * Builds a Sphere into the Model.
     68 * @param size The diameter of the Sphere.
     69 * @param detail The detail of the Sphere.
    7070*/
    7171void PrimitiveModel::sphereModel(float size, unsigned int detail)
    … …  
    132132}
    133133/**
    134    \brief Creates a Cylinder.
     134 * Creates a Cylinder.
    135135*/
    136136void PrimitiveModel::cylinderModel(float size, unsigned int detail)
    … …  
    173173
    174174/**
    175    \brief creates a cone inside of this Model
    176    \param size The size of the cone
    177    \param detail the Detail-level of this cone
     175 * creates a cone inside of this Model
     176 * @param size The size of the cone
     177 * @param detail the Detail-level of this cone
    178178*/
    179179void PrimitiveModel::coneModel(float size, unsigned int detail)
    … …  
    209209
    210210/**
    211    \brief creates a Plane inside of this Model
    212    \param size The size of this plane
    213    \param detail the Detail-level of this plane.
     211 * creates a Plane inside of this Model
     212 * @param size The size of this plane
     213 * @param detail the Detail-level of this plane.
    214214*/
    215215void PrimitiveModel::planeModel(float size, unsigned int detail)

  • orxonox/trunk/src/lib/graphics/importer/primitive_model.h

    r4468 r4836  
    11/*!
    22    \file primitive_model.h
    3     \brief a Class to handle different simple models like planes cubes spheres and so on.
     3  * a Class to handle different simple models like planes cubes spheres and so on.
    44    (cube is also an option of Model, but is extended here.
    55*/

  • orxonox/trunk/src/lib/graphics/importer/texture.cc

    r4746 r4836  
    2828
    2929/**
    30    \brief Constructor for a Texture
     30 * Constructor for a Texture
    3131*/
    3232Texture::Texture(const char* imageName)
    … …  
    3939
    4040/**
    41    \brief Destructor of a Texture
     41 * Destructor of a Texture
    4242
    4343   Frees Data, and deletes the textures from GL
    … …  
    5050
    5151/**
    52    \brief Loads a Texture to the openGL-environment.
    53    \param surface the Image to load to openGL
    54    \returns The ID of the texture.
     52 * Loads a Texture to the openGL-environment.
     53 * @param surface the Image to load to openGL
     54 * @returns The ID of the texture.
    5555*/
    5656GLuint Texture::loadTexToGL (SDL_Surface* surface)
    … …  
    139139
    140140/**
    141    \brief loads an Image from a file to a Texture
    142    \param imageName The image to load
     141 * loads an Image from a file to a Texture
     142 * @param imageName The image to load
    143143*/
    144144bool Texture::loadImage(const char* imageName)

  • orxonox/trunk/src/lib/graphics/importer/texture.h

    r4746 r4836  
    33  \brief Contains the texture class, that handles the reading of Images into Texutre-files.
    44
    5   \todo procedural textures
     5  @todo procedural textures
    66*/
    77
    … …  
    2727  ~Texture();
    2828
    29   /** \returns The textureID of this texture.  */
     29  /** @returns The textureID of this texture.  */
    3030  inline GLuint getTexture() {return this->texture;}
    3131  GLuint loadTexToGL (SDL_Surface* surface);
    32   /** \returns true if texture has alpha, false otherwise */
     32  /** @returns true if texture has alpha, false otherwise */
    3333  inline bool hasAlpha() const {return bAlpha;}
    3434

  • orxonox/trunk/src/lib/graphics/light.cc

    r4746 r4836  
    4545
    4646/**
    47  * \param root The XML-element to load the Light from
    48 
    49   \todo what to do, if no Light-Slots are open anymore ???
     47 * @param root The XML-element to load the Light from
     48
     49  @todo what to do, if no Light-Slots are open anymore ???
    5050 */
    5151 Light::Light(const TiXmlElement* root)
    … …  
    7171
    7272/**
    73    \brief destroys a Light
     73 * destroys a Light
    7474*/
    7575Light::~Light()
    … …  
    8181
    8282/**
    83  * \param root The XML-element to load the Light from
     83 * @param root The XML-element to load the Light from
    8484 */
    8585void Light::loadParams(const TiXmlElement* root)
    … …  
    104104
    105105/**
    106    \brief sets an emitting Diffuse color of this Light
    107    \param r red
    108    \param g green
    109    \param b blue
     106 * sets an emitting Diffuse color of this Light
     107 * @param r red
     108 * @param g green
     109 * @param b blue
    110110*/
    111111void Light::setDiffuseColor(GLfloat r, GLfloat g, GLfloat b)
    … …  
    120120
    121121/**
    122    \brief sets an emitting Specular color of this Light
    123    \param r red
    124    \param g green
    125    \param b blue
     122 * sets an emitting Specular color of this Light
     123 * @param r red
     124 * @param g green
     125 * @param b blue
    126126*/
    127127void Light::setSpecularColor(GLfloat r, GLfloat g, GLfloat b)
    … …  
    137137
    138138/**
    139    \brief Sets the AttenuationType of this Light Source
    140    \param constantAttenuation The Constant Attenuation of the Light
    141    \param linearAttenuation The Linear Attenuation of the Light
    142    \param quadraticAttenuation The Quadratic Attenuation of the Light
     139 * Sets the AttenuationType of this Light Source
     140 * @param constantAttenuation The Constant Attenuation of the Light
     141 * @param linearAttenuation The Linear Attenuation of the Light
     142 * @param quadraticAttenuation The Quadratic Attenuation of the Light
    143143*/
    144144void Light::setAttenuation(float constantAttenuation, float linearAttenuation, float quadraticAttenuation)
    … …  
    155155
    156156/**
    157    \brief stets the direction of the Spot Light.
    158    \param direction The direction of the Spot Light.
     157 * stets the direction of the Spot Light.
     158 * @param direction The direction of the Spot Light.
    159159*/
    160160void Light::setSpotDirection(const Vector& direction)
    … …  
    169169
    170170/**
    171    \brief sets the cutoff angle of the Light.
    172    \param cutoff The cutoff angle.
     171 * sets the cutoff angle of the Light.
     172 * @param cutoff The cutoff angle.
    173173*/
    174174void Light::setSpotCutoff(GLfloat cutoff)
    … …  
    179179
    180180/**
    181    \brief draws this Light. Being a World-entity the possibility to do this lies at hand.
     181 * draws this Light. Being a World-entity the possibility to do this lies at hand.
    182182*/
    183183void Light::draw() const
    … …  
    190190
    191191/**
    192    \brief Prints out some nice formated debug information about the Light
     192 * Prints out some nice formated debug information about the Light
    193193*/
    194194void Light::debug() const
    … …  
    213213******************/
    214214/**
    215    \brief standard constructor for a Light
     215 * standard constructor for a Light
    216216*/
    217217LightManager::LightManager ()
    … …  
    228228
    229229/**
    230    \brief standard deconstructor
     230 * standard deconstructor
    231231
    232232   first disables Lighting
    … …  
    248248
    249249/**
    250    \brief singleton-Reference to the Light-class
     250 * singleton-Reference to the Light-class
    251251*/
    252252LightManager* LightManager::singletonRef = NULL;
    253253
    254254/**
    255   \param root the XML-element to load the LightManager's settings from
     255* @param root the XML-element to load the LightManager's settings from
    256256 */
    257257void LightManager::loadParams(const TiXmlElement* root)
    … …  
    265265
    266266/**
    267   \param root The XML-element to load Lights from
     267* @param root The XML-element to load Lights from
    268268 */
    269269void LightManager::loadLights(const TiXmlElement* root)
    … …  
    281281// set Attributes
    282282/**
    283    \brief sets the ambient Color of the Scene
    284    \param r red
    285    \param g green
    286    \param b blue
     283 * sets the ambient Color of the Scene
     284 * @param r red
     285 * @param g green
     286 * @param b blue
    287287*/
    288288void LightManager::setAmbientColor(GLfloat r, GLfloat g, GLfloat b)
    … …  
    297297
    298298/**
    299   \param light the Light to register to the LightManager
     299* @param light the Light to register to the LightManager
    300300
    301301  This is done explicitely by the constructor of a Light
    … …  
    314314
    315315/**
    316   \param light The light to unregister from the LightManager
     316* @param light The light to unregister from the LightManager
    317317
    318318  This is done every time a Light is destroyed explicitely by the Light-destructor
    … …  
    333333
    334334/**
    335    \brief draws all the Lights in their appropriate position
     335 * draws all the Lights in their appropriate position
    336336 */
    337337void LightManager::draw() const
    … …  
    346346
    347347/**
    348    \brief outputs debug information about the Class and its lights
     348 * outputs debug information about the Class and its lights
    349349*/
    350350void LightManager::debug() const

  • orxonox/trunk/src/lib/graphics/light.h

    r4746 r4836  
    11/*!
    22    \file light.h
    3     \brief Handles Lights.
     3  * Handles Lights.
    44
    55    A Light is one of the more important things in a 3D-environment,
    … …  
    3838  void setSpotCutoff(GLfloat cutoff);
    3939
    40   /** \returns the lightNumber*/
     40  /** @returns the lightNumber*/
    4141  int getLightNumber() const {return this->lightNumber;}
    4242
    … …  
    9292 public:
    9393  virtual ~LightManager();
    94   /** \returns a Pointer to the only object of this Class */
     94  /** @returns a Pointer to the only object of this Class */
    9595  inline static LightManager* getInstance() { if (!singletonRef) singletonRef = new LightManager();  return singletonRef; };
    9696

  • orxonox/trunk/src/lib/graphics/spatial_separation/quadtree.cc

    r4819 r4836  
    2222
    2323/**
    24    \brief standard constructor
    25    \todo this constructor is not jet implemented - do it
     24 * standard constructor
     25   @todo this constructor is not jet implemented - do it
    2626*/
    2727Quadtree::Quadtree (modelInfo* pModelInfo)
    … …  
    3333
    3434/**
    35    \brief standard deconstructor
     35 * standard deconstructor
    3636
    3737*/
    … …  
    4343
    4444/**
    45    \brief gives the signal to separate the model into a quadtree
     45 * gives the signal to separate the model into a quadtree
    4646 */
    4747void Quadtree::separate()
    … …  
    5050
    5151/**
    52    \brief draws the debug quadtree boxes around the model
     52 * draws the debug quadtree boxes around the model
    5353 */
    5454void Quadtree::drawTree(int depth, int drawMode) const

  • orxonox/trunk/src/lib/graphics/spatial_separation/quadtree.h

    r4819 r4836  
    11/*!
    22    \file quadtree.h
    3     \brief Definition of a spatial data separation using quadtree
     3  * Definition of a spatial data separation using quadtree
    44
    55*/

  • orxonox/trunk/src/lib/graphics/spatial_separation/quadtree_node.cc

    r4819 r4836  
    2222
    2323/**
    24    \brief standard constructor
     24 * standard constructor
    2525*/
    2626QuadtreeNode::QuadtreeNode (sTriangleExt* triangles, int numTriangles, Quadtree* quadtree)
    … …  
    3131
    3232/**
    33    \brief standard deconstructor
     33 * standard deconstructor
    3434
    3535*/
    … …  
    4141
    4242/**
    43    \brief gives the signal to separate the model into a quadtree
    44    \param treeDepth the max depth, the steps to go if treeDept == 0 leaf reached
     43 * gives the signal to separate the model into a quadtree
     44 * @param treeDepth the max depth, the steps to go if treeDept == 0 leaf reached
    4545 */
    4646void QuadtreeNode::separateNode(int treeDepth)
    … …  
    4949
    5050/**
    51    \brief gives the signal to separate the model into a quadtree
    52    \param treeDepth the max depth, the steps to go if treeDept == 0 leaf reached
     51 * gives the signal to separate the model into a quadtree
     52 * @param treeDepth the max depth, the steps to go if treeDept == 0 leaf reached
    5353*/
    5454void QuadtreeNode::separateNode(float minLength)
    … …  
    5757
    5858/**
    59    \brief draws the debug quadtree boxes around the model
     59 * draws the debug quadtree boxes around the model
    6060 */
    6161void QuadtreeNode::drawTree(int depth, int drawMode) const

  • orxonox/trunk/src/lib/graphics/spatial_separation/quadtree_node.h

    r4819 r4836  
    11/*!
    22    \file proto_class.h
    3     \brief Definition of ...
     3  * Definition of ...
    44
    55*/

  • orxonox/trunk/src/lib/graphics/spatial_separation/spatial_separation.cc

    r4819 r4836  
    2424
    2525/**
    26    \brief standard constructor
    27    \param model the model that is to be separated
    28    \param overlapSize each box will overlap for a given size
     26 * standard constructor
     27 * @param model the model that is to be separated
     28 * @param overlapSize each box will overlap for a given size
    2929
    3030   The boxes are overlaping because this makes collision detection a lot simpler
    … …  
    3838
    3939/**
    40    \brief standard constructor
    41    \param model the model that is to be separated
    42    \param overlapSize each box will overlap for a given size
     40 * standard constructor
     41 * @param model the model that is to be separated
     42 * @param overlapSize each box will overlap for a given size
    4343
    4444   The boxes are overlaping because this makes collision detection a lot simpler
    … …  
    5353
    5454/**
    55    \brief standard deconstructor
     55 * standard deconstructor
    5656
    5757*/
    … …  
    6363/**
    6464  \brief creates a quadtree
    65   \param model the model to do a quadtree on
    66   \param minLength the minimal length of a quadtree node
     65* @param model the model to do a quadtree on
     66* @param minLength the minimal length of a quadtree node
    6767  \return the new quadtree
    6868 */
    … …  
    7676/**
    7777  \brief creates a quadtree
    78   \param model the model to do a quadtree on
    79   \param minLength the minimal length of a quadtree node
     78* @param model the model to do a quadtree on
     79* @param minLength the minimal length of a quadtree node
    8080  \return the new quadtree
    8181 */
    … …  
    8888/**
    8989  \brief creates a quadtree
    90   \param model the model to do a quadtree on
    91   \param minLength the minimal length of a quadtree node
     90* @param model the model to do a quadtree on
     91* @param minLength the minimal length of a quadtree node
    9292  \return the new quadtree
    9393*/
    … …  
    103103/**
    104104  \brief gets the maximal dimension of a model
    105   \param playerModel the model that this measurement is based on
     105* @param playerModel the model that this measurement is based on
    106106  \return the maximal dimension of the model
    107107 */

  • orxonox/trunk/src/lib/graphics/spatial_separation/spatial_separation.h

    r4819 r4836  
    11/*!
    22    \file spatial_separation.h
    3     \brief Definition of the generic spatial separation process of model data
     3  * Definition of the generic spatial separation process of model data
    44
    55 */

  • orxonox/trunk/src/lib/graphics/text_engine.cc

    r4834 r4836  
    4242////////////
    4343/**
    44    \brief creates a new Text Element
    45    \param font the Font to render this text in
    46    \param type The renderType to display this font in
     44 * creates a new Text Element
     45 * @param font the Font to render this text in
     46 * @param type The renderType to display this font in
    4747
    4848   this constructor is private, because the user should initialize
    … …  
    6767
    6868/**
    69    \brief deletes a Text out of memory
     69 * deletes a Text out of memory
    7070
    7171   This also ereases the text from the textList of the TextEngine
    … …  
    7777
    7878/**
    79    \brief tells the Text, that it should folow a PNode
    80    \param bindNode: the node to bind this text to
     79 * tells the Text, that it should folow a PNode
     80 * @param bindNode: the node to bind this text to
    8181*/
    8282void Text::setBindNode(PNode* bindNode)
    … …  
    8686
    8787/**
    88    \brief sets the Type of this Text
    89    \param type the type to set.
     88 * sets the Type of this Text
     89 * @param type the type to set.
    9090*/
    9191void Text::setType(int type)
    … …  
    9898
    9999/**
    100    \brief Sets a new Text to the font
    101    \param text the new text to set
     100 * Sets a new Text to the font
     101 * @param text the new text to set
    102102*/
    103103void Text::setText(const char* text)
    … …  
    129129
    130130/**
    131    \brief sets a Position.
    132    \param x the x-position in pixels from the left border
    133    \param y the y-position in pixels from the top border
     131 * sets a Position.
     132 * @param x the x-position in pixels from the left border
     133 * @param y the y-position in pixels from the top border
    134134*/
    135135void Text::setPosition(int x, int y)
    … …  
    140140
    141141/**
    142    \brief sets the text-alignment
    143    \param alignment the alignment to set
     142 * sets the text-alignment
     143 * @param alignment the alignment to set
    144144*/
    145145void Text::setAlignment(TEXT_ALIGNMENT alignment)
    … …  
    149149
    150150/**
    151    \brief sets a new color to the font
    152    \param r Red
    153    \param g Green
    154    \param b Blue
     151 * sets a new color to the font
     152 * @param r Red
     153 * @param g Green
     154 * @param b Blue
    155155*/
    156156void Text::setColor(Uint8 r, Uint8 g, Uint8 b)
    … …  
    162162
    163163/**
    164    \brief creates a texture out of the given parameters
     164 * creates a texture out of the given parameters
    165165
    166166   this has to be called every time by the user, to if changes were made.
    … …  
    185185
    186186/**
    187    \brief draws the Font
     187 * draws the Font
    188188*/
    189189void Text::draw() const
    … …  
    269269
    270270/**
    271    \brief prints out some nice debug information about this text
     271 * prints out some nice debug information about this text
    272272*/
    273273void Text::debug() const
    … …  
    285285////////////
    286286/**
    287    \brief Loads a Font from an SDL_surface into a texture.
    288    \param surface The surface to make the texture of
    289    \param texCoord The texture coordinates of the 4 corners of the texture
    290    \returns the ID of the texture
     287 * Loads a Font from an SDL_surface into a texture.
     288 * @param surface The surface to make the texture of
     289 * @param texCoord The texture coordinates of the 4 corners of the texture
     290 * @returns the ID of the texture
    291291*/
    292292GLuint Text::loadTexture(SDL_Surface *surface, TexCoord* texCoord)
    … …  
    366366
    367367/**
    368    \brief Quick utility function for texture creation
    369    \param input an integer
    370    \returns the next bigger 2^n-integer than input
     368 * Quick utility function for texture creation
     369 * @param input an integer
     370 * @returns the next bigger 2^n-integer than input
    371371*/
    372372int Text::powerOfTwo(int input)
    … …  
    385385////////////
    386386/**
    387    \brief constructs a Font
    388    \param fontFile the File to load the font from
    389    \param fontSize the Size of the Font in Pixels
    390    \param r Red value of the Font.
    391    \param g Green value of the Font.
    392    \param b Blue value of the Font.
     387 * constructs a Font
     388 * @param fontFile the File to load the font from
     389 * @param fontSize the Size of the Font in Pixels
     390 * @param r Red value of the Font.
     391 * @param g Green value of the Font.
     392 * @param b Blue value of the Font.
    393393*/
    394394Font::Font(const char* fontFile, unsigned int fontSize, Uint8 r, Uint8 g, Uint8 b)
    … …  
    413413
    414414/**
    415    \brief destructs a font
     415 * destructs a font
    416416*/
    417417Font::~Font()
    … …  
    433433
    434434/**
    435    \brief sets The Font.
    436    \param fontFile The file containing the font.
    437    \returns true if loaded, false if something went wrong, or if a font was loaded before.
     435 * sets The Font.
     436 * @param fontFile The file containing the font.
     437 * @returns true if loaded, false if something went wrong, or if a font was loaded before.
    438438*/
    439439bool Font::setFont(const char* fontFile)
    … …  
    462462
    463463/**
    464    \brief sets a specific renderStyle
    465    \param renderStyle the Style to render: a char-array containing:
     464 * sets a specific renderStyle
     465 * @param renderStyle the Style to render: a char-array containing:
    466466   i: italic, b: bold, u, underline
    467467*/
    … …  
    485485
    486486/**
    487    \brief Sets a new Size to the font
    488    \param fontSize The new Size in pixels.
     487 * Sets a new Size to the font
     488 * @param fontSize The new Size in pixels.
    489489*/
    490490void Font::setSize(unsigned int fontSize)
    … …  
    494494
    495495/**
    496    \brief sets a new color to the font
    497    \param r Red
    498    \param g Green
    499    \param b Blue
     496 * sets a new color to the font
     497 * @param r Red
     498 * @param g Green
     499 * @param b Blue
    500500*/
    501501void Font::setFastColor(Uint8 r, Uint8 g, Uint8 b)
    … …  
    507507
    508508/**
    509    \returns the maximum height of the Font, if the font was initialized, 0 otherwise
     509 * @returns the maximum height of the Font, if the font was initialized, 0 otherwise
    510510*/
    511511int Font::getMaxHeight()
    … …  
    518518
    519519/**
    520    \returns the maximum ascent of the Font, if the font was initialized, 0 otherwise
     520 * @returns the maximum ascent of the Font, if the font was initialized, 0 otherwise
    521521
    522522   the ascent is the pixels of the font above the baseline
    … …  
    531531
    532532/**
    533    \returns the maximum descent of the Font, if the font was initialized, 0 otherwise
     533 * @returns the maximum descent of the Font, if the font was initialized, 0 otherwise
    534534
    535535   the descent is the pixels of the font below the baseline
    … …  
    544544
    545545/**
    546    \param character The character to get info about.
    547    \returns a Glyph struct of a character. This Glyph is a pointer,
     546 * @param character The character to get info about.
     547 * @returns a Glyph struct of a character. This Glyph is a pointer,
    548548   and MUST be deleted by the user..
    549549
    … …  
    581581
    582582  this->initGlyphs(32, numberOfGlyphs);
    583   this->glyphArray[32]->width = fontSize/3; //!< \todo find out the real size of a Space
     583  this->glyphArray[32]->width = fontSize/3; //!< @todo find out the real size of a Space
    584584
    585585  int rectSize = this->findOptimalFastTextureSize();
    … …  
    695695
    696696/**
    697    \brief stores Glyph Metrics in an Array.
    698    \param from The Glyph to start from.
    699    \param count The number of Glyphs to start From.
     697 * stores Glyph Metrics in an Array.
     698 * @param from The Glyph to start from.
     699 * @param count The number of Glyphs to start From.
    700700*/
    701701void Font::initGlyphs(Uint16 from, Uint16 count)
    … …  
    722722
    723723/**
    724    \returns the optimal size to use as the texture size
    725 
    726    \todo: this algorithm can be a lot more faster, althought it does
     724 * @returns the optimal size to use as the texture size
     725
     726   @todo: this algorithm can be a lot more faster, althought it does
    727727   not really matter within the init-context, and 128 glyphs.
    728728
    … …  
    773773
    774774/**
    775    \brief a simple function to get some interesting information about this class
     775 * a simple function to get some interesting information about this class
    776776*/
    777777void Font::debug()
    … …  
    800800///////////////////
    801801/**
    802    \brief standard constructor
     802 * standard constructor
    803803*/
    804804TextEngine::TextEngine ()
    … …  
    812812
    813813/**
    814    \brief the singleton reference to this class
     814 * the singleton reference to this class
    815815*/
    816816TextEngine* TextEngine::singletonRef = NULL;
    817817
    818818/**
    819    \brief standard deconstructor
     819 * standard deconstructor
    820820
    821821*/
    … …  
    830830
    831831/**
    832    \brief function to enable TTF_Fonts
     832 * function to enable TTF_Fonts
    833833*/
    834834void TextEngine::enableFonts()
    … …  
    846846
    847847/**
    848    \brief function to disable TTF_fonts
     848 * function to disable TTF_fonts
    849849*/
    850850void TextEngine::disableFonts()
    … …  
    859859
    860860/**
    861    \brief creates a new Text with a certain font.
     861 * creates a new Text with a certain font.
    862862   \see Font::Font
    863863   \see Text::Text
    … …  
    884884
    885885/**
    886    \brief removes a Text from the List
    887    \param text: the text to delete
     886 * removes a Text from the List
     887 * @param text: the text to delete
    888888
    889889   this only ereases allocated memory, and removes the text
    … …  
    898898
    899899/**
    900    \brief deletes all the Text, and tries to delete all allocated fonts
     900 * deletes all the Text, and tries to delete all allocated fonts
    901901*/
    902902void TextEngine::flush()
    … …  
    913913
    914914/**
    915    \brief draws all the Texts that have been initialized
     915 * draws all the Texts that have been initialized
    916916*/
    917917void TextEngine::draw() const
    … …  
    937937
    938938/**
    939    \brief outputs some nice Debug information
    940 
    941    \todo there should also be something outputted about Font
     939 * outputs some nice Debug information
     940
     941   @todo there should also be something outputted about Font
    942942*/
    943943void TextEngine::debug() const
    … …  
    961961
    962962/**
    963    \brief checks if the compiled version and the local version of SDL_ttf match.
    964    \returns true if match, false otherwise
     963 * checks if the compiled version and the local version of SDL_ttf match.
     964 * @returns true if match, false otherwise
    965965*/
    966966bool TextEngine::checkVersion()

  • orxonox/trunk/src/lib/graphics/text_engine.h

    r4746 r4836  
    11/*!
    22    \file text_engine.h
    3     \brief Definition of textEngine, the Font and the Text
     3  * Definition of textEngine, the Font and the Text
    44
    55    Text is the text outputed.
    … …  
    116116  void setPosition(int x, int y);
    117117  void setAlignment(TEXT_ALIGNMENT alignment);
    118   /** \param blending the blending intensity to set (between 0.0 and 1.0) */
     118  /** @param blending the blending intensity to set (between 0.0 and 1.0) */
    119119  inline void setBlending(float blending) {this->blending = blending;}
    120120
    … …  
    145145  // placement in openGL
    146146  GLuint            texture;        //!< A GL-texture to hold the text
    147   TexCoord          texCoord;       //!< Texture-coordinates \todo fix this to have a struct
     147  TexCoord          texCoord;       //!< Texture-coordinates @todo fix this to have a struct
    148148  SDL_Rect          posSize;        //!< An SDL-Rectangle representing the position and size of the Text on the screen.
    149149
    … …  
    174174  void setStyle(const char* renderStyle);
    175175
    176   /** \returns a Pointer to the Array of Glyphs */
     176  /** @returns a Pointer to the Array of Glyphs */
    177177  inline Glyph** getGlyphArray() const {return glyphArray;}
    178   /** \returns the texture to the fast-texture */
     178  /** @returns the texture to the fast-texture */
    179179  inline GLuint getFastTextureID() const {return fastTextureID;}
    180180
    … …  
    217217 public:
    218218  virtual ~TextEngine();
    219   /** \returns a Pointer to the only object of this Class */
     219  /** @returns a Pointer to the only object of this Class */
    220220  inline static TextEngine* getInstance() { if (!singletonRef) singletonRef = new TextEngine();  return singletonRef; };
    221221
Note: See TracChangeset for help on using the changeset viewer.