Source/System/State/Base/OSGFullStateChunk.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 _OSGFULLSTATECHUNK_H_
  40 #define _OSGFULLSTATECHUNK_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGFullStateChunkBase.h"
  46
  47 #include <string>
  48
  49 OSG_BEGIN_NAMESPACE
  50
  51 class State;
  52 class StateOverride;
  53
  54 /*! \brief The abstract base class for FullStateChunks, see \ref FullStateChunk
  55            for a description.
  56     \ingroup GrpSystemStateBase
  57     \ingroup GrpLibOSGSystem
  58     \includebasedoc
  59  */
  60
  61 class OSG_SYSTEM_DLLMAPPING FullStateChunk : public FullStateChunkBase
  62 {
  63     /*==========================  PUBLIC  =================================*/
  64
  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     static        UInt32           getStaticClassId(void);
  79     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                      Output                                  */
  93     /*! \{                                                                 */
  94
  95     virtual void dump(      UInt32    uiIndent = 0,
  96                       const BitVector bvFlags  = 0) const;
  97
  98     /*! \}                                                                 */
  99     /*---------------------------------------------------------------------*/
 100     /*! \name                      State                                   */
 101     /*! \{                                                                 */
 102
 103     virtual void activate  (DrawEnv       *pEnv,
 104                             State         *pState,
 105                             StateOverride *pOverride   ) = 0;
 106
 107     virtual void deactivate(DrawEnv       *pEnv,
 108                             State         *pState,
 109                             StateOverride *pOverride   ) = 0;
 110
 111     virtual void changeFrom(DrawEnv       *pEnv,
 112                             State         *pNewState,
 113                             StateOverride *pNewOverride,
 114                             State         *pOldState,
 115                             StateOverride *pOldOverride) = 0;
 116
 117
 118     /*! \}                                                                 */
 119     /*---------------------------------------------------------------------*/
 120     /*! \name                    Comparison                                */
 121     /*! \{                                                                 */
 122
 123     virtual Real32 switchCost  ( StateChunk * chunk );
 124
 125     virtual bool   operator <  (const StateChunk &other) const;
 126
 127     virtual bool   operator == (const StateChunk &other) const;
 128     virtual bool   operator != (const StateChunk &other) const;
 129
 130     /*! \}                                                                 */
 131
 132     /*=========================  PROTECTED  ===============================*/
 133
 134   protected:
 135
 136     static StateChunkClass _class;
 137
 138     /*---------------------------------------------------------------------*/
 139     /*! \name                   Constructors                               */
 140     /*! \{                                                                 */
 141
 142     FullStateChunk(void);
 143     FullStateChunk(const FullStateChunk &source);
 144
 145     /*! \}                                                                 */
 146     /*---------------------------------------------------------------------*/
 147     /*! \name                   Destructors                                */
 148     /*! \{                                                                 */
 149
 150     virtual ~FullStateChunk(void);
 151
 152     /*! \}                                                                 */
 153     /*---------------------------------------------------------------------*/
 154     /*! \name                       Init                                   */
 155     /*! \{                                                                 */
 156
 157     virtual void activate  (DrawEnv    *,
 158                             UInt32      );
 159
 160     virtual void changeFrom(DrawEnv    *,
 161                             StateChunk *,
 162                             UInt32      );
 163
 164     virtual void deactivate(DrawEnv    *,
 165                             UInt32      );
 166
 167     /*! \}                                                                 */
 168     /*---------------------------------------------------------------------*/
 169     /*! \name                       Init                                   */
 170     /*! \{                                                                 */
 171
 172     static void initMethod(InitPhase ePhase);
 173
 174     /*! \}                                                                 */
 175     /*==========================  PRIVATE  ================================*/
 176
 177   private:
 178
 179     typedef FullStateChunkBase Inherited;
 180
 181     friend class FullStateChunkBase;
 182
 183     // prohibit default functions (move to 'public' if you need one)
 184     void operator =(const FullStateChunk &source);
 185 };
 186
 187 typedef FullStateChunk *FullStateChunkP;
 188
 189 OSG_END_NAMESPACE
 190
 191 #include "OSGFullStateChunk.inl"
 192 #include "OSGFullStateChunkBase.inl"
 193
 194 #endif /* _OSGFULLSTATECHUNK_H_ */