Source/System/Statistics/Foregrounds/OSGSimpleStatisticsForeground.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *             Copyright (C) 2000-2002 by the OpenSG Forum                   *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
  10  *                                                                           *
  11 \*---------------------------------------------------------------------------*/
  12 /*---------------------------------------------------------------------------*\
  13  *                                License                                    *
  14  *                                                                           *
  15  * This library is free software; you can redistribute it and/or modify it   *
  16  * under the terms of the GNU Library General Public License as published    *
  17  * by the Free Software Foundation, version 2.                               *
  18  *                                                                           *
  19  * This library is distributed in the hope that it will be useful, but       *
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  22  * Library General Public License for more details.                          *
  23  *                                                                           *
  24  * You should have received a copy of the GNU Library General Public         *
  25  * License along with this library; if not, write to the Free Software       *
  26  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  27  *                                                                           *
  28 \*---------------------------------------------------------------------------*/
  29 /*---------------------------------------------------------------------------*\
  30  *                                Changes                                    *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35  *                                                                           *
  36  *                                                                           *
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef _OSGSIMPLESTATISTICSFOREGROUND_H_
  40 #define _OSGSIMPLESTATISTICSFOREGROUND_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGSimpleStatisticsForegroundBase.h"
  46 #include "OSGTextureObjChunk.h"
  47 #include "OSGTextureEnvChunk.h"
  48 #include "OSGTextTXFFace.h"
  49
  50 OSG_BEGIN_NAMESPACE
  51
  52 class TextLayoutResult;
  53
  54 /*! \brief Simple Statistics Foreground class. See \ref
  55            PageSystemWindowForegroundStatisticsSimple for a description.
  56     \ingroup GrpUtilStatisticsObj
  57     \ingroup GrpLibOSGUtil
  58     \includebasedoc
  59  */
  60
  61 class OSG_UTIL_DLLMAPPING SimpleStatisticsForeground :
  62     public SimpleStatisticsForegroundBase
  63 {
  64   public:
  65
  66     typedef SimpleStatisticsForegroundBase                    Inherited;
  67
  68     /*---------------------------------------------------------------------*/
  69     /*! \name                     Modes                                    */
  70     /*! \{                                                                 */
  71
  72     enum { Left=0, Middle, Right } HorizontalAlignE;
  73     enum { Top=0, Center, Bottom } VerticalAlignE;
  74
  75     /*! \}                                                                 */
  76     /*---------------------------------------------------------------------*/
  77     /*! \name                      Sync                                    */
  78     /*! \{                                                                 */
  79
  80     virtual void changed(ConstFieldMaskArg whichField,
  81                          UInt32            origin,
  82                          BitVector         details);
  83
  84     /*! \}                                                                 */
  85     /*---------------------------------------------------------------------*/
  86     /*! \name                     Output                                   */
  87     /*! \{                                                                 */
  88
  89     virtual void dump(      UInt32     uiIndent = 0,
  90                       const BitVector  bvFlags  = 0) const;
  91
  92     /*! \}                                                                 */
  93     /*---------------------------------------------------------------------*/
  94     /*! \name                      Draw                                    */
  95     /*! \{                                                                 */
  96
  97     virtual void draw(DrawEnv *pEnv);
  98
  99     /*! \}                                                                 */
 100     /*---------------------------------------------------------------------*/
 101     /*! \name               Convenience Functions                          */
 102     /*! \{                                                                 */
 103
 104     void addElement(StatElemDescBase &desc, const Char8 *format = NULL);
 105     void addElement(Int32            id,    const Char8 *format = NULL);
 106     void addText   (const char *text);
 107     void clearElems(void);
 108
 109     /*! \}                                                                 */
 110     /*=========================  PROTECTED  ===============================*/
 111
 112   protected:
 113
 114     // Variables should all be in SimpleStatisticsForegroundBase.
 115
 116     /*---------------------------------------------------------------------*/
 117     /*! \name                  Constructors                                */
 118     /*! \{                                                                 */
 119
 120     SimpleStatisticsForeground(void);
 121     SimpleStatisticsForeground(const SimpleStatisticsForeground &source);
 122
 123     /*! \}                                                                 */
 124     /*---------------------------------------------------------------------*/
 125     /*! \name                   Destructors                                */
 126     /*! \{                                                                 */
 127
 128     virtual ~SimpleStatisticsForeground(void);
 129
 130     /*! \}                                                                 */
 131     /*---------------------------------------------------------------------*/
 132     /*! \name                       Init                                   */
 133     /*! \{                                                                 */
 134
 135     static void initMethod(InitPhase ePhase);
 136     /*! \}                                                                 */
 137     /*---------------------------------------------------------------------*/
 138     /*! \name                       Init                                   */
 139     /*! \{                                                                 */
 140
 141     virtual void resolveLinks(void);
 142
 143     /*! \}                                                                 */
 144     /*==========================  PRIVATE  ================================*/
 145
 146   private:
 147
 148     TextTXFFaceRefPtr       _face;
 149
 150     TextureObjChunkUnrecPtr _texchunk;
 151     TextureEnvChunkUnrecPtr _texenvchunk;
 152
 153     friend class FieldContainer;
 154     friend class SimpleStatisticsForegroundBase;
 155
 156     void initText(const std::string &family, Real32 size);
 157
 158     // prohibit default functions (move to 'public' if you need one)
 159     void operator =(const SimpleStatisticsForeground &source);
 160 };
 161
 162 typedef SimpleStatisticsForeground       *SimpleStatisticsForegroundP;
 163
 164 OSG_END_NAMESPACE
 165
 166 #include "OSGSimpleStatisticsForegroundBase.inl"
 167 #include "OSGSimpleStatisticsForeground.inl"
 168
 169 #endif /* _OSGSIMPLESTATISTICSFOREGROUND_H_ */