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