Source/System/NodeCores/Groups/Effects/DeferredShading/OSGDSLightChunk.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-2006 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 _OSGDSLIGHTCHUNK_H_
  40 #define _OSGDSLIGHTCHUNK_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGDSLightChunkBase.h"
  46
  47 #include "OSGNode.h"
  48
  49 OSG_BEGIN_NAMESPACE
  50
  51 /*! \brief DSLightChunk class. See \ref
  52            PageEffectsDSLightChunk for a description.
  53
  54     \ingroup GrpEffectsGroupsDeferredShadingObj
  55     \ingroup GrpLibOSGEffectsGroups
  56     \includebasedoc
  57  */
  58
  59 class OSG_EFFECTGROUPS_DLLMAPPING DSLightChunk : public DSLightChunkBase
  60 {
  61     /*==========================  PUBLIC  =================================*/
  62   public:
  63
  64     typedef DSLightChunkBase Inherited;
  65     typedef DSLightChunk     Self;
  66
  67     /*---------------------------------------------------------------------*/
  68     /*! \name                 Chunk Class Access                           */
  69     /*! \{                                                                 */
  70
  71     virtual const StateChunkClass *getClass(void) const;
  72
  73     /*! \}                                                                 */
  74     /*---------------------------------------------------------------------*/
  75     /*! \name                      Sync                                    */
  76     /*! \{                                                                 */
  77
  78     virtual void changed(ConstFieldMaskArg whichField,
  79                          UInt32            origin,
  80                          BitVector         details    );
  81
  82     /*! \}                                                                 */
  83     /*---------------------------------------------------------------------*/
  84     /*! \name                     Output                                   */
  85     /*! \{                                                                 */
  86
  87     virtual void dump(      UInt32     uiIndent = 0,
  88                       const BitVector  bvFlags  = 0) const;
  89
  90     /*! \}                                                                 */
  91     /*---------------------------------------------------------------------*/
  92     /*! \name                      State                                   */
  93     /*! \{                                                                 */
  94
  95     virtual void activate  (DrawEnv    *drawEnv,
  96                             UInt32      index   );
  97
  98     virtual void changeFrom(DrawEnv    *drawEnv,
  99                             StateChunk *old,
 100                             UInt32      index   );
 101
 102     virtual void deactivate(DrawEnv    *drawEnv,
 103                             UInt32      index   );
 104
 105     /*! \}                                                                 */
 106     /*---------------------------------------------------------------------*/
 107     /*! \name                   Comparison                                 */
 108     /*! \{                                                                 */
 109
 110     virtual Real32 switchCost  (StateChunk       *chunk);
 111
 112     virtual bool   operator <  (const StateChunk &other) const;
 113
 114     virtual bool   operator == (const StateChunk &other) const;
 115     virtual bool   operator != (const StateChunk &other) const;
 116
 117     /*! \}                                                                 */
 118     /*=========================  PROTECTED  ===============================*/
 119
 120   protected:
 121
 122     // Variables should all be in DSLightChunkBase.
 123
 124     /*---------------------------------------------------------------------*/
 125     /*! \name                  Constructors                                */
 126     /*! \{                                                                 */
 127
 128     DSLightChunk(void);
 129     DSLightChunk(const DSLightChunk &source);
 130
 131     /*! \}                                                                 */
 132     /*---------------------------------------------------------------------*/
 133     /*! \name                   Destructors                                */
 134     /*! \{                                                                 */
 135
 136     virtual ~DSLightChunk(void);
 137
 138     /*! \}                                                                 */
 139     /*---------------------------------------------------------------------*/
 140     /*! \name                      Init                                    */
 141     /*! \{                                                                 */
 142
 143     static void initMethod(InitPhase ePhase);
 144
 145     /*! \}                                                                 */
 146     /*---------------------------------------------------------------------*/
 147     /*! \name                     Helper                                   */
 148     /*! \{                                                                 */
 149
 150     void calcModelView(DrawEnv *drawEnv, Matrix &result);
 151
 152     /*! \}                                                                 */
 153     /*==========================  PRIVATE  ================================*/
 154
 155   private:
 156
 157     friend class FieldContainer;
 158     friend class DSLightChunkBase;
 159
 160     // class. Used for indexing in State
 161     static StateChunkClass _class;
 162
 163     // prohibit default functions (move to 'public' if you need one)
 164     void operator =(const DSLightChunk &source);
 165 };
 166
 167 typedef DSLightChunk *DSLightChunkP;
 168
 169 OSG_END_NAMESPACE
 170
 171 #include "OSGDSLightChunkBase.inl"
 172 #include "OSGDSLightChunk.inl"
 173
 174 #endif /* _OSGDSLIGHTCHUNK_H_ */