Source/System/State/Base/OSGState.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
  40 #ifndef _OSGSTATE_H_
  41 #define _OSGSTATE_H_
  42 #ifdef __sgi
  43 #pragma once
  44 #endif
  45
  46 #include "OSGStateBase.h"
  47 #include "OSGStateChunk.h"
  48
  49 OSG_BEGIN_NAMESPACE
  50
  51 class StateOverride;
  52 class DrawEnv;
  53
  54 /*! \brief Wrapper for a complete State. See \ref State for a description.
  55     \ingroup GrpSystemStateBase
  56     \ingroup GrpLibOSGSystem
  57     \includebasedoc
  58  */
  59
  60 class OSG_SYSTEM_DLLMAPPING State : public StateBase
  61 {
  62     /*==========================  PUBLIC  =================================*/
  63
  64   public:
  65
  66     static const UInt32 InvalidKey     = 0x000003FF;
  67
  68     static const UInt32 SkipRebuild    = 0x80000000;
  69
  70     static const UInt32 Key1Mask       = 0x000003FF;
  71     static const UInt32 Key2Mask       = 0x000FFC00;
  72     static const UInt32 Key3Mask       = 0x3FF00000;
  73
  74     static const UInt32 DefaultKeyMask = 0x80000000;
  75     static const UInt32 FullStateMask  = 0x40000000;
  76
  77     static const UInt32 SkipNumChunks  = 2;
  78     static const UInt32 UpdateChunk    = 2;
  79     static const UInt32 FullStateIndex = 2;
  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               OpenGL State Management                        */
 100     /*! \{                                                                 */
 101
 102     /*! \}                                                                 */
 103     /*---------------------------------------------------------------------*/
 104     /*! \name               OpenGL State Management                        */
 105     /*! \{                                                                 */
 106
 107     void activate  (DrawEnv *pEnv) const;
 108
 109     void changeFrom(DrawEnv *pEnv,
 110                     State   *pOld) const;
 111
 112     void deactivate(DrawEnv *pEnv) const;
 113
 114     /*! \}                                                                 */
 115     /*---------------------------------------------------------------------*/
 116     /*! \name                    Enums                                     */
 117     /*! \{                                                                 */
 118
 119     enum
 120     {
 121         AutoSlot        = -1,
 122         AutoSlotReplace = -2
 123     };
 124
 125     /*! \}                                                                 */
 126     /*---------------------------------------------------------------------*/
 127     /*! \name                    Access                                    */
 128     /*! \{                                                                 */
 129
 130     StateChunk *getChunk     (UInt32      chunkId                ) const;
 131
 132     bool        chunkPresent (UInt32      chunkId                ) const;
 133     bool        chunkPresent (StateChunk *chunk                  ) const;
 134
 135     bool        addChunk     (StateChunk *chunk,
 136                               Int32       index = AutoSlotReplace);
 137
 138     bool        subChunk     (StateChunk *chunk                  );
 139
 140     bool        subChunk     (UInt32      classid,
 141                               Int32       index                  );
 142
 143     void        clearChunks  (void                               );
 144
 145     /*! \}                                                                 */
 146     /*---------------------------------------------------------------------*/
 147     /*! \name                    Access                                    */
 148     /*! \{                                                                 */
 149
 150     void   setCoreGLChunkLimit(UInt32 uiCoreGLChunkLimit);
 151     UInt32 getCoreGLChunkLimit(void                     );
 152
 153     /*! \}                                                                 */
 154     /*---------------------------------------------------------------------*/
 155     /*! \name                    Properties                                */
 156     /*! \{                                                                 */
 157
 158     bool isTransparent(void) const;
 159
 160     /*! \}                                                                 */
 161     /*---------------------------------------------------------------------*/
 162     /*! \name      StateSorting Interface (for Material/Sorter only)       */
 163     /*! \{                                                                 */
 164
 165     void   setDefaultSortKey(UInt32 uiSortKey);
 166     UInt32 getSortKey       (UInt32 uiKeyGen  = SkipRebuild);
 167
 168     /*! \}                                                                 */
 169     /*---------------------------------------------------------------------*/
 170     /*! \name                    Comparison                                */
 171     /*! \{                                                                 */
 172
 173     virtual Real32 switchCost  (State * state);
 174
 175     virtual bool   operator <  (const State &other) const;
 176
 177     virtual bool   operator == (const State &other) const;
 178     virtual bool   operator != (const State &other) const;
 179
 180     /*! \}                                                                 */
 181     /*=========================  PROTECTED  ===============================*/
 182
 183   protected:
 184
 185     UInt32 _uiDefaultSortKey;
 186     UInt32 _uiSortKey;
 187     UInt32 _uiKeyGen;
 188     UInt32 _uiCoreGLChunkLimit;
 189
 190     /*---------------------------------------------------------------------*/
 191     /*! \name                       Init                                   */
 192     /*! \{                                                                 */
 193
 194     void onCreateAspect(const State *createAspect,
 195                         const State *source      = NULL);
 196
 197     /*! \}                                                                 */
 198     /*---------------------------------------------------------------------*/
 199     /*! \name                   Constructors                               */
 200     /*! \{                                                                 */
 201
 202     State(void);
 203     State(const State &source);
 204
 205     /*! \}                                                                 */
 206     /*---------------------------------------------------------------------*/
 207     /*! \name                   Destructors                                */
 208     /*! \{                                                                 */
 209
 210     virtual ~State(void);
 211
 212     /*! \}                                                                 */
 213     /*---------------------------------------------------------------------*/
 214     /*! \name                   Destructors                                */
 215     /*! \{                                                                 */
 216
 217     void rebuildSortKey(void);
 218
 219     /*! \}                                                                 */
 220     /*---------------------------------------------------------------------*/
 221     /*! \name                       Init                                   */
 222     /*! \{                                                                 */
 223
 224     const MFUnrecStateChunkPtr *getMFChunks(void) const;
 225
 226     virtual void resolveLinks(void);
 227
 228     /*! \}                                                                 */
 229     /*---------------------------------------------------------------------*/
 230     /*! \name                       Init                                   */
 231     /*! \{                                                                 */
 232
 233     static void initMethod(InitPhase ePhase);
 234
 235     /*! \}                                                                 */
 236     /*==========================  PRIVATE  ================================*/
 237
 238   private:
 239
 240     typedef StateBase Inherited;
 241
 242     friend class FieldContainer;
 243     friend class StateBase;
 244     friend class DrawEnv;
 245
 246     // prohibit default functions (move to 'public' if you need one)
 247     void operator =(const State &source);
 248 };
 249
 250 typedef State *StateP;
 251
 252 #define OSG_SKIP_IT(ITERATOR, STEPS)                        \
 253     (ITERATOR) += (STEPS)
 254
 255 OSG_END_NAMESPACE
 256
 257 #include "OSGStateBase.inl"
 258 #include "OSGState.inl"
 259
 260 #endif /* _OSGSTATE_H_ */