Source/System/Dynamics/Skeleton/OSGSkeletonSkinningAlgorithmBase.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 SkeletonSkinningAlgorithm
  49  **                                                                         **
  50  *****************************************************************************
  51 \*****************************************************************************/
  52
  53
  54 #ifndef _OSGSKELETONSKINNINGALGORITHMBASE_H_
  55 #define _OSGSKELETONSKINNINGALGORITHMBASE_H_
  56 #ifdef __sgi
  57 #pragma once
  58 #endif
  59
  60
  61 #include "OSGConfig.h"
  62 #include "OSGDynamicsDef.h"
  63
  64 //#include "OSGBaseTypes.h"
  65
  66 #include "OSGSkinningAlgorithm.h" // Parent
  67
  68 #include "OSGVecFields.h"               // DrawPositions type
  69 #include "OSGSysFields.h"               // DrawIndex type
  70
  71 #include "OSGSkeletonSkinningAlgorithmFields.h"
  72
  73 OSG_BEGIN_NAMESPACE
  74
  75
  76 class SkeletonSkinningAlgorithm;
  77
  78 //! \brief SkeletonSkinningAlgorithm Base Class.
  79
  80 class OSG_DYNAMICS_DLLMAPPING SkeletonSkinningAlgorithmBase : public SkinningAlgorithm
  81 {
  82   public:
  83
  84     typedef SkinningAlgorithm Inherited;
  85     typedef SkinningAlgorithm ParentContainer;
  86
  87     typedef Inherited::TypeObject TypeObject;
  88     typedef TypeObject::InitPhase InitPhase;
  89
  90     OSG_GEN_INTERNALPTR(SkeletonSkinningAlgorithm);
  91
  92     /*==========================  PUBLIC  =================================*/
  93
  94   public:
  95
  96     enum
  97     {
  98         DrawPositionsFieldId = Inherited::NextFieldId,
  99         DrawIndexFieldId = DrawPositionsFieldId + 1,
 100         NextFieldId = DrawIndexFieldId + 1
 101     };
 102
 103     static const OSG::BitVector DrawPositionsFieldMask =
 104         (TypeTraits<BitVector>::One << DrawPositionsFieldId);
 105     static const OSG::BitVector DrawIndexFieldMask =
 106         (TypeTraits<BitVector>::One << DrawIndexFieldId);
 107     static const OSG::BitVector NextFieldMask =
 108         (TypeTraits<BitVector>::One << NextFieldId);
 109
 110     typedef MFPnt3f           MFDrawPositionsType;
 111     typedef MFUInt32          MFDrawIndexType;
 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                   Binary Access                              */
 134     /*! \{                                                                 */
 135
 136     virtual SizeT  getBinSize (ConstFieldMaskArg  whichField);
 137     virtual void   copyToBin  (BinaryDataHandler &pMem,
 138                                ConstFieldMaskArg  whichField);
 139     virtual void   copyFromBin(BinaryDataHandler &pMem,
 140                                ConstFieldMaskArg  whichField);
 141
 142
 143     /*! \}                                                                 */
 144     /*---------------------------------------------------------------------*/
 145     /*! \name                   Construction                               */
 146     /*! \{                                                                 */
 147
 148     static  SkeletonSkinningAlgorithmTransitPtr  create          (void);
 149     static  SkeletonSkinningAlgorithm           *createEmpty     (void);
 150
 151     static  SkeletonSkinningAlgorithmTransitPtr  createLocal     (
 152                                                BitVector bFlags = FCLocal::All);
 153
 154     static  SkeletonSkinningAlgorithm            *createEmptyLocal(
 155                                               BitVector bFlags = FCLocal::All);
 156
 157     static  SkeletonSkinningAlgorithmTransitPtr  createDependent  (BitVector bFlags);
 158
 159     /*! \}                                                                 */
 160     /*---------------------------------------------------------------------*/
 161     /*! \name                       Copy                                   */
 162     /*! \{                                                                 */
 163
 164     virtual FieldContainerTransitPtr shallowCopy     (void) const;
 165     virtual FieldContainerTransitPtr shallowCopyLocal(
 166                                        BitVector bFlags = FCLocal::All) const;
 167     virtual FieldContainerTransitPtr shallowCopyDependent(
 168                                                       BitVector bFlags) const;
 169
 170     /*! \}                                                                 */
 171     /*=========================  PROTECTED  ===============================*/
 172
 173   protected:
 174
 175     static TypeObject _type;
 176
 177     static       void   classDescInserter(TypeObject &oType);
 178     static const Char8 *getClassname     (void             );
 179
 180     /*---------------------------------------------------------------------*/
 181     /*! \name                      Fields                                  */
 182     /*! \{                                                                 */
 183
 184     MFPnt3f           _mfDrawPositions;
 185     MFUInt32          _mfDrawIndex;
 186
 187     /*! \}                                                                 */
 188     /*---------------------------------------------------------------------*/
 189     /*! \name                   Constructors                               */
 190     /*! \{                                                                 */
 191
 192     SkeletonSkinningAlgorithmBase(void);
 193     SkeletonSkinningAlgorithmBase(const SkeletonSkinningAlgorithmBase &source);
 194
 195     /*! \}                                                                 */
 196     /*---------------------------------------------------------------------*/
 197     /*! \name                   Destructors                                */
 198     /*! \{                                                                 */
 199
 200     virtual ~SkeletonSkinningAlgorithmBase(void);
 201
 202     /*! \}                                                                 */
 203     /*---------------------------------------------------------------------*/
 204     /*! \name                     onCreate                                */
 205     /*! \{                                                                 */
 206
 207
 208     /*! \}                                                                 */
 209     /*---------------------------------------------------------------------*/
 210     /*! \name                    Generic Field Access                      */
 211     /*! \{                                                                 */
 212
 213      GetFieldHandlePtr  getHandleDrawPositions   (void) const;
 214      EditFieldHandlePtr editHandleDrawPositions  (void);
 215      GetFieldHandlePtr  getHandleDrawIndex       (void) const;
 216      EditFieldHandlePtr editHandleDrawIndex      (void);
 217
 218     /*! \}                                                                 */
 219     /*---------------------------------------------------------------------*/
 220     /*! \name                    Field Get                                 */
 221     /*! \{                                                                 */
 222
 223
 224                   MFPnt3f             *editMFDrawPositions  (void);
 225             const MFPnt3f             *getMFDrawPositions   (void) const;
 226
 227                   MFUInt32            *editMFDrawIndex      (void);
 228             const MFUInt32            *getMFDrawIndex       (void) const;
 229
 230
 231                   MFPnt3f            ::reference editDrawPositions  (const UInt32 index);
 232             const Pnt3f               &getDrawPositions   (const UInt32 index) const;
 233
 234                   MFUInt32           ::reference editDrawIndex      (const UInt32 index);
 235                   UInt32               getDrawIndex       (const UInt32 index) const;
 236
 237     /*! \}                                                                 */
 238     /*---------------------------------------------------------------------*/
 239     /*! \name                    Field Set                                 */
 240     /*! \{                                                                 */
 241
 242
 243     /*! \}                                                                 */
 244     /*---------------------------------------------------------------------*/
 245     /*! \name                Ptr MField Set                                */
 246     /*! \{                                                                 */
 247
 248     /*! \}                                                                 */
 249     /*---------------------------------------------------------------------*/
 250     /*! \name                       Sync                                   */
 251     /*! \{                                                                 */
 252
 253 #ifdef OSG_MT_CPTR_ASPECT
 254     virtual void execSyncV(      FieldContainer    &oFrom,
 255                                  ConstFieldMaskArg  whichField,
 256                                  AspectOffsetStore &oOffsets,
 257                                  ConstFieldMaskArg  syncMode  ,
 258                            const UInt32             uiSyncInfo);
 259
 260             void execSync (      SkeletonSkinningAlgorithmBase *pFrom,
 261                                  ConstFieldMaskArg  whichField,
 262                                  AspectOffsetStore &oOffsets,
 263                                  ConstFieldMaskArg  syncMode  ,
 264                            const UInt32             uiSyncInfo);
 265 #endif
 266
 267     /*! \}                                                                 */
 268     /*---------------------------------------------------------------------*/
 269     /*! \name                       Edit                                   */
 270     /*! \{                                                                 */
 271
 272     /*! \}                                                                 */
 273     /*---------------------------------------------------------------------*/
 274     /*! \name                     Aspect Create                            */
 275     /*! \{                                                                 */
 276
 277 #ifdef OSG_MT_CPTR_ASPECT
 278     virtual FieldContainer *createAspectCopy(
 279                                     const FieldContainer *pRefAspect) const;
 280 #endif
 281
 282     /*! \}                                                                 */
 283     /*---------------------------------------------------------------------*/
 284     /*! \name                       Edit                                   */
 285     /*! \{                                                                 */
 286     /*! \}                                                                 */
 287     /*---------------------------------------------------------------------*/
 288     /*! \name                       Sync                                   */
 289     /*! \{                                                                 */
 290
 291     virtual void resolveLinks(void);
 292
 293     /*! \}                                                                 */
 294     /*==========================  PRIVATE  ================================*/
 295
 296   private:
 297     /*---------------------------------------------------------------------*/
 298
 299     // prohibit default functions (move to 'public' if you need one)
 300     void operator =(const SkeletonSkinningAlgorithmBase &source);
 301 };
 302
 303 typedef SkeletonSkinningAlgorithmBase *SkeletonSkinningAlgorithmBaseP;
 304
 305 OSG_END_NAMESPACE
 306
 307 #endif /* _OSGSKELETONSKINNINGALGORITHMBASE_H_ */