Source/System/NodeCores/Groups/DynamicStateGenerators/OSGDynamicStateGenerator.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-2006 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 _OSGDYNAMICSTATEGENERATOR_H_
  40 #define _OSGDYNAMICSTATEGENERATOR_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGDynamicStateGeneratorBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 /*! \brief DynamicStateGenerator class. See \ref
  50            PageGroupDynamicStateGenerator for a description.
  51     \ingroup GrpGroupDynamicStateGeneratorsObj
  52     \ingroup GrpLibOSGGroup
  53     \includebasedoc
  54 */
  55
  56 class OSG_GROUP_DLLMAPPING DynamicStateGenerator :
  57     public DynamicStateGeneratorBase
  58 {
  59   protected:
  60
  61     /*==========================  PUBLIC  =================================*/
  62
  63   public:
  64
  65     typedef DynamicStateGeneratorBase Inherited;
  66     typedef DynamicStateGenerator     Self;
  67
  68     /*---------------------------------------------------------------------*/
  69     /*! \name                     Output                                   */
  70     /*! \{                                                                 */
  71
  72     FrameBufferObject *getRenderTarget(void) const;
  73
  74     /*! \}                                                                 */
  75     /*---------------------------------------------------------------------*/
  76     /*! \name                      Sync                                    */
  77     /*! \{                                                                 */
  78
  79     virtual void changed(ConstFieldMaskArg whichField,
  80                          UInt32            origin,
  81                          BitVector         details    );
  82
  83     /*! \}                                                                 */
  84     /*---------------------------------------------------------------------*/
  85     /*! \name                     Output                                   */
  86     /*! \{                                                                 */
  87
  88     virtual void dump(      UInt32     uiIndent = 0,
  89                       const BitVector  bvFlags  = 0) const;
  90
  91     /*! \}                                                                 */
  92     /*=========================  PROTECTED  ===============================*/
  93
  94   protected:
  95
  96     // Variables should all be in DynamicStateGeneratorBase.
  97
  98     /*---------------------------------------------------------------------*/
  99     /*! \name                  Constructors                                */
 100     /*! \{                                                                 */
 101
 102     DynamicStateGenerator(void);
 103     DynamicStateGenerator(const DynamicStateGenerator &source);
 104
 105     /*! \}                                                                 */
 106     /*---------------------------------------------------------------------*/
 107     /*! \name                   Destructors                                */
 108     /*! \{                                                                 */
 109
 110     virtual ~DynamicStateGenerator(void);
 111
 112     /*! \}                                                                 */
 113     /*---------------------------------------------------------------------*/
 114     /*! \name                      Render                                  */
 115     /*! \{                                                                 */
 116
 117     Action::ResultE renderEnter(Action *action);
 118     Action::ResultE renderLeave(Action *action);
 119
 120     /*! \}                                                                 */
 121     /*---------------------------------------------------------------------*/
 122     /*! \name                      Init                                    */
 123     /*! \{                                                                 */
 124
 125     static void initMethod(InitPhase ePhase);
 126
 127     /*! \}                                                                 */
 128     /*==========================  PRIVATE  ================================*/
 129
 130   private:
 131
 132     friend class FieldContainer;
 133     friend class DynamicStateGeneratorBase;
 134
 135     // prohibit default functions (move to 'public' if you need one)
 136     void operator =(const DynamicStateGenerator &source);
 137 };
 138
 139 typedef DynamicStateGenerator *DynamicStateGeneratorP;
 140
 141 OSG_END_NAMESPACE
 142
 143 #include "OSGDynamicStateGeneratorBase.inl"
 144 #include "OSGDynamicStateGenerator.inl"
 145
 146 #endif /* _OSGDYNAMICSTATEGENERATOR_H_ */