Changeset 3456 in orxonox.OLD for orxonox/trunk/src/sfont/fontset.h

Timestamp:

Mar 4, 2005, 10:01:43 AM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: FontSet addapted the fontset some more
doxygen-tags
name

File:

• orxonox/trunk/src/sfont/fontset.h (moved) (moved from orxonox/trunk/src/sfont/cone3dfont.h) (2 diffs)

orxonox/trunk/src/sfont/fontset.h

@@ -1 @@
-/***************************************************************************
-                          cone3dfont.h  -  description
-                             -------------------
-    copyright            : (C) 2001 by Marius Andra aka Cone3D
-    email                : marius@hot.ee
-    ICQ                  : 43999510
- ***************************************************************************/
+/*! 
+    \file fontset.h
+    \brief Handles the display of Text.
+*/
 
-/***************************************************************************
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- ***************************************************************************/
-/*
+/**
   This file is extended to the needs of the orxonox-project.
   The main difference to the version of Marius is, that textures get 
@@ -23 +12 @@
 class Texture;
 
+//! A class to handle a FontSet.
+/**
+   A fontset is an entire Alphabet (256 entries) of one font.
+   It is made by creating a file containing a matrix with 256
+   little pictures in it, displaying the letters of this alphabet.
+   Then these letters are projected onto Quads, which can be aranged
+   in a sorted order, to display some text
 
-class Cone3DFont
+   usage:
+   1. initialize the Class by loading the source-font-picture
+   2. set the size
+   3. write some text with printText
+   4. delete the class again.
+*/ 
+class FontSet
 {
-public:
-  Cone3DFont() {sizex=1.0f; sizey=1.0f;};
-        ~Cone3DFont() {KillFont();};
-  int BuildFont(char *file);
-  int PrintText(int x, int y, char type, char *fmt, ...);
-  int KillFont();
-  int SetSize(float x, float y);
-
-  //  Cone3DTGA font;
-private:
-  int base;
-  float sizex,sizey;
-  Texture* font;
+ public:
+  FontSet();
+  FontSet(char *file);
+  ~FontSet();
+  
+  int buildFont(char* fontFile);
+  int printText(int x, int y, char type, char *fmt, ...);
+  int killFont(void);
+  int setSize(float x, float y);
+  
+ private:
+  int base;          //!< Save the glLists here.
+  float sizex;       //!< the width of the text.
+  float sizey;       //!< the height of the text.
+  Texture* font;     //!< texture of the font.
 
 };