Source/System/NodeCores/Groups/Base/OSGLightEnv.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 _OSGLIGHTENV_H_
  41 #define _OSGLIGHTENV_H_
  42 #ifdef __sgi
  43 #pragma once
  44 #endif
  45
  46 #include "OSGConfig.h"
  47 #include "OSGLightEnvBase.h"
  48 #include "OSGAction.h"
  49
  50 OSG_BEGIN_NAMESPACE
  51
  52 /*! \brief LightEnvs Base class
  53     \ingroup GrpSystemNodeCoreGroupsCores
  54     \ingroup GrpLibOSGSystem
  55     \includebasedoc
  56  */
  57
  58 class OSG_SYSTEM_DLLMAPPING LightEnv : public LightEnvBase
  59 {
  60     /*==========================  PUBLIC  =================================*/
  61
  62   public:
  63
  64     /*! \}                                                                 */
  65     /*---------------------------------------------------------------------*/
  66     /*! \name                      Sync                                    */
  67     /*! \{                                                                 */
  68
  69     virtual void changed(ConstFieldMaskArg whichField,
  70                          UInt32            origin,
  71                          BitVector         detail);
  72
  73     /*! \}                                                                 */
  74     /*---------------------------------------------------------------------*/
  75     /*! \name                      Dump                                    */
  76     /*! \{                                                                 */
  77
  78     virtual void dump(      UInt32    uiIndent = 0,
  79                       const BitVector bvFlags  = 0) const;
  80
  81     /*! \}                                                                 */
  82     /*=========================  PROTECTED  ===============================*/
  83
  84   protected:
  85
  86     typedef LightEnvBase      Inherited;
  87
  88
  89     /*---------------------------------------------------------------------*/
  90     /*! \name                   Constructors                               */
  91     /*! \{                                                                 */
  92
  93     LightEnv(void);
  94     LightEnv(const LightEnv &source);
  95
  96     /*! \}                                                                 */
  97     /*---------------------------------------------------------------------*/
  98     /*! \name                   Destructors                                */
  99     /*! \{                                                                 */
 100
 101     virtual ~LightEnv(void);
 102
 103     /*! \}                                                                 */
 104     /*---------------------------------------------------------------------*/
 105     /*! \name                     Actions                                  */
 106     /*! \{                                                                 */
 107
 108     Action::ResultE renderEnter(Action *action);
 109     Action::ResultE renderLeave(Action *action);
 110
 111     /*! \}                                                                 */
 112     /*---------------------------------------------------------------------*/
 113     /*! \name                       Init                                   */
 114     /*! \{                                                                 */
 115
 116     static void initMethod(InitPhase ePhase);
 117
 118     /*! \}                                                                 */
 119     /*==========================  PRIVATE  ================================*/
 120
 121   private:
 122
 123     friend class FieldContainer;
 124     friend class LightEnvBase;
 125
 126     /*! \brief prohibit default function (move to 'public' if needed) */
 127     void operator =(const LightEnv &source);
 128 };
 129
 130 OSG_END_NAMESPACE
 131
 132 #include "OSGLightEnvBase.inl"
 133 #include "OSGLightEnv.inl"
 134
 135 #endif /* _OSGLIGHTENV_H_ */