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