Changeset 3694 in orxonox.OLD for orxonox/branches/textEngine/src/lib/graphics/font/glfont.cc

Timestamp:

Mar 31, 2005, 11:45:30 AM (20 years ago)

Author:

bensch

Message:

orxonox/textEngine: doxygen tags, some minor fix

File:

• orxonox/branches/textEngine/src/lib/graphics/font/glfont.cc (modified) (16 diffs)

orxonox/branches/textEngine/src/lib/graphics/font/glfont.cc

@@ -97 +97 @@
 }
 
+//! A simple variable for checking if ttf was initialized
 bool GLFont::ttfInitialized = false;
 
-
+/**
+   \brief initializes a new Font
+   \param fontFile The file to load a Font from
+   \param fontSize the Size in pixels of the Font
+*/
 bool GLFont::init(const char* fontFile, unsigned int fontSize)
 {
@@ -120 +125 @@
 }
 
-
+/**
+   \brief sets The Font.
+   \param fontFile The file containing the font.
+   \returns true if loaded, false if something went wrong, or if a font was loaded before.
+*/
 bool GLFont::setFont(const char* fontFile)
 {
@@ -132 +141 @@
         {
           PRINTF(1)("TTF_OpenFont: %s\n", TTF_GetError());
-          // handle error
+          return false;
       }
+      return true;
     }
   else
-    PRINTF(2)("Font already initialized, unable to change it now.\n");
-}
-
-
+    {
+      PRINTF(2)("Font already initialized, unable to change it now.\n");
+      return false;
+    }
+}
+
+/**
+   \brief Sets a new Text to the font
+   \param text the new text to set
+*/
 void GLFont::setText(const char* text)
 {
@@ -171 +187 @@
 }
 
+/**
+   \brief Sets a new Size to the font
+   \param fontSize The new Size in pixels.
+*/
 void GLFont::setSize(unsigned int fontSize)
 {
@@ -176 +196 @@
 }
 
+/**
+   \brief sets a new color to the font
+   \param r Red
+   \param g Green
+   \param b Blue
+*/
 void GLFont::setColor(Uint8 r, Uint8 g, Uint8 b)
 {
@@ -183 +209 @@
 }
 
-
+/**
+   \brief sets a Position.
+   \param x the x-position in pixels from the left border
+   \param y the y-position in pixels from the top border
+*/
 void GLFont::setPosition(int x, int y)
 {
@@ -190 +220 @@
 }
 
+/**
+   \brief draws the Font
+   \todo FIX this is to slow/static
+*/
 void GLFont::draw(void)
 {
@@ -197 +231 @@
   glBegin(GL_QUADS);
   glTexCoord2f(0, 0); glVertex2i(20,   20  );
-  glTexCoord2f(1, 0); glVertex2i(200, 20  );
-  glTexCoord2f(1, 1); glVertex2i(200,   80);
-  glTexCoord2f(0, 1); glVertex2i(20, 80);
+  glTexCoord2f(1, 0); glVertex2i(20+this->textPosSize.w, 20  );
+  glTexCoord2f(1, 1); glVertex2i(20+this->textPosSize.w, 20+this->textPosSize.h);
+  glTexCoord2f(0, 1); glVertex2i(20, 20+this->textPosSize.h);
   glEnd();
   this->leave2DMode();
@@ -206 +240 @@
 
 
-
+/**
+   \brief creates a texture out of the given parameters
+*/
 void GLFont::createTexture(void)
 {
@@ -213 +249 @@
   if (tmpSurf)
     this->texture = loadTexture(tmpSurf, texcoord);
+
+  this->textPosSize.w = tmpSurf->w;
+  this->textPosSize.h = tmpSurf->h;
+  SDL_FreeSurface(tmpSurf);
 }
 
@@ -261 +301 @@
    for more info about vertical Fonts
 */
-glyph GLFont::getGlyphMetrics(Uint16 character)
-{
-  glyph rg;
+Glyph GLFont::getGlyphMetrics(Uint16 character)
+{
+  Glyph rg;
   rg.character = character;
   TTF_GlyphMetrics(this->font, rg.character,
@@ -276 +316 @@
 }
 
-void GLFont::renderText(void)
-{
-
-}
-
-
-
-void GLFont::enter2DMode()
+/**
+   \brief entering 2D Mode
+   
+   this is a GL-Projection-mode, that is orthogonal, for placing the font in fron of everything else
+*/
+void GLFont::enter2DMode(void)
 {
   SDL_Surface *screen = SDL_GetVideoSurface();
@@ -314 +352 @@
 }
 
-
-void GLFont::leave2DMode()
+/**
+   \brief leaves the 2DMode again also \see GLFont::enter2DMode(void)
+*/
+void GLFont::leave2DMode(void)
 {
         glMatrixMode(GL_MODELVIEW);
@@ -326 +366 @@
 }
 
-
+/**
+   \brief Loads a Font from an SDL_surface into a texture.
+   \param surface The surface to make the texture of
+   \param texcoord The texture coordinates of the 4 corners of the texture
+   \returns the ID of the texture
+*/
 GLuint GLFont::loadTexture(SDL_Surface *surface, GLfloat *texcoord)
 {
@@ -432 +477 @@
 
 
-/* Quick utility function for texture creation */
+/**
+   \brief Quick utility function for texture creation 
+   \param input an integer
+   \returns the next bigger 2^n-integer than input
+*/
 int GLFont::powerOfTwo(int input)
 {
@@ -444 +493 @@
 
 
-
+/**
+   \brief a simple function to get some interesting information about this class
+*/
 void GLFont::debug(void)
 {