Source/System/Material/Base/OSGPrimeMaterial.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-2006 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 _OSGPRIMEMATERIAL_H_
  40 #define _OSGPRIMEMATERIAL_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGPrimeMaterialBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 /*! \brief PrimeMaterial class. See \ref
  50     PageSystemPrimeMaterial for a description.
  51
  52     \ingroup GrpSystemMaterialBase
  53     \ingroup GrpLibOSGSystem
  54     \includebasedoc
  55  */
  56
  57 class OSG_SYSTEM_DLLMAPPING PrimeMaterial : public PrimeMaterialBase
  58 {
  59   protected:
  60
  61     /*==========================  PUBLIC  =================================*/
  62
  63   public:
  64
  65     typedef PrimeMaterialBase Inherited;
  66     typedef PrimeMaterial     Self;
  67
  68     /*---------------------------------------------------------------------*/
  69     /*! \name                      Sync                                    */
  70     /*! \{                                                                 */
  71
  72     virtual void changed(ConstFieldMaskArg whichField,
  73                          UInt32            origin,
  74                          BitVector         details    );
  75
  76     /*! \}                                                                 */
  77     /*---------------------------------------------------------------------*/
  78     /*! \name                     Output                                   */
  79     /*! \{                                                                 */
  80
  81     virtual PrimeMaterial *finalize(      MaterialMapKey  oKey,
  82                                     const StateOverride  *pOverrides,
  83                                           Window         *pWin      );
  84
  85     /*! \}                                                                 */
  86     /*---------------------------------------------------------------------*/
  87     /*! \name                     Output                                   */
  88     /*! \{                                                                 */
  89
  90     virtual void    rebuildState(void            ) = 0;
  91     virtual State  *getState    (UInt32 index = 0);
  92     virtual UInt32  getNPasses  (void            );
  93
  94     /*! \}                                                                 */
  95     /*---------------------------------------------------------------------*/
  96     /*! \name                     Output                                   */
  97     /*! \{                                                                 */
  98
  99     virtual void dump(      UInt32     uiIndent = 0,
 100                       const BitVector  bvFlags  = 0) const;
 101
 102     /*! \}                                                                 */
 103     /*=========================  PROTECTED  ===============================*/
 104
 105   protected:
 106
 107
 108     StateUnrecPtr _pState;  // !!! TODO is that MT safe?
 109
 110     // Yes, but not efficient. Every material has as many States as there
 111     // are aspects, each of which itself is threadsafe (i.e. multibuffered).
 112     // A single State per Material would be better. I'm just not sure how to
 113     // initialize it. :( DR
 114     // Actually, no, it isn't!!! Multiple materials updating the same aspect
 115     // in different threads make this crash!!! DR
 116
 117     /*---------------------------------------------------------------------*/
 118     /*! \name                  Constructors                                */
 119     /*! \{                                                                 */
 120
 121     PrimeMaterial(void);
 122     PrimeMaterial(const PrimeMaterial &source);
 123
 124     /*! \}                                                                 */
 125     /*---------------------------------------------------------------------*/
 126     /*! \name                   Destructors                                */
 127     /*! \{                                                                 */
 128
 129     virtual ~PrimeMaterial(void);
 130
 131     /*! \}                                                                 */
 132     /*---------------------------------------------------------------------*/
 133     /*! \name                      Init                                    */
 134     /*! \{                                                                 */
 135
 136     static void initMethod(InitPhase ePhase);
 137
 138     /*! \}                                                                 */
 139     /*---------------------------------------------------------------------*/
 140     /*! \name                     Helper                                   */
 141     /*! \{                                                                 */
 142
 143     virtual void resolveLinks(void);
 144
 145     /*! \}                                                                 */
 146     /*==========================  PRIVATE  ================================*/
 147
 148   private:
 149
 150     friend class FieldContainer;
 151     friend class PrimeMaterialBase;
 152
 153     // prohibit default functions (move to 'public' if you need one)
 154     void operator =(const PrimeMaterial &source);
 155 };
 156
 157 typedef PrimeMaterial *PrimeMaterialP;
 158
 159 OSG_END_NAMESPACE
 160
 161 #include "OSGPrimeMaterialBase.inl"
 162 #include "OSGPrimeMaterial.inl"
 163
 164 #endif /* _OSGPRIMEMATERIAL_H_ */