Source/System/NodeCores/Drawables/Geometry/Instancing/OSGGeoInstancerBase.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 GeoInstancer
  49  **                                                                         **
  50  *****************************************************************************
  51 \*****************************************************************************/
  52
  53
  54 #ifndef _OSGGEOINSTANCERBASE_H_
  55 #define _OSGGEOINSTANCERBASE_H_
  56 #ifdef __sgi
  57 #pragma once
  58 #endif
  59
  60
  61 #include "OSGConfig.h"
  62 #include "OSGDrawableDef.h"
  63
  64 //#include "OSGBaseTypes.h"
  65
  66 #include "OSGMaterialDrawable.h" // Parent
  67
  68 #include "OSGSysFields.h"               // NumInstances type
  69 #include "OSGGeometryFields.h"          // BaseGeometry type
  70
  71 #include "OSGGeoInstancerFields.h"
  72
  73 OSG_BEGIN_NAMESPACE
  74
  75
  76 class GeoInstancer;
  77
  78 //! \brief GeoInstancer Base Class.
  79
  80 class OSG_DRAWABLE_DLLMAPPING GeoInstancerBase : public MaterialDrawable
  81 {
  82   public:
  83
  84     typedef MaterialDrawable Inherited;
  85     typedef MaterialDrawable ParentContainer;
  86
  87     typedef Inherited::TypeObject TypeObject;
  88     typedef TypeObject::InitPhase InitPhase;
  89
  90     OSG_GEN_INTERNALPTR(GeoInstancer);
  91
  92     /*==========================  PUBLIC  =================================*/
  93
  94   public:
  95
  96     enum
  97     {
  98         NumInstancesFieldId = Inherited::NextFieldId,
  99         BaseGeometryFieldId = NumInstancesFieldId + 1,
 100         NextFieldId = BaseGeometryFieldId + 1
 101     };
 102
 103     static const OSG::BitVector NumInstancesFieldMask =
 104         (TypeTraits<BitVector>::One << NumInstancesFieldId);
 105     static const OSG::BitVector BaseGeometryFieldMask =
 106         (TypeTraits<BitVector>::One << BaseGeometryFieldId);
 107     static const OSG::BitVector NextFieldMask =
 108         (TypeTraits<BitVector>::One << NextFieldId);
 109
 110     typedef SFUInt32          SFNumInstancesType;
 111     typedef SFUnrecChildGeometryPtr SFBaseGeometryType;
 112
 113     /*---------------------------------------------------------------------*/
 114     /*! \name                    Class Get                                 */
 115     /*! \{                                                                 */
 116
 117     static FieldContainerType &getClassType   (void);
 118     static UInt32              getClassTypeId (void);
 119     static UInt16              getClassGroupId(void);
 120
 121     /*! \}                                                                 */
 122     /*---------------------------------------------------------------------*/
 123     /*! \name                FieldContainer Get                            */
 124     /*! \{                                                                 */
 125
 126     virtual       FieldContainerType &getType         (void);
 127     virtual const FieldContainerType &getType         (void) const;
 128
 129     virtual       UInt32              getContainerSize(void) const;
 130
 131     /*! \}                                                                 */
 132     /*---------------------------------------------------------------------*/
 133     /*! \name                    Field Get                                 */
 134     /*! \{                                                                 */
 135
 136
 137                   SFUInt32            *editSFNumInstances   (void);
 138             const SFUInt32            *getSFNumInstances    (void) const;
 139             const SFUnrecChildGeometryPtr *getSFBaseGeometry   (void) const;
 140                   SFUnrecChildGeometryPtr *editSFBaseGeometry   (void);
 141
 142
 143                   UInt32              &editNumInstances   (void);
 144                   UInt32               getNumInstances    (void) const;
 145
 146                   Geometry * getBaseGeometry   (void) const;
 147
 148     /*! \}                                                                 */
 149     /*---------------------------------------------------------------------*/
 150     /*! \name                    Field Set                                 */
 151     /*! \{                                                                 */
 152
 153             void setNumInstances   (const UInt32 value);
 154             void setBaseGeometry   (Geometry * const value);
 155
 156     /*! \}                                                                 */
 157     /*---------------------------------------------------------------------*/
 158     /*! \name                Ptr Field Set                                 */
 159     /*! \{                                                                 */
 160
 161     /*! \}                                                                 */
 162     /*---------------------------------------------------------------------*/
 163     /*! \name                Ptr MField Set                                */
 164     /*! \{                                                                 */
 165
 166     /*! \}                                                                 */
 167     /*---------------------------------------------------------------------*/
 168     /*! \name                   Binary Access                              */
 169     /*! \{                                                                 */
 170
 171     virtual SizeT  getBinSize (ConstFieldMaskArg  whichField);
 172     virtual void   copyToBin  (BinaryDataHandler &pMem,
 173                                ConstFieldMaskArg  whichField);
 174     virtual void   copyFromBin(BinaryDataHandler &pMem,
 175                                ConstFieldMaskArg  whichField);
 176
 177
 178     /*! \}                                                                 */
 179     /*---------------------------------------------------------------------*/
 180     /*! \name                   Construction                               */
 181     /*! \{                                                                 */
 182
 183     static  GeoInstancerTransitPtr  create          (void);
 184     static  GeoInstancer           *createEmpty     (void);
 185
 186     static  GeoInstancerTransitPtr  createLocal     (
 187                                                BitVector bFlags = FCLocal::All);
 188
 189     static  GeoInstancer            *createEmptyLocal(
 190                                               BitVector bFlags = FCLocal::All);
 191
 192     static  GeoInstancerTransitPtr  createDependent  (BitVector bFlags);
 193
 194     /*! \}                                                                 */
 195     /*---------------------------------------------------------------------*/
 196     /*! \name                       Copy                                   */
 197     /*! \{                                                                 */
 198
 199     virtual FieldContainerTransitPtr shallowCopy     (void) const;
 200     virtual FieldContainerTransitPtr shallowCopyLocal(
 201                                        BitVector bFlags = FCLocal::All) const;
 202     virtual FieldContainerTransitPtr shallowCopyDependent(
 203                                                       BitVector bFlags) const;
 204
 205     /*! \}                                                                 */
 206     /*=========================  PROTECTED  ===============================*/
 207
 208   protected:
 209
 210     static TypeObject _type;
 211
 212     static       void   classDescInserter(TypeObject &oType);
 213     static const Char8 *getClassname     (void             );
 214
 215     /*---------------------------------------------------------------------*/
 216     /*! \name                      Fields                                  */
 217     /*! \{                                                                 */
 218
 219     SFUInt32          _sfNumInstances;
 220     SFUnrecChildGeometryPtr _sfBaseGeometry;
 221
 222     /*! \}                                                                 */
 223     /*---------------------------------------------------------------------*/
 224     /*! \name                   Constructors                               */
 225     /*! \{                                                                 */
 226
 227     GeoInstancerBase(void);
 228     GeoInstancerBase(const GeoInstancerBase &source);
 229
 230     /*! \}                                                                 */
 231     /*---------------------------------------------------------------------*/
 232     /*! \name                   Destructors                                */
 233     /*! \{                                                                 */
 234
 235     virtual ~GeoInstancerBase(void);
 236
 237     /*! \}                                                                 */
 238     /*---------------------------------------------------------------------*/
 239     /*! \name                     onCreate                                */
 240     /*! \{                                                                 */
 241
 242     void onCreate(const GeoInstancer *source = NULL);
 243
 244     /*! \}                                                                 */
 245     /*---------------------------------------------------------------------*/
 246     /*! \name Child linking                                                */
 247     /*! \{                                                                 */
 248
 249     virtual bool unlinkChild(FieldContainer * const pChild,
 250                              UInt16           const childFieldId);
 251
 252     /*! \}                                                                 */
 253     /*---------------------------------------------------------------------*/
 254     /*! \name                    Generic Field Access                      */
 255     /*! \{                                                                 */
 256
 257      GetFieldHandlePtr  getHandleNumInstances    (void) const;
 258      EditFieldHandlePtr editHandleNumInstances   (void);
 259      GetFieldHandlePtr  getHandleBaseGeometry    (void) const;
 260      EditFieldHandlePtr editHandleBaseGeometry   (void);
 261
 262     /*! \}                                                                 */
 263     /*---------------------------------------------------------------------*/
 264     /*! \name                       Sync                                   */
 265     /*! \{                                                                 */
 266
 267 #ifdef OSG_MT_CPTR_ASPECT
 268     virtual void execSyncV(      FieldContainer    &oFrom,
 269                                  ConstFieldMaskArg  whichField,
 270                                  AspectOffsetStore &oOffsets,
 271                                  ConstFieldMaskArg  syncMode  ,
 272                            const UInt32             uiSyncInfo);
 273
 274             void execSync (      GeoInstancerBase *pFrom,
 275                                  ConstFieldMaskArg  whichField,
 276                                  AspectOffsetStore &oOffsets,
 277                                  ConstFieldMaskArg  syncMode  ,
 278                            const UInt32             uiSyncInfo);
 279 #endif
 280
 281     /*! \}                                                                 */
 282     /*---------------------------------------------------------------------*/
 283     /*! \name                       Edit                                   */
 284     /*! \{                                                                 */
 285
 286     /*! \}                                                                 */
 287     /*---------------------------------------------------------------------*/
 288     /*! \name                     Aspect Create                            */
 289     /*! \{                                                                 */
 290
 291 #ifdef OSG_MT_CPTR_ASPECT
 292     virtual FieldContainer *createAspectCopy(
 293                                     const FieldContainer *pRefAspect) const;
 294 #endif
 295
 296     /*! \}                                                                 */
 297     /*---------------------------------------------------------------------*/
 298     /*! \name                       Edit                                   */
 299     /*! \{                                                                 */
 300     /*! \}                                                                 */
 301     /*---------------------------------------------------------------------*/
 302     /*! \name                       Sync                                   */
 303     /*! \{                                                                 */
 304
 305     virtual void resolveLinks(void);
 306
 307     /*! \}                                                                 */
 308     /*==========================  PRIVATE  ================================*/
 309
 310   private:
 311     /*---------------------------------------------------------------------*/
 312
 313     // prohibit default functions (move to 'public' if you need one)
 314     void operator =(const GeoInstancerBase &source);
 315 };
 316
 317 typedef GeoInstancerBase *GeoInstancerBaseP;
 318
 319 OSG_END_NAMESPACE
 320
 321 #endif /* _OSGGEOINSTANCERBASE_H_ */