Source/System/State/Base/OSGUniformBufferObjBaseChunk.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-2013 by the OpenSG Forum                 *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  * contact: dirk@opensg.org, gerrit.voss@vossg.org, carsten_neumann@gmx.net  *
  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 _OSGUNIFORMBUFFEROBJBASECHUNK_H_
  40 #define _OSGUNIFORMBUFFEROBJBASECHUNK_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGUniformBufferObjBaseChunkBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 /*! \brief UniformBufferObjBaseChunk class. See \ref
  50            PageSystemUniformBufferObjBaseChunk for a description.
  51 */
  52
  53 class OSG_SYSTEM_DLLMAPPING UniformBufferObjBaseChunk : public UniformBufferObjBaseChunkBase
  54 {
  55   protected:
  56
  57     /*==========================  PUBLIC  =================================*/
  58
  59   public:
  60
  61     typedef UniformBufferObjBaseChunkBase Inherited;
  62     typedef UniformBufferObjBaseChunk     Self;
  63
  64     /*---------------------------------------------------------------------*/
  65     /*! \name                 Chunk Class Access                           */
  66     /*! \{                                                                 */
  67
  68     virtual const StateChunkClass *getClass(void) const;
  69
  70     /*! \}                                                                 */
  71     /*---------------------------------------------------------------------*/
  72     /*! \name              Static Chunk Class Access                       */
  73     /*! \{                                                                 */
  74
  75     static       UInt32           getStaticClassId(void);
  76     static const StateChunkClass *getStaticClass  (void);
  77
  78     /*! \}                                                                 */
  79     /*---------------------------------------------------------------------*/
  80     /*! \name                    Chunk Id                                  */
  81     /*! \{                                                                 */
  82
  83     virtual UInt16 getChunkId(void);
  84
  85     /*! \}                                                                 */
  86
  87     /*---------------------------------------------------------------------*/
  88     /*! \name                      Sync                                    */
  89     /*! \{                                                                 */
  90
  91     virtual void changed(ConstFieldMaskArg whichField,
  92                          UInt32            origin,
  93                          BitVector         details    );
  94
  95     /*! \}                                                                 */
  96     /*---------------------------------------------------------------------*/
  97     /*! \name                     Output                                   */
  98     /*! \{                                                                 */
  99
 100     virtual void dump(      UInt32     uiIndent = 0,
 101                       const BitVector  bvFlags  = 0) const;
 102
 103     /*! \}                                                                 */
 104     /*---------------------------------------------------------------------*/
 105     /*! \name                       query                                  */
 106     /*! \{                                                                 */
 107
 108     virtual void   validate               (DrawEnv *pEnv) = 0;
 109     virtual Int32  getOpenGLId            (DrawEnv *pEnv) = 0;
 110
 111     /*! \}                                                                 */
 112     /*=========================  PROTECTED  ===============================*/
 113
 114   protected:
 115     UInt16 _uiChunkId;
 116
 117     // Variables should all be in UniformBufferObjBaseChunkBase.
 118     /*---------------------------------------------------------------------*/
 119     /*! \name                       Init                                   */
 120     /*! \{                                                                 */
 121
 122     void onCreate      (const UniformBufferObjBaseChunk *source      = NULL);
 123     void onCreateAspect(const UniformBufferObjBaseChunk *createAspect,
 124                         const UniformBufferObjBaseChunk *source      = NULL);
 125
 126     /*! \}                                                                 */
 127     /*---------------------------------------------------------------------*/
 128     /*! \name                  Constructors                                */
 129     /*! \{                                                                 */
 130
 131     UniformBufferObjBaseChunk(void);
 132     UniformBufferObjBaseChunk(const UniformBufferObjBaseChunk &source);
 133
 134     /*! \}                                                                 */
 135     /*---------------------------------------------------------------------*/
 136     /*! \name                   Destructors                                */
 137     /*! \{                                                                 */
 138
 139     virtual ~UniformBufferObjBaseChunk(void);
 140
 141     /*! \}                                                                 */
 142     /*---------------------------------------------------------------------*/
 143     /*! \name                      Init                                    */
 144     /*! \{                                                                 */
 145
 146     static void initMethod(InitPhase ePhase);
 147
 148     static StateChunkClass _class;
 149     static volatile UInt16 _uiChunkCounter;
 150
 151     /*! \}                                                                 */
 152     /*==========================  PRIVATE  ================================*/
 153
 154   private:
 155
 156     friend class FieldContainer;
 157     friend class UniformBufferObjBaseChunkBase;
 158
 159     // prohibit default functions (move to 'public' if you need one)
 160     void operator =(const UniformBufferObjBaseChunk &source);
 161 };
 162
 163 typedef UniformBufferObjBaseChunk *UniformBufferObjBaseChunkP;
 164
 165 OSG_END_NAMESPACE
 166
 167 #include "OSGUniformBufferObjBaseChunkBase.inl"
 168 #include "OSGUniformBufferObjBaseChunk.inl"
 169
 170 #endif /* _OSGUNIFORMBUFFEROBJBASECHUNK_H_ */