Source/System/NodeCores/Groups/Light/Shadow/Base/OSGShadowMapEngine.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 _OSGSHADOWMAPENGINE_H_
  40 #define _OSGSHADOWMAPENGINE_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGShadowMapEngineBase.h"
  46 #include "OSGChunkMaterialFields.h"
  47
  48 OSG_BEGIN_NAMESPACE
  49
  50 class RenderAction;
  51
  52 /*! \brief ShadowMapEngine is the basic NodeCore for inner nodes in the tree.
  53     \ingroup GrpGroupLightShadowBaseObj
  54     \ingroup GrpLibOSGGroup
  55     \includebasedoc
  56  */
  57
  58 class OSG_GROUP_DLLMAPPING ShadowMapEngine : public ShadowMapEngineBase
  59 {
  60     /*==========================  PUBLIC  =================================*/
  61
  62   public:
  63
  64     /*---------------------------------------------------------------------*/
  65     /*! \name                       Sync                                   */
  66     /*! \{                                                                 */
  67
  68     virtual void changed(ConstFieldMaskArg whichField,
  69                          UInt32            origin,
  70                          BitVector         detail);
  71
  72     /*! \}                                                                 */
  73     /*---------------------------------------------------------------------*/
  74     /*! \name                       Render                                 */
  75     /*! \{                                                                 */
  76
  77     virtual Action::ResultE runOnEnter(Light        *pLight,
  78                                        LightTypeE    eType,
  79                                        RenderAction *pAction) = 0;
  80     virtual Action::ResultE runOnLeave(Light        *pLight,
  81                                        LightTypeE    eType,
  82                                        RenderAction *pAction) = 0;
  83
  84     /*! \}                                                                 */
  85     /*---------------------------------------------------------------------*/
  86     /*! \name                        Dump                                  */
  87     /*! \{                                                                 */
  88
  89     virtual void dump(      UInt32    uiIndent = 0,
  90                       const BitVector bvFlags  = 0) const;
  91
  92     /*! \}                                                                 */
  93     /*=========================  PROTECTED  ===============================*/
  94
  95   protected:
  96
  97     typedef ShadowMapEngineBase   Inherited;
  98
  99     static ChunkMaterialUnrecPtr _pLightPassMat;
 100
 101     /*---------------------------------------------------------------------*/
 102     /*! \name                   Constructors                               */
 103     /*! \{                                                                 */
 104
 105     ShadowMapEngine(void);
 106     ShadowMapEngine(const ShadowMapEngine &source);
 107
 108     /*! \}                                                                 */
 109     /*---------------------------------------------------------------------*/
 110     /*! \name                   Destructors                                */
 111     /*! \{                                                                 */
 112
 113     virtual ~ShadowMapEngine(void);
 114
 115     /*! \}                                                                 */
 116     /*---------------------------------------------------------------------*/
 117     /*! \name                        Init                                  */
 118     /*! \{                                                                 */
 119
 120     static void initMethod(InitPhase ePhase);
 121     static void exitMethod(InitPhase ePhase);
 122
 123     /*! \}                                                                 */
 124     /*---------------------------------------------------------------------*/
 125     /*! \name                       Action Callbacks                       */
 126     /*! \{                                                                 */
 127
 128     static BitVector bvLightPassMask;
 129     static BitVector bvAmbientPassMask;
 130     static BitVector bvDiffusePassMask;
 131
 132     /*! \}                                                                 */
 133     /*---------------------------------------------------------------------*/
 134     /*! \name                   Draw                                       */
 135     /*! \{                                                                 */
 136
 137     /*! \}                                                                 */
 138     /*==========================  PRIVATE  ================================*/
 139
 140   private:
 141
 142     friend class FieldContainer;
 143     friend class ShadowMapEngineBase;
 144
 145     /*---------------------------------------------------------------------*/
 146
 147     /*!\brief prohibit default function (move to 'public' if needed) */
 148     void operator =(const ShadowMapEngine &source);
 149 };
 150
 151 typedef ShadowMapEngine *ShadowMapEngineP;
 152
 153 OSG_END_NAMESPACE
 154
 155 #include "OSGShadowMapEngineBase.inl"
 156 #include "OSGShadowMapEngine.inl"
 157
 158 #endif /* _OSGSHADOWMAPENGINE_H_ */