doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / gameengine / Ketsji / KX_FontObject.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 /** \file KX_FontObject.h
31  *  \ingroup ketsji
32  */
33
34 #ifndef __KX_FONTOBJECT
35 #define  __KX_FONTOBJECT
36 #include "KX_GameObject.h"
37 #include "DNA_vfont_types.h"
38 #include "RAS_IRenderTools.h"
39
40 class KX_FontObject : public KX_GameObject
41 {
42 public:
43         Py_Header;
44         KX_FontObject(  void* sgReplicationInfo,
45                                         SG_Callbacks callbacks,
46                                         RAS_IRenderTools* rendertools,
47                                         Object *ob);
48
49         virtual ~KX_FontObject();
50
51         void DrawText();
52
53         /** 
54          * Inherited from CValue -- return a new copy of this
55          * instance allocated on the heap. Ownership of the new 
56          * object belongs with the caller.
57          */
58         virtual CValue* GetReplica();
59         virtual void ProcessReplica();
60
61 protected:
62         STR_String              m_text;
63         Object*                 m_object;
64         int                     m_fontid;
65         int                     m_dpi;
66         float                   m_fsize;
67         float                   m_resolution;
68         float                   m_color[4];
69
70         class RAS_IRenderTools* m_rendertools;  //needed for drawing routine
71
72 /*
73 #ifdef WITH_CXX_GUARDEDALLOC
74 public:
75         void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:KX_FontObject"); }
76         void operator delete( void *mem ) { MEM_freeN(mem); }
77 #endif
78 */
79
80 #ifdef WITH_PYTHON
81 #endif
82
83 };
84
85 #endif //__KX_FONTOBJECT