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