Source/System/NodeCores/Groups/Light/OSGDirectionalLight.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 _OSGDIRECTIONALLIGHT_H_
  40 #define _OSGDIRECTIONALLIGHT_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGDirectionalLightBase.h"
  46 #include "OSGStatIntElem.h"
  47 #include "OSGStatElemDesc.h"
  48
  49 OSG_BEGIN_NAMESPACE
  50
  51 /*! \brief Directional light
  52     \ingroup GrpGroupLightObj
  53     \ingroup GrpLibOSGGroup
  54     \includebasedoc
  55  */
  56
  57 class OSG_GROUP_DLLMAPPING DirectionalLight : public DirectionalLightBase
  58 {
  59     /*==========================  PUBLIC  =================================*/
  60
  61   public:
  62
  63     /*---------------------------------------------------------------------*/
  64     /*! \name                  static stat elem                            */
  65     /*! \{                                                                 */
  66
  67     static StatElemDesc<StatIntElem>  statNDirectionalLights;
  68
  69     /*! \}                                                                 */
  70     /*---------------------------------------------------------------------*/
  71     /*! \name                       Set                                    */
  72     /*! \{                                                                 */
  73
  74     void setDirection(      Real32  rX,
  75                             Real32  rY,
  76                             Real32  rZ);
  77     void setDirection(const Vec3f  &direction);
  78
  79     /*! \}                                                                 */
  80     /*---------------------------------------------------------------------*/
  81     /*! \name                      Sync                                    */
  82     /*! \{                                                                 */
  83
  84     virtual void changed(ConstFieldMaskArg whichField,
  85                          UInt32            origin,
  86                          BitVector         detail);
  87
  88     /*! \}                                                                 */
  89     /*---------------------------------------------------------------------*/
  90     /*! \name                      Chunk                                   */
  91     /*! \{                                                                 */
  92
  93     virtual void makeChunk(void);
  94
  95     /*! \}                                                                 */
  96     /*---------------------------------------------------------------------*/
  97     /*! \name                  LightEngine                                 */
  98     /*! \{                                                                 */
  99
 100     virtual void callLightEngineEnter(RenderAction *ract);
 101     virtual void callLightEngineLeave(RenderAction *ract);
 102
 103     /*! \}                                                                 */
 104     /*---------------------------------------------------------------------*/
 105     /*! \name                      Dump                                    */
 106     /*! \{                                                                 */
 107
 108     virtual void dump(      UInt32    uiIndent = 0,
 109                       const BitVector bvFlags  = 0) const;
 110
 111     /*! \}                                                                 */
 112     /*=========================  PROTECTED  ===============================*/
 113
 114   protected:
 115
 116     typedef DirectionalLightBase Inherited;
 117
 118     /*---------------------------------------------------------------------*/
 119     /*! \name                   Constructors                               */
 120     /*! \{                                                                 */
 121
 122     DirectionalLight(void);
 123     DirectionalLight(const DirectionalLight &source);
 124
 125     /*! \}                                                                 */
 126     /*---------------------------------------------------------------------*/
 127     /*! \name                   Destructors                                */
 128     /*! \{                                                                 */
 129
 130     virtual ~DirectionalLight(void);
 131
 132     /*! \}                                                                 */
 133     /*---------------------------------------------------------------------*/
 134     /*! \name                       Init                                   */
 135     /*! \{                                                                 */
 136
 137     static void initMethod(InitPhase ePhase);
 138
 139     /*! \}                                                                 */
 140     /*---------------------------------------------------------------------*/
 141     /*! \name                       Actions                                */
 142     /*! \{                                                                 */
 143
 144     Action::ResultE renderEnter(Action *action);
 145     Action::ResultE renderLeave(Action *action);
 146
 147     /*! \}                                                                 */
 148     /*==========================  PRIVATE  ================================*/
 149
 150   private:
 151
 152     friend class FieldContainer;
 153     friend class DirectionalLightBase;
 154
 155     /*! \brief prohibit default function (move to 'public' if needed) */
 156     void operator =(const DirectionalLight &source);
 157 };
 158
 159 typedef DirectionalLight *DirectionalLightP;
 160
 161 OSG_END_NAMESPACE
 162
 163 #include "OSGDirectionalLightBase.inl"
 164 #include "OSGDirectionalLight.inl"
 165
 166 #endif /* _OSGDIRECTIONALLIGHT_H_ */
 167