Source/System/Material/Base/OSGMultiPassMaterial.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 _OSGMULTIPASSMATERIAL_H_
  40 #define _OSGMULTIPASSMATERIAL_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGMultiPassMaterialBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 /*! \brief MultiPassMaterial class. See \ref
  50     PageSystemMultiPassMaterial for a description.
  51
  52     \ingroup GrpSystemMaterialBase
  53     \ingroup GrpLibOSGSystem
  54     \includebasedoc
  55  */
  56
  57 class OSG_SYSTEM_DLLMAPPING MultiPassMaterial : public MultiPassMaterialBase
  58 {
  59     /*==========================  PUBLIC  =================================*/
  60
  61   public:
  62
  63     /*---------------------------------------------------------------------*/
  64     /*! \name                      Sync                                    */
  65     /*! \{                                                                 */
  66
  67     virtual void changed(ConstFieldMaskArg whichField,
  68                          UInt32            origin,
  69                          BitVector         detail);
  70
  71     /*! \}                                                                 */
  72     /*---------------------------------------------------------------------*/
  73     /*! \name                     Output                                   */
  74     /*! \{                                                                 */
  75
  76     virtual void dump(      UInt32     uiIndent = 0,
  77                       const BitVector  bvFlags  = 0) const;
  78
  79     /*! \}                                                                 */
  80     /*---------------------------------------------------------------------*/
  81     /*! \name                   Rendering                                  */
  82     /*! \{                                                                 */
  83
  84     virtual void    rebuildState (void        );
  85
  86     virtual State  *getState     (UInt32 index);
  87     virtual UInt32  getNPasses   (void        );
  88
  89     virtual bool    isTransparent(void        ) const;
  90
  91     /*! \}                                                                 */
  92     /*---------------------------------------------------------------------*/
  93     /*! \name                    Access                                    */
  94     /*! \{                                                                 */
  95
  96     bool hasMaterial(Material *pMat) const;
  97
  98     /*! \}                                                                 */
  99     /*=========================  PROTECTED  ===============================*/
 100
 101   protected:
 102
 103     // Variables should all be in MultiPassMaterialBase.
 104
 105     /*---------------------------------------------------------------------*/
 106     /*! \name                  Constructors                                */
 107     /*! \{                                                                 */
 108
 109     MultiPassMaterial(void);
 110     MultiPassMaterial(const MultiPassMaterial &source);
 111
 112     /*! \}                                                                 */
 113     /*---------------------------------------------------------------------*/
 114     /*! \name                   Destructors                                */
 115     /*! \{                                                                 */
 116
 117     virtual ~MultiPassMaterial(void);
 118
 119     /*! \}                                                                 */
 120     /*---------------------------------------------------------------------*/
 121     /*! \name                       Init                                   */
 122     /*! \{                                                                 */
 123
 124     static void initMethod(InitPhase ePhase);
 125
 126     /*! \}                                                                 */
 127     /*==========================  PRIVATE  ================================*/
 128
 129   private:
 130
 131     typedef MultiPassMaterialBase Inherited;
 132
 133     friend class FieldContainer;
 134     friend class MultiPassMaterialBase;
 135
 136     // prohibit default functions (move to 'public' if you need one)
 137     void operator =(const MultiPassMaterial &source);
 138 };
 139
 140 typedef MultiPassMaterial              *MultiPassMaterialP;
 141
 142 OSG_END_NAMESPACE
 143
 144 #include "OSGMultiPassMaterialBase.inl"
 145 #include "OSGMultiPassMaterial.inl"
 146
 147 #endif /* _OSGMULTIPASSMATERIAL_H_ */