Changeset 587

Show
Ignore:
Timestamp:
03/09/07 08:43:36 (2 years ago)
Author:
allenb
Message:

Port over some documentation about statistics.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/Doc/to_port/Window.dox

    r585 r587  
    2121 
    2222See \ref PageSystemWindowForegrounds for a description. 
    23 */ 
    24  
    25 /*! \defgroup GrpSystemWindowStatisticsForegrounds Statistics Foregrounds 
    26     \ingroup Foregrounds 
    27      
    28 Statistics Foregrounds are used to add statistics information after the 
    29 viewport is rendered. 
    30  
    31 See \ref PageSystemWindowForegroundStatistics for a description. 
    32 */ 
    33  
    34 /*! \defgroup GrpSystemWindowBackgrounds Backgrounds 
    35     \ingroup GrpSystemWindow 
    36      
    37 Backgrounds are responsible for clearing the viewport before rendering.  
    38  
    39 See \ref PageSystemWindowBackground for a description. 
    4023*/ 
    4124 
    …… 
    549532\endhint 
    550533 
    551 \subsection PageSystemWindowForegroundStatistics Statistics Foregrounds 
    552  
    553 The descendents of osg::StatisticsForeground can be used to print or draw 
    554 Statistics elements on the rendered image.  
    555  
    556 The osg::StatisticsCollector that is used to collect the elements needs to be 
    557 set in the foreground, as well as the list of osg::StatElemDesc IDs that 
    558 should be displayed. 
    559  
    560 \subsection PageSystemWindowForegroundStatisticsSimple Simple Statistics Foreground 
    561  
    562 \b NOTE: The osg::SimpleStatisticsForeground is still considered experimental 
    563 and can and probably will change! 
    564  
    565 osg::SimpleStatisticsForeground displays the statistics info as simple text 
    566 lines. They are displayed using a compiled-in font that can use an arbitrary 
    567 color and that can be arbitrarily resized, with the size per line given in 
    568 pixel.  
    569  
    570 The format of every element is given by a format string for every element that 
    571 is directly passed to osg::StatElem::putToString(), so go there to see the 
    572 possible options. 
    573  
    574 If no elementIDs are given all elements in the osg::StatCollector are display, 
    575 using the default format. 
    576  
    577 \subsection PageSystemWindowForegroundStatisticsGraphic Graphic Statistics Foreground 
    578  
    579 \b NOTE: The osg::GraphicStatisticsForeground is still considered experimental 
    580 and can and probably will change! 
    581  
    582 osg::GraphicStatisticsForeground displays the statistics info as one of a set 
    583 of graphical elements. The possible elements are:  
    584534 
    585535<ul> 

  • trunk/Source/System/Statistics/Base/OSGStatisticsForeground.fcd

    r439 r587  
    1111        decoratable="false" 
    1212> 
    13 \ingroup GrpSystemWindowForegrounds 
    14  
    1513StatisticsForeground is the base class for all foregrounds that process 
    1614statistics.  Decendents of this class can be used to print or draw Statistics 
    …… 
    2624directly and present them to the user in another way such as a GUI or text output. 
    2725 
    28 See \ref PageSystemWindowForegroundStatistics for a description. 
     26The format of every element is given by a format string for every element that 
     27is directly passed to osg::StatElem::putToString(), so go there to see the 
     28possible options. 
     29 
     30If no elementIDs are given all elements in the osg::StatCollector are display, 
     31using the default format. 
     32 
     33See \guide(Statistics) for further details. 
    2934        <Field 
    3035                name="elementIDs" 

  • trunk/Source/System/Statistics/Base/OSGStatisticsForeground.h

    r106 r587  
    4747OSG_BEGIN_NAMESPACE 
    4848 
    49 /*! \brief Statistics Foregrounds base class. See \ref  
    50     PageSystemWindowForegroundStatistics for a description. 
     49/*! \brief Statistics Foregrounds base class. 
    5150*/ 
    52  
    53 class OSG_SYSTEM_DLLMAPPING StatisticsForeground :  
     51class OSG_SYSTEM_DLLMAPPING StatisticsForeground : 
    5452    public StatisticsForegroundBase 
    5553{ 
    …… 
    6462    /*! \{                                                                 */ 
    6563 
    66     virtual void changed(ConstFieldMaskArg whichField,  
     64    virtual void changed(ConstFieldMaskArg whichField, 
    6765                         UInt32            origin    ); 
    6866 
    …… 
    7270    /*! \{                                                                 */ 
    7371 
    74     virtual void dump(      UInt32     uiIndent = 0,  
     72    virtual void dump(      UInt32     uiIndent = 0, 
    7573                      const BitVector  bvFlags  = 0) const; 
    7674 
    …… 
    10199    /*! \{                                                                 */ 
    102100 
    103     virtual ~StatisticsForeground(void);  
     101    virtual ~StatisticsForeground(void); 
    104102 
    105103    /*! \}                                                                 */ 

  • trunk/Source/System/Statistics/Base/OSGStatisticsForegroundBase.cpp

    r564 r587  
    7373 
    7474/*! \class OSG::StatisticsForeground 
    75     \ingroup GrpSystemWindowForegrounds 
    76  
    7775    StatisticsForeground is the base class for all foregrounds that process 
    7876    statistics.  Decendents of this class can be used to print or draw Statistics 
    …… 
    8886    directly and present them to the user in another way such as a GUI or text output. 
    8987 
    90     See \ref PageSystemWindowForegroundStatistics for a description. 
     88    The format of every element is given by a format string for every element that 
     89    is directly passed to osg::StatElem::putToString(), so go there to see the 
     90    possible options. 
     91 
     92    If no elementIDs are given all elements in the osg::StatCollector are display, 
     93    using the default format. 
     94 
     95    See \guide(Statistics) for further details. 
    9196 */ 
    9297 
    …… 
    176181    "\tdecoratable=\"false\"\n" 
    177182    ">\n" 
    178     "\\ingroup GrpSystemWindowForegrounds\n" 
    179     "\n" 
    180183    "StatisticsForeground is the base class for all foregrounds that process\n" 
    181184    "statistics.  Decendents of this class can be used to print or draw Statistics\n" 
    …… 
    191194    "directly and present them to the user in another way such as a GUI or text output.\n" 
    192195    "\n" 
    193     "See \\ref PageSystemWindowForegroundStatistics for a description.\n" 
     196    "The format of every element is given by a format string for every element that\n" 
     197    "is directly passed to osg::StatElem::putToString(), so go there to see the\n" 
     198    "possible options.\n" 
     199    "\n" 
     200    "If no elementIDs are given all elements in the osg::StatCollector are display,\n" 
     201    "using the default format.\n" 
     202    "\n" 
     203    "See \\guide(Statistics) for further details.\n" 
    194204    "\t<Field\n" 
    195205    "\t\tname=\"elementIDs\"\n" 
    …… 
    211221    "\t</Field>\n" 
    212222    "</FieldContainer>\n", 
    213     "\\ingroup GrpSystemWindowForegrounds\n" 
    214     "\n" 
    215223    "StatisticsForeground is the base class for all foregrounds that process\n" 
    216224    "statistics.  Decendents of this class can be used to print or draw Statistics\n" 
    …… 
    226234    "directly and present them to the user in another way such as a GUI or text output.\n" 
    227235    "\n" 
    228     "See \\ref PageSystemWindowForegroundStatistics for a description.\n" 
     236    "The format of every element is given by a format string for every element that\n" 
     237    "is directly passed to osg::StatElem::putToString(), so go there to see the\n" 
     238    "possible options.\n" 
     239    "\n" 
     240    "If no elementIDs are given all elements in the osg::StatCollector are display,\n" 
     241    "using the default format.\n" 
     242    "\n" 
     243    "See \\guide(Statistics) for further details.\n" 
    229244    ); 
    230245