Source/System/Material/Base/OSGMaterialBase.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 Material
  49  **                                                                         **
  50  *****************************************************************************
  51 \*****************************************************************************/
  52
  53
  54 #ifndef _OSGMATERIALBASE_H_
  55 #define _OSGMATERIALBASE_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 "OSGAttachment.h" // Parent
  67
  68 #include "OSGSysFields.h"               // SortKey type
  69
  70 #include "OSGMaterialFields.h"
  71
  72 OSG_BEGIN_NAMESPACE
  73
  74
  75 class Material;
  76
  77 //! \brief Material Base Class.
  78
  79 class OSG_SYSTEM_DLLMAPPING MaterialBase : public Attachment
  80 {
  81   public:
  82
  83     typedef Attachment Inherited;
  84     typedef Attachment ParentContainer;
  85
  86     typedef Inherited::TypeObject TypeObject;
  87     typedef TypeObject::InitPhase InitPhase;
  88
  89     OSG_GEN_INTERNALPTR(Material);
  90
  91     /*==========================  PUBLIC  =================================*/
  92
  93   public:
  94
  95     enum
  96     {
  97         SortKeyFieldId = Inherited::NextFieldId,
  98         TransparencyModeFieldId = SortKeyFieldId + 1,
  99         NextFieldId = TransparencyModeFieldId + 1
 100     };
 101
 102     static const OSG::BitVector SortKeyFieldMask =
 103         (TypeTraits<BitVector>::One << SortKeyFieldId);
 104     static const OSG::BitVector TransparencyModeFieldMask =
 105         (TypeTraits<BitVector>::One << TransparencyModeFieldId);
 106     static const OSG::BitVector NextFieldMask =
 107         (TypeTraits<BitVector>::One << NextFieldId);
 108
 109     typedef SFInt32           SFSortKeyType;
 110     typedef SFInt32           SFTransparencyModeType;
 111
 112     /*---------------------------------------------------------------------*/
 113     /*! \name                    Class Get                                 */
 114     /*! \{                                                                 */
 115
 116     static FieldContainerType &getClassType   (void);
 117     static UInt32              getClassTypeId (void);
 118     static UInt16              getClassGroupId(void);
 119
 120     /*! \}                                                                 */
 121     /*---------------------------------------------------------------------*/
 122     /*! \name                FieldContainer Get                            */
 123     /*! \{                                                                 */
 124
 125     virtual       FieldContainerType &getType         (void);
 126     virtual const FieldContainerType &getType         (void) const;
 127
 128     virtual       UInt32              getContainerSize(void) const;
 129
 130     /*! \}                                                                 */
 131     /*---------------------------------------------------------------------*/
 132     /*! \name                    Field Get                                 */
 133     /*! \{                                                                 */
 134
 135
 136                   SFInt32             *editSFSortKey        (void);
 137             const SFInt32             *getSFSortKey         (void) const;
 138
 139                   SFInt32             *editSFTransparencyMode(void);
 140             const SFInt32             *getSFTransparencyMode (void) const;
 141
 142
 143                   Int32               &editSortKey        (void);
 144                   Int32                getSortKey         (void) const;
 145
 146                   Int32               &editTransparencyMode(void);
 147                   Int32                getTransparencyMode (void) const;
 148
 149     /*! \}                                                                 */
 150     /*---------------------------------------------------------------------*/
 151     /*! \name                    Field Set                                 */
 152     /*! \{                                                                 */
 153
 154             void setSortKey        (const Int32 value);
 155             void setTransparencyMode(const Int32 value);
 156
 157     /*! \}                                                                 */
 158     /*---------------------------------------------------------------------*/
 159     /*! \name                Ptr MField Set                                */
 160     /*! \{                                                                 */
 161
 162     /*! \}                                                                 */
 163     /*---------------------------------------------------------------------*/
 164     /*! \name                   Binary Access                              */
 165     /*! \{                                                                 */
 166
 167     virtual SizeT  getBinSize (ConstFieldMaskArg  whichField);
 168     virtual void   copyToBin  (BinaryDataHandler &pMem,
 169                                ConstFieldMaskArg  whichField);
 170     virtual void   copyFromBin(BinaryDataHandler &pMem,
 171                                ConstFieldMaskArg  whichField);
 172
 173
 174     /*! \}                                                                 */
 175     /*=========================  PROTECTED  ===============================*/
 176
 177   protected:
 178
 179     static TypeObject _type;
 180
 181     static       void   classDescInserter(TypeObject &oType);
 182     static const Char8 *getClassname     (void             );
 183
 184     /*---------------------------------------------------------------------*/
 185     /*! \name                      Fields                                  */
 186     /*! \{                                                                 */
 187
 188     SFInt32           _sfSortKey;
 189     SFInt32           _sfTransparencyMode;
 190
 191     /*! \}                                                                 */
 192     /*---------------------------------------------------------------------*/
 193     /*! \name                   Constructors                               */
 194     /*! \{                                                                 */
 195
 196     MaterialBase(void);
 197     MaterialBase(const MaterialBase &source);
 198
 199     /*! \}                                                                 */
 200     /*---------------------------------------------------------------------*/
 201     /*! \name                   Destructors                                */
 202     /*! \{                                                                 */
 203
 204     virtual ~MaterialBase(void);
 205
 206     /*! \}                                                                 */
 207     /*---------------------------------------------------------------------*/
 208     /*! \name                     onCreate                                */
 209     /*! \{                                                                 */
 210
 211
 212     /*! \}                                                                 */
 213     /*---------------------------------------------------------------------*/
 214     /*! \name                    Generic Field Access                      */
 215     /*! \{                                                                 */
 216
 217      GetFieldHandlePtr  getHandleSortKey         (void) const;
 218      EditFieldHandlePtr editHandleSortKey        (void);
 219      GetFieldHandlePtr  getHandleTransparencyMode (void) const;
 220      EditFieldHandlePtr editHandleTransparencyMode(void);
 221
 222     /*! \}                                                                 */
 223     /*---------------------------------------------------------------------*/
 224     /*! \name                       Sync                                   */
 225     /*! \{                                                                 */
 226
 227 #ifdef OSG_MT_CPTR_ASPECT
 228     virtual void execSyncV(      FieldContainer    &oFrom,
 229                                  ConstFieldMaskArg  whichField,
 230                                  AspectOffsetStore &oOffsets,
 231                                  ConstFieldMaskArg  syncMode  ,
 232                            const UInt32             uiSyncInfo);
 233
 234             void execSync (      MaterialBase *pFrom,
 235                                  ConstFieldMaskArg  whichField,
 236                                  AspectOffsetStore &oOffsets,
 237                                  ConstFieldMaskArg  syncMode  ,
 238                            const UInt32             uiSyncInfo);
 239 #endif
 240
 241     /*! \}                                                                 */
 242     /*---------------------------------------------------------------------*/
 243     /*! \name                       Edit                                   */
 244     /*! \{                                                                 */
 245
 246     /*! \}                                                                 */
 247     /*---------------------------------------------------------------------*/
 248     /*! \name                     Aspect Create                            */
 249     /*! \{                                                                 */
 250
 251     /*! \}                                                                 */
 252     /*---------------------------------------------------------------------*/
 253     /*! \name                       Edit                                   */
 254     /*! \{                                                                 */
 255     /*! \}                                                                 */
 256     /*---------------------------------------------------------------------*/
 257     /*! \name                       Sync                                   */
 258     /*! \{                                                                 */
 259
 260     virtual void resolveLinks(void);
 261
 262     /*! \}                                                                 */
 263     /*==========================  PRIVATE  ================================*/
 264
 265   private:
 266     /*---------------------------------------------------------------------*/
 267
 268     // prohibit default functions (move to 'public' if you need one)
 269     void operator =(const MaterialBase &source);
 270 };
 271
 272 typedef MaterialBase *MaterialBaseP;
 273
 274 OSG_END_NAMESPACE
 275
 276 #endif /* _OSGMATERIALBASE_H_ */