Source/System/Material/Base/OSGSwitchMaterial.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 _OSGSWITCHMATERIAL_H_
  40 #define _OSGSWITCHMATERIAL_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGSwitchMaterialBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 /*! \brief SwitchMaterial class. See \ref
  50     PageSystemSwitchMaterial for a description.
  51
  52     \ingroup GrpSystemMaterialBase
  53     \ingroup GrpLibOSGSystem
  54     \includebasedoc
  55 */
  56
  57 class OSG_SYSTEM_DLLMAPPING SwitchMaterial : public SwitchMaterialBase
  58 {
  59   public:
  60
  61     typedef SwitchMaterialBase                           Inherited;
  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
  85     PrimeMaterial *finalize     (      MaterialMapKey  oKey,
  86                                  const StateOverride  *pOverrides,
  87                                        Window         *pWin      );
  88     virtual
  89     bool           isTransparent(      void                      ) const;
  90
  91     /*! \}                                                                 */
  92     /*---------------------------------------------------------------------*/
  93     /*! \name                    Access                                    */
  94     /*! \{                                                                 */
  95
  96     void      addMaterial       (Material *mat  );
  97     void      subMaterial       (Material *mat  );
  98
  99     bool      hasMaterial       (Material *mat  ) const;
 100
 101     Material *getMaterial       (UInt32    index) const;
 102     Material *getCurrentMaterial(void           ) const;
 103
 104     /*! \}                                                                 */
 105     /*=========================  PROTECTED  ===============================*/
 106
 107   protected:
 108
 109     // Variables should all be in SwitchMaterialBase.
 110
 111     /*---------------------------------------------------------------------*/
 112     /*! \name                  Constructors                                */
 113     /*! \{                                                                 */
 114
 115     SwitchMaterial(void);
 116     SwitchMaterial(const SwitchMaterial &source);
 117
 118     /*! \}                                                                 */
 119     /*---------------------------------------------------------------------*/
 120     /*! \name                   Destructors                                */
 121     /*! \{                                                                 */
 122
 123     virtual ~SwitchMaterial(void);
 124
 125     /*! \}                                                                 */
 126     /*---------------------------------------------------------------------*/
 127     /*! \name                       Init                                   */
 128     /*! \{                                                                 */
 129
 130     static void initMethod(InitPhase ePhase);
 131
 132     /*! \}                                                                 */
 133     /*==========================  PRIVATE  ================================*/
 134
 135   private:
 136
 137     friend class FieldContainer;
 138     friend class SwitchMaterialBase;
 139
 140     // prohibit default functions (move to 'public' if you need one)
 141     void operator =(const SwitchMaterial &source);
 142 };
 143
 144 typedef SwitchMaterial              *SwitchMaterialP;
 145
 146 OSG_END_NAMESPACE
 147
 148 #include "OSGSwitchMaterialBase.inl"
 149 #include "OSGSwitchMaterial.inl"
 150
 151 #endif /* _OSGSWITCHMATERIAL_H_ */