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