Source/System/Material/Base/OSGSimpleMaterial.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 _OSGSIMPLEMATERIAL_H_
  40 #define _OSGSIMPLEMATERIAL_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGConfig.h"
  46 #include "OSGMaterialChunk.h"
  47 #include "OSGBlendChunk.h"
  48 #include "OSGSimpleMaterialBase.h"
  49
  50 OSG_BEGIN_NAMESPACE
  51
  52 /*! \brief Simple Material wrapping standard OpenGL lighting.  See \ref
  53     PageSystemMaterialSimpleMaterial for a description.
  54
  55     \ingroup GrpSystemMaterialBase
  56     \ingroup GrpLibOSGSystem
  57     \includebasedoc
  58  */
  59
  60 class OSG_SYSTEM_DLLMAPPING SimpleMaterial : public SimpleMaterialBase
  61 {
  62     /*==========================  PUBLIC  =================================*/
  63
  64   public:
  65
  66     /*---------------------------------------------------------------------*/
  67     /*! \name                      Sync                                    */
  68     /*! \{                                                                 */
  69
  70
  71     virtual void changed(ConstFieldMaskArg whichField,
  72                          UInt32            origin,
  73                          BitVector         detail);
  74
  75     /*! \}                                                                 */
  76     /*---------------------------------------------------------------------*/
  77     /*! \name                      Output                                  */
  78     /*! \{                                                                 */
  79
  80     virtual void dump(      UInt32    uiIndent = 0,
  81                       const BitVector bvFlags  = 0) const;
  82
  83     /*! \}                                                                 */
  84     /*---------------------------------------------------------------------*/
  85     /*! \name                   Rendering                                  */
  86     /*! \{                                                                 */
  87
  88     virtual void rebuildState (void);
  89
  90     virtual bool isTransparent(void) const;
  91
  92     /*! \}                                                                 */
  93     /*---------------------------------------------------------------------*/
  94     /*! \name                   Rendering                                  */
  95     /*! \{                                                                 */
  96
  97     virtual void fill(ChunkBlock *pBlock);
  98
  99     /*! \}                                                                 */
 100     /*=========================  PROTECTED  ===============================*/
 101
 102   protected:
 103
 104     // these chunks are used for rendering the material
 105
 106     MaterialChunkUnrecPtr _materialChunk;
 107     BlendChunkUnrecPtr    _blendChunk;
 108
 109     /*---------------------------------------------------------------------*/
 110     /*! \name                   Constructors                               */
 111     /*! \{                                                                 */
 112
 113     SimpleMaterial(void);
 114     SimpleMaterial(const SimpleMaterial &source);
 115
 116     /*! \}                                                                 */
 117     /*---------------------------------------------------------------------*/
 118     /*! \name                   Destructors                                */
 119     /*! \{                                                                 */
 120
 121     virtual ~SimpleMaterial(void);
 122
 123     /*! \}                                                                 */
 124     /*---------------------------------------------------------------------*/
 125     /*! \name                       Init                                   */
 126     /*! \{                                                                 */
 127
 128     static void initMethod(InitPhase ePhase);
 129
 130     /*! \}                                                                 */
 131     /*---------------------------------------------------------------------*/
 132     /*! \name                     Helper                                   */
 133     /*! \{                                                                 */
 134
 135     virtual void resolveLinks(void);
 136
 137     /*! \}                                                                 */
 138     /*---------------------------------------------------------------------*/
 139     /*! \name                     Helper                                   */
 140     /*! \{                                                                 */
 141
 142     void prepareLocalChunks(void);
 143
 144     /*! \}                                                                 */
 145     /*==========================  PRIVATE  ================================*/
 146
 147   private:
 148
 149     typedef SimpleMaterialBase Inherited;
 150
 151     friend class FieldContainer;
 152     friend class SimpleMaterialBase;
 153
 154     // prohibit default functions (move to 'public' if you need one)
 155     void operator =(const SimpleMaterial &source);
 156 };
 157
 158 typedef SimpleMaterial              *SimpleMaterialP;
 159
 160 OSG_END_NAMESPACE
 161
 162 #include "OSGSimpleMaterialBase.inl"
 163 #include "OSGSimpleMaterial.inl"
 164
 165 #endif /* _OSGSIMPLEMATERIAL_H_ */