Source/System/NodeCores/Groups/Base/OSGLightEnvBase.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 /*****************************************************************************\
  40  *****************************************************************************
  41  **                                                                         **
  42  **                  This file is automatically generated.                  **
  43  **                                                                         **
  44  **          Any changes made to this file WILL be lost when it is          **
  45  **           regenerated, which can become necessary at any time.          **
  46  **                                                                         **
  47  **     Do not change this file, changes should be done in the derived      **
  48  **     class LightEnv
  49  **                                                                         **
  50  *****************************************************************************
  51 \*****************************************************************************/
  52
  53
  54 #ifndef _OSGLIGHTENVBASE_H_
  55 #define _OSGLIGHTENVBASE_H_
  56 #ifdef __sgi
  57 #pragma once
  58 #endif
  59
  60
  61 #include "OSGConfig.h"
  62 #include "OSGSystemDef.h"
  63
  64 //#include "OSGBaseTypes.h"
  65
  66 #include "OSGNodeCore.h" // Parent
  67
  68
  69 #include "OSGLightEnvFields.h"
  70
  71 OSG_BEGIN_NAMESPACE
  72
  73
  74 class LightEnv;
  75
  76 //! \brief LightEnv Base Class.
  77
  78 class OSG_SYSTEM_DLLMAPPING LightEnvBase : public NodeCore
  79 {
  80   public:
  81
  82     typedef NodeCore Inherited;
  83     typedef NodeCore ParentContainer;
  84
  85     typedef Inherited::TypeObject TypeObject;
  86     typedef TypeObject::InitPhase InitPhase;
  87
  88     OSG_GEN_INTERNALPTR(LightEnv);
  89
  90     /*==========================  PUBLIC  =================================*/
  91
  92   public:
  93
  94
  95     /*---------------------------------------------------------------------*/
  96     /*! \name                    Class Get                                 */
  97     /*! \{                                                                 */
  98
  99     static FieldContainerType &getClassType   (void);
 100     static UInt32              getClassTypeId (void);
 101     static UInt16              getClassGroupId(void);
 102
 103     /*! \}                                                                 */
 104     /*---------------------------------------------------------------------*/
 105     /*! \name                FieldContainer Get                            */
 106     /*! \{                                                                 */
 107
 108     virtual       FieldContainerType &getType         (void);
 109     virtual const FieldContainerType &getType         (void) const;
 110
 111     virtual       UInt32              getContainerSize(void) const;
 112
 113     /*! \}                                                                 */
 114     /*---------------------------------------------------------------------*/
 115     /*! \name                   Binary Access                              */
 116     /*! \{                                                                 */
 117
 118     virtual SizeT  getBinSize (ConstFieldMaskArg  whichField);
 119     virtual void   copyToBin  (BinaryDataHandler &pMem,
 120                                ConstFieldMaskArg  whichField);
 121     virtual void   copyFromBin(BinaryDataHandler &pMem,
 122                                ConstFieldMaskArg  whichField);
 123
 124
 125     /*! \}                                                                 */
 126     /*---------------------------------------------------------------------*/
 127     /*! \name                   Construction                               */
 128     /*! \{                                                                 */
 129
 130     static  LightEnvTransitPtr  create          (void);
 131     static  LightEnv           *createEmpty     (void);
 132
 133     static  LightEnvTransitPtr  createLocal     (
 134                                                BitVector bFlags = FCLocal::All);
 135
 136     static  LightEnv            *createEmptyLocal(
 137                                               BitVector bFlags = FCLocal::All);
 138
 139     static  LightEnvTransitPtr  createDependent  (BitVector bFlags);
 140
 141     /*! \}                                                                 */
 142     /*---------------------------------------------------------------------*/
 143     /*! \name                       Copy                                   */
 144     /*! \{                                                                 */
 145
 146     virtual FieldContainerTransitPtr shallowCopy     (void) const;
 147     virtual FieldContainerTransitPtr shallowCopyLocal(
 148                                        BitVector bFlags = FCLocal::All) const;
 149     virtual FieldContainerTransitPtr shallowCopyDependent(
 150                                                       BitVector bFlags) const;
 151
 152     /*! \}                                                                 */
 153     /*=========================  PROTECTED  ===============================*/
 154
 155   protected:
 156
 157     static TypeObject _type;
 158
 159     static       void   classDescInserter(TypeObject &oType);
 160     static const Char8 *getClassname     (void             );
 161
 162     /*---------------------------------------------------------------------*/
 163     /*! \name                   Constructors                               */
 164     /*! \{                                                                 */
 165
 166     LightEnvBase(void);
 167     LightEnvBase(const LightEnvBase &source);
 168
 169     /*! \}                                                                 */
 170     /*---------------------------------------------------------------------*/
 171     /*! \name                   Destructors                                */
 172     /*! \{                                                                 */
 173
 174     virtual ~LightEnvBase(void);
 175
 176     /*! \}                                                                 */
 177     /*---------------------------------------------------------------------*/
 178     /*! \name                     onCreate                                */
 179     /*! \{                                                                 */
 180
 181
 182     /*! \}                                                                 */
 183     /*---------------------------------------------------------------------*/
 184     /*! \name                    Generic Field Access                      */
 185     /*! \{                                                                 */
 186
 187
 188     /*! \}                                                                 */
 189     /*---------------------------------------------------------------------*/
 190     /*! \name                       Sync                                   */
 191     /*! \{                                                                 */
 192
 193 #ifdef OSG_MT_CPTR_ASPECT
 194     virtual void execSyncV(      FieldContainer    &oFrom,
 195                                  ConstFieldMaskArg  whichField,
 196                                  AspectOffsetStore &oOffsets,
 197                                  ConstFieldMaskArg  syncMode  ,
 198                            const UInt32             uiSyncInfo);
 199
 200             void execSync (      LightEnvBase *pFrom,
 201                                  ConstFieldMaskArg  whichField,
 202                                  AspectOffsetStore &oOffsets,
 203                                  ConstFieldMaskArg  syncMode  ,
 204                            const UInt32             uiSyncInfo);
 205 #endif
 206
 207     /*! \}                                                                 */
 208     /*---------------------------------------------------------------------*/
 209     /*! \name                       Edit                                   */
 210     /*! \{                                                                 */
 211
 212     /*! \}                                                                 */
 213     /*---------------------------------------------------------------------*/
 214     /*! \name                     Aspect Create                            */
 215     /*! \{                                                                 */
 216
 217 #ifdef OSG_MT_CPTR_ASPECT
 218     virtual FieldContainer *createAspectCopy(
 219                                     const FieldContainer *pRefAspect) const;
 220 #endif
 221
 222     /*! \}                                                                 */
 223     /*---------------------------------------------------------------------*/
 224     /*! \name                       Edit                                   */
 225     /*! \{                                                                 */
 226     /*! \}                                                                 */
 227     /*---------------------------------------------------------------------*/
 228     /*! \name                       Sync                                   */
 229     /*! \{                                                                 */
 230
 231     virtual void resolveLinks(void);
 232
 233     /*! \}                                                                 */
 234     /*==========================  PRIVATE  ================================*/
 235
 236   private:
 237     /*---------------------------------------------------------------------*/
 238
 239     // prohibit default functions (move to 'public' if you need one)
 240     void operator =(const LightEnvBase &source);
 241 };
 242
 243 typedef LightEnvBase *LightEnvBaseP;
 244
 245 typedef CoredNodeRefPtr  <LightEnv> LightEnvNodeRefPtr;
 246 typedef CoredNodeMTRefPtr<LightEnv> LightEnvNodeMTRefPtr;
 247
 248 OSG_END_NAMESPACE
 249
 250 #endif /* _OSGLIGHTENVBASE_H_ */