Source/System/NodeCores/Groups/DynamicStateGenerators/OSGCubeMapGenerator.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 _OSGCUBEMAPGENERATOR_H_
  40 #define _OSGCUBEMAPGENERATOR_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGCubeMapGeneratorBase.h"
  46 #include "OSGCubeMapGeneratorStageData.h"
  47
  48 OSG_BEGIN_NAMESPACE
  49
  50 class RenderActionBase;
  51
  52 /*! \brief CubeMapGenerator class. See \ref
  53            PageGroupCubeMapGenerator for a description.
  54     \ingroup GrpGroupDynamicStateGeneratorsObj
  55     \ingroup GrpLibOSGGroup
  56     \includebasedoc
  57  */
  58
  59 class OSG_GROUP_DLLMAPPING CubeMapGenerator : public CubeMapGeneratorBase
  60 {
  61   protected:
  62
  63     /*==========================  PUBLIC  =================================*/
  64
  65   public:
  66
  67     typedef CubeMapGeneratorBase Inherited;
  68     typedef CubeMapGenerator     Self;
  69
  70     enum SetupMode
  71     {
  72         NoSetup      = 0x0000,
  73         SetupTexture = 0x0001,
  74         SetupTexEnv  = 0x0002,
  75         SetupTexGen  = 0x0004,
  76
  77         OverrideTex  = 0x0010,
  78         AutoTexture  = 0x0011,
  79
  80         SetupAll     = 0x0017
  81     };
  82
  83     enum OriginMode
  84     {
  85         UseStoredValue         = 0x0001,
  86         UseBeacon              = 0x0002,
  87         UseCurrentVolumeCenter = 0x0003,
  88         UseParentsVolumeCenter = 0x0004
  89     };
  90
  91     /*---------------------------------------------------------------------*/
  92     /*! \name                     Output                                   */
  93     /*! \{                                                                 */
  94
  95     CubeMapGeneratorStageData *initData(RenderAction *pAction);
  96
  97     /*! \}                                                                 */
  98     /*---------------------------------------------------------------------*/
  99     /*! \name                      Sync                                    */
 100     /*! \{                                                                 */
 101
 102     void   setSize  (UInt16 uiWidth,
 103                      UInt16 uiHeight);
 104
 105     UInt16 getWidth (void);
 106     UInt16 getHeight(void);
 107
 108     /*! \}                                                                 */
 109     /*---------------------------------------------------------------------*/
 110     /*! \name                      Sync                                    */
 111     /*! \{                                                                 */
 112
 113     virtual void changed(ConstFieldMaskArg whichField,
 114                          UInt32            origin,
 115                          BitVector         details    );
 116
 117     /*! \}                                                                 */
 118     /*---------------------------------------------------------------------*/
 119     /*! \name                     Output                                   */
 120     /*! \{                                                                 */
 121
 122     virtual void dump(      UInt32     uiIndent = 0,
 123                       const BitVector  bvFlags  = 0) const;
 124
 125     /*! \}                                                                 */
 126     /*=========================  PROTECTED  ===============================*/
 127
 128   protected:
 129
 130     // Variables should all be in CubeMapGeneratorBase.
 131
 132     /*---------------------------------------------------------------------*/
 133     /*! \name                  Constructors                                */
 134     /*! \{                                                                 */
 135
 136     CubeMapGenerator(void);
 137     CubeMapGenerator(const CubeMapGenerator &source);
 138
 139     /*! \}                                                                 */
 140     /*---------------------------------------------------------------------*/
 141     /*! \name                   Destructors                                */
 142     /*! \{                                                                 */
 143
 144     virtual ~CubeMapGenerator(void);
 145
 146     /*! \}                                                                 */
 147     /*---------------------------------------------------------------------*/
 148     /*! \name                   Draw                                       */
 149     /*! \{                                                                 */
 150
 151     Action::ResultE renderEnter(Action *action);
 152     Action::ResultE renderLeave(Action *action);
 153
 154     /*! \}                                                                 */
 155     /*---------------------------------------------------------------------*/
 156     /*! \name                      Init                                    */
 157     /*! \{                                                                 */
 158
 159     CubeMapGeneratorStageDataTransitPtr setupStageData(RenderAction *pAction);
 160
 161     /*! \}                                                                 */
 162     /*---------------------------------------------------------------------*/
 163     /*! \name                      Init                                    */
 164     /*! \{                                                                 */
 165
 166     static void initMethod(InitPhase ePhase);
 167
 168     /*! \}                                                                 */
 169     /*==========================  PRIVATE  ================================*/
 170
 171   private:
 172
 173     friend class FieldContainer;
 174     friend class CubeMapGeneratorBase;
 175
 176     // prohibit default functions (move to 'public' if you need one)
 177     void operator =(const CubeMapGenerator &source);
 178 };
 179
 180 typedef CubeMapGenerator *CubeMapGeneratorP;
 181
 182 OSG_END_NAMESPACE
 183
 184 #include "OSGCubeMapGeneratorBase.inl"
 185 #include "OSGCubeMapGenerator.inl"
 186
 187 #endif /* _OSGCUBEMAPGENERATOR_H_ */