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