Source/Contrib/CgFXMaterial/OSGCgFXPassChunk.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 _OSGCGFXPASSCHUNK_H_
  40 #define _OSGCGFXPASSCHUNK_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include <string>
  46 #include <vector>
  47 #include <map>
  48
  49 #include "OSGCG.h"
  50
  51 #include "OSGCgFXPassChunkBase.h"
  52
  53 OSG_BEGIN_NAMESPACE
  54
  55 class CgFXTechnique;
  56
  57 /*! \brief CgFXPassChunk class. See \ref
  58            PageKernelCgFXPassChunk for a description.
  59 */
  60
  61 class OSG_CONTRIBCGFX_DLLMAPPING CgFXPassChunk : public CgFXPassChunkBase
  62 {
  63   private:
  64
  65     typedef CgFXPassChunkBase Inherited;
  66
  67     /*==========================  PUBLIC  =================================*/
  68
  69   public:
  70
  71     /*---------------------------------------------------------------------*/
  72     /*! \name                 Chunk Class Access                           */
  73     /*! \{                                                                 */
  74
  75     /*! \}                                                                 */
  76     /*---------------------------------------------------------------------*/
  77     /*! \name              Static Chunk Class Access                       */
  78     /*! \{                                                                 */
  79
  80     /*! \}                                                                 */
  81     /*---------------------------------------------------------------------*/
  82     /*! \name                      Sync                                    */
  83     /*! \{                                                                 */
  84
  85     virtual void changed(ConstFieldMaskArg whichField,
  86                          UInt32            origin,
  87                          BitVector         detail    );
  88
  89     /*! \}                                                                 */
  90     /*---------------------------------------------------------------------*/
  91     /*! \name                     Output                                   */
  92     /*! \{                                                                 */
  93
  94     virtual void dump(      UInt32     uiIndent = 0,
  95                       const BitVector  bvFlags  = 0) const;
  96
  97
  98     /*! \}                                                                 */
  99     /*---------------------------------------------------------------------*/
 100     /*! \name                    Parameter Callbacks                       */
 101     /*! \{                                                                 */
 102
 103     virtual void activate  (DrawEnv       *pEnv,
 104                             State         *pState,
 105                             StateOverride *pOverride   );
 106
 107     virtual void deactivate(DrawEnv       *pEnv,
 108                             State         *pState,
 109                             StateOverride *pOverride   );
 110
 111     virtual void changeFrom(DrawEnv       *,
 112                             State         *pNewState,
 113                             StateOverride *pNewOverride,
 114                             State         *pOldState,
 115                             StateOverride *pOldOverride);
 116     /*! \}                                                                 */
 117     /*---------------------------------------------------------------------*/
 118     /*! \name                       Parameters                            */
 119     /*! \{                                                                 */
 120
 121     /*! \}                                                                 */
 122     /*---------------------------------------------------------------------*/
 123     /*! \name                       State                                  */
 124     /*! \{                                                                 */
 125
 126     virtual bool isTransparent(void) const;
 127
 128     /*! \}                                                                 */
 129     /*---------------------------------------------------------------------*/
 130     /*! \name                    Comparison                                */
 131     /*! \{                                                                 */
 132
 133     virtual Real32 switchCost  (      StateChunk *chunk);
 134
 135     virtual bool   operator <  (const StateChunk &other) const;
 136
 137     virtual bool   operator == (const StateChunk &other) const;
 138     virtual bool   operator != (const StateChunk &other) const;
 139
 140     /*! \}                                                                 */
 141     /*=========================  PROTECTED  ===============================*/
 142
 143   protected:
 144
 145     // Variables should all be in CGFXPassChunkBase.
 146
 147     CGpass   _pCGPass;
 148
 149     /*---------------------------------------------------------------------*/
 150     /*! \name                  Constructors                                */
 151     /*! \{                                                                 */
 152
 153     CgFXPassChunk(void);
 154     CgFXPassChunk(const CgFXPassChunk &source);
 155
 156     /*! \}                                                                 */
 157     /*---------------------------------------------------------------------*/
 158     /*! \name                   Destructors                                */
 159     /*! \{                                                                 */
 160
 161     virtual ~CgFXPassChunk(void);
 162
 163     /*! \}                                                                 */
 164     /*---------------------------------------------------------------------*/
 165     /*! \name                       Init                                   */
 166     /*! \{                                                                 */
 167
 168     void setPass            (CGpass    pPass  );
 169
 170     void updateStateUniforms(DrawEnv  *pEnv   );
 171
 172     /*! \}                                                                 */
 173     /*---------------------------------------------------------------------*/
 174     /*! \name                       Init                                   */
 175     /*! \{                                                                 */
 176
 177     static void initMethod(InitPhase ePhase);
 178
 179     /*! \}                                                                 */
 180     /*==========================  PRIVATE  ================================*/
 181
 182   private:
 183
 184     friend class FieldContainer;
 185     friend class CgFXPassChunkBase;
 186     friend class CgFXTechnique;
 187
 188     // prohibit default functions (move to 'public' if you need one)
 189     void operator =(const CgFXPassChunk &source);
 190 };
 191
 192 typedef CgFXPassChunk *CgFXPassChunkP;
 193
 194 OSG_END_NAMESPACE
 195
 196 #include "OSGCgFXPassChunkBase.inl"
 197 #include "OSGCgFXPassChunk.inl"
 198
 199 #endif /* _OSGCGFXPASSCHUNK_H_ */