Source/System/State/OpenGL/OSGShadeModelChunk.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 _OSGSHADEMODELCHUNK_H_
  40 #define _OSGSHADEMODELCHUNK_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGConfig.h"
  46
  47 #include "OSGShadeModelChunkBase.h"
  48
  49 OSG_BEGIN_NAMESPACE
  50
  51 /*! \brief ShadeModelChunk class. See \ref
  52            PageSystemShadeModelChunk for a description.
  53     \ingroup GrpStateOpenGLObj
  54     \ingroup GrpLibOSGState
  55     \includebasedoc
  56  */
  57
  58 class OSG_STATE_DLLMAPPING ShadeModelChunk : public ShadeModelChunkBase
  59 {
  60   private:
  61
  62     typedef ShadeModelChunkBase Inherited;
  63
  64     /*==========================  PUBLIC  =================================*/
  65   public:
  66
  67     /*---------------------------------------------------------------------*/
  68     /*! \name                 Chunk Class Access                           */
  69     /*! \{                                                                 */
  70
  71     virtual const StateChunkClass * getClass         (void) const;
  72
  73     /*! \}                                                                 */
  74     /*---------------------------------------------------------------------*/
  75     /*! \name              Static Chunk Class Access                       */
  76     /*! \{                                                                 */
  77
  78     inline static        UInt32            getStaticClassId (void);
  79     inline static  const StateChunkClass * getStaticClass   (void);
  80
  81     /*! \}                                                                 */
  82     /*---------------------------------------------------------------------*/
  83     /*! \name                      Sync                                    */
  84     /*! \{                                                                 */
  85
  86     virtual void changed(ConstFieldMaskArg whichField,
  87                          UInt32            origin,
  88                          BitVector         details);
  89
  90     /*! \}                                                                 */
  91     /*---------------------------------------------------------------------*/
  92     /*! \name                    State Commands                            */
  93     /*! \{                                                                 */
  94
  95     virtual void activate  (DrawEnv    *action,
  96                             UInt32      index = 0);
  97
  98     virtual void changeFrom(DrawEnv    *action,
  99                             StateChunk *old,
 100                             UInt32      index = 0);
 101
 102     virtual void deactivate(DrawEnv    *action,
 103                             UInt32      index = 0);
 104
 105     /*! \}                                                                 */
 106     /*---------------------------------------------------------------------*/
 107     /*! \name                    Comparison                                */
 108     /*! \{                                                                 */
 109
 110     virtual Real32  switchCost  (      StateChunk *chunk);
 111
 112     virtual bool    operator <  (const StateChunk &other) const;
 113
 114     virtual bool    operator == (const StateChunk &other) const;
 115     virtual bool    operator != (const StateChunk &other) const;
 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   protected:
 128
 129     // Variables should all be in ShadeModelChunkBase.
 130
 131     /*---------------------------------------------------------------------*/
 132     /*! \name                  Constructors                                */
 133     /*! \{                                                                 */
 134
 135     ShadeModelChunk(void);
 136     ShadeModelChunk(const ShadeModelChunk &source);
 137
 138     /*! \}                                                                 */
 139     /*---------------------------------------------------------------------*/
 140     /*! \name                   Destructors                                */
 141     /*! \{                                                                 */
 142
 143     virtual ~ShadeModelChunk(void);
 144
 145     /*! \}                                                                 */
 146
 147     /*==========================  PRIVATE  ================================*/
 148   private:
 149
 150     friend class FieldContainer;
 151     friend class ShadeModelChunkBase;
 152
 153     static StateChunkClass _class;
 154
 155     static void initMethod(InitPhase ePhase);
 156
 157     // prohibit default functions (move to 'public' if you need one)
 158
 159     void operator =(const ShadeModelChunk &source);
 160 };
 161
 162 typedef ShadeModelChunk *ShadeModelChunkP;
 163
 164 OSG_END_NAMESPACE
 165
 166 #include "OSGShadeModelChunkBase.inl"
 167 #include "OSGShadeModelChunk.inl"
 168
 169 #endif /* _OSGSHADEMODELCHUNK_H_ */