Source/System/Material/Base/OSGMaterial.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 _OSGMATERIAL_H_
  41 #define _OSGMATERIAL_H_
  42 #ifdef __sgi
  43 #pragma once
  44 #endif
  45
  46 #include "OSGConfig.h"
  47 #include "OSGAction.h"
  48 #include "OSGMaterialBase.h"
  49 #include "OSGState.h"
  50 #include "OSGMaterialMapFields.h"
  51
  52 OSG_BEGIN_NAMESPACE
  53
  54
  55 class MaterialDrawable;
  56 class DrawEnv;
  57 class Window;
  58 class PrimeMaterial;
  59
  60 template <class Desc>
  61 class MapCacheHandlerMixin;
  62
  63 /*! \brief Abstract Material base class. See \ref PageSystemMaterial for a
  64     description.
  65
  66     \ingroup GrpSystemMaterialBase
  67     \ingroup GrpLibOSGSystem
  68     \includebasedoc
  69  */
  70
  71 class OSG_SYSTEM_DLLMAPPING Material : public MaterialBase
  72 {
  73     /*==========================  PUBLIC  =================================*/
  74
  75   public:
  76     /*---------------------------------------------------------------------*/
  77     /*! \name                    Constants                                 */
  78     /*! \{                                                                 */
  79
  80     static const Int32 NoStateSorting;
  81     static const Int32 TransparencyAutoDetection;
  82     static const Int32 TransparencyForceTransparent;
  83     static const Int32 TransparencyForceOpaque;
  84
  85     /*! \}                                                                 */
  86     /*---------------------------------------------------------------------*/
  87     /*! \name                      Sync                                    */
  88     /*! \{                                                                 */
  89
  90     virtual void changed(ConstFieldMaskArg whichField,
  91                          UInt32            origin,
  92                          BitVector         detail);
  93
  94     /*! \}                                                                 */
  95     /*---------------------------------------------------------------------*/
  96     /*! \name                      Output                                  */
  97     /*! \{                                                                 */
  98
  99     virtual void dump(      UInt32    uiIndent = 0,
 100                       const BitVector bvFlags  = 0) const;
 101
 102     /*! \}                                                                 */
 103     /*---------------------------------------------------------------------*/
 104     /*! \name                   Rendering                                  */
 105     /*! \{                                                                 */
 106
 107     virtual
 108     PrimeMaterial *finalize     (      MaterialMapKey  oKey,
 109                                  const StateOverride  *pOverrides,
 110                                        Window         *pWin      )       = 0;
 111     virtual
 112     bool           isTransparent(      void                      ) const = 0;
 113
 114     /*! \}                                                                 */
 115     /*---------------------------------------------------------------------*/
 116     /*! \name                    Comparison                                */
 117     /*! \{                                                                 */
 118
 119     virtual Action::ResultE renderEnter(NodeCore * const  pCore,
 120                                         Action           *pAction);
 121
 122     virtual Action::ResultE renderLeave(NodeCore * const  pCore,
 123                                         Action           *pAction);
 124
 125     /*! \}                                                                 */
 126     /*---------------------------------------------------------------------*/
 127     /*! \name                    Comparison                                */
 128     /*! \{                                                                 */
 129
 130 #if 0
 131     virtual bool operator <  (const Material &other) const;
 132
 133     virtual bool operator == (const Material &other) const;
 134     virtual bool operator != (const Material &other) const;
 135 #endif
 136
 137     /*! \}                                                                 */
 138     /*=========================  PROTECTED  ===============================*/
 139
 140   protected:
 141
 142     /*---------------------------------------------------------------------*/
 143     /*! \name                   Constructors                               */
 144     /*! \{                                                                 */
 145
 146     Material(void);
 147     Material(const Material &source);
 148
 149     /*! \}                                                                 */
 150     /*---------------------------------------------------------------------*/
 151     /*! \name                   Destructors                                */
 152     /*! \{                                                                 */
 153
 154     virtual ~Material(void);
 155
 156     /*! \}                                                                 */
 157     /*---------------------------------------------------------------------*/
 158     /*! \name                       Init                                   */
 159     /*! \{                                                                 */
 160
 161     static void initMethod(InitPhase ePhase);
 162
 163     /*! \}                                                                 */
 164     /*---------------------------------------------------------------------*/
 165     /*! \name                     Helper                                   */
 166     /*! \{                                                                 */
 167
 168     virtual void resolveLinks(void);
 169
 170     /*! \}                                                                 */
 171     /*==========================  PRIVATE  ================================*/
 172
 173   private:
 174
 175     typedef MaterialBase Inherited;
 176
 177     friend class FieldContainer;
 178     friend class MaterialBase;
 179
 180     template <class Desc>
 181     friend class MapCacheHandlerMixin;
 182
 183     // prohibit default functions (move to 'public' if you need one)
 184     void operator =(const Material &source);
 185 };
 186
 187 typedef Material *MaterialP;
 188
 189 /*---------------------------------------------------------------------*/
 190 /*! \name                     Material Access                          */
 191 /*! \{                                                                 */
 192
 193 /*! \ingroup GrpSystemFunctions
 194  */
 195
 196 OSG_SYSTEM_DLLMAPPING PrimeMaterial *getDefaultMaterial     (void);
 197
 198 /*! \ingroup GrpSystemFunctions
 199  */
 200
 201 OSG_SYSTEM_DLLMAPPING PrimeMaterial *getDefaultUnlitMaterial(void);
 202
 203 /*! \}                                                                 */
 204 /*---------------------------------------------------------------------*/
 205
 206 OSG_END_NAMESPACE
 207
 208 #include "OSGMaterialBase.inl"
 209 #include "OSGMaterial.inl"
 210
 211 #endif /* _OSGMATERIAL_H_ */