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