Source/System/Dynamics/Skeleton/OSGSkinningAlgorithmBase.cpp

   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 SkinningAlgorithm!
  49  **                                                                         **
  50  *****************************************************************************
  51 \*****************************************************************************/
  52
  53 #include <cstdlib>
  54 #include <cstdio>
  55
  56 #ifdef WIN32
  57 #pragma warning(disable: 4355) // turn off 'this' : used in base member initializer list warning
  58 #pragma warning(disable: 4290) // disable exception specification warning
  59 #endif
  60
  61 #include "OSGConfig.h"
  62
  63
  64
  65 #include "OSGSkinnedGeometry.h"         // Skin Class
  66 #include "OSGSkeleton.h"                // Skeleton Class
  67
  68 #include "OSGSkinningAlgorithmBase.h"
  69 #include "OSGSkinningAlgorithm.h"
  70
  71 #include <boost/bind.hpp>
  72
  73 OSG_BEGIN_NAMESPACE
  74
  75 /***************************************************************************\
  76  *                            Description                                  *
  77 \***************************************************************************/
  78
  79 /*! \class OSG::SkinningAlgorithm
  80
  81  */
  82
  83 /***************************************************************************\
  84  *                        Field Documentation                              *
  85 \***************************************************************************/
  86
  87 /*! \var SkinnedGeometry * SkinningAlgorithmBase::_sfSkin
  88
  89 */
  90
  91 /*! \var Skeleton *      SkinningAlgorithmBase::_sfSkeleton
  92
  93 */
  94
  95
  96 /***************************************************************************\
  97  *                      FieldType/FieldTrait Instantiation                 *
  98 \***************************************************************************/
  99
 100 #if !defined(OSG_DO_DOC) || defined(OSG_DOC_DEV)
 101 PointerType FieldTraits<SkinningAlgorithm *, nsOSG>::_type(
 102     "SkinningAlgorithmPtr",
 103     "AlgorithmPtr",
 104     SkinningAlgorithm::getClassType(),
 105     nsOSG);
 106 #endif
 107
 108 OSG_FIELDTRAITS_GETTYPE_NS(SkinningAlgorithm *, nsOSG)
 109
 110 OSG_EXPORT_PTR_SFIELD_FULL(PointerSField,
 111                            SkinningAlgorithm *,
 112                            nsOSG)
 113
 114 OSG_EXPORT_PTR_MFIELD_FULL(PointerMField,
 115                            SkinningAlgorithm *,
 116                            nsOSG)
 117
 118 DataType &FieldTraits< SkinningAlgorithm *, nsOSG + 1 >::getType(void)
 119 {
 120     return FieldTraits<SkinningAlgorithm *, nsOSG>::getType();
 121 }
 122
 123
 124 OSG_EXPORT_PTR_SFIELD(ChildPointerSField,
 125                       SkinningAlgorithm *,
 126                       UnrecordedRefCountPolicy,
 127                       nsOSG + 1)
 128
 129
 130 OSG_EXPORT_PTR_MFIELD(ChildPointerMField,
 131                       SkinningAlgorithm *,
 132                       UnrecordedRefCountPolicy,
 133                       nsOSG + 1)
 134
 135
 136 /***************************************************************************\
 137  *                         Field Description                               *
 138 \***************************************************************************/
 139
 140 void SkinningAlgorithmBase::classDescInserter(TypeObject &oType)
 141 {
 142     FieldDescriptionBase *pDesc = NULL;
 143
 144
 145     pDesc = new SFParentSkinnedGeometryPtr::Description(
 146         SFParentSkinnedGeometryPtr::getClassType(),
 147         "skin",
 148         "",
 149         SkinFieldId, SkinFieldMask,
 150         false,
 151         (Field::SFDefaultFlags | Field::FStdAccess),
 152         static_cast     <FieldEditMethodSig>(&SkinningAlgorithm::invalidEditField),
 153         static_cast     <FieldGetMethodSig >(&SkinningAlgorithm::invalidGetField));
 154
 155     oType.addInitialDesc(pDesc);
 156
 157     pDesc = new SFUnrecSkeletonPtr::Description(
 158         SFUnrecSkeletonPtr::getClassType(),
 159         "skeleton",
 160         "",
 161         SkeletonFieldId, SkeletonFieldMask,
 162         false,
 163         (Field::SFDefaultFlags | Field::FStdAccess),
 164         static_cast<FieldEditMethodSig>(&SkinningAlgorithm::editHandleSkeleton),
 165         static_cast<FieldGetMethodSig >(&SkinningAlgorithm::getHandleSkeleton));
 166
 167     oType.addInitialDesc(pDesc);
 168 }
 169
 170
 171 SkinningAlgorithmBase::TypeObject SkinningAlgorithmBase::_type(
 172     SkinningAlgorithmBase::getClassname(),
 173     Inherited::getClassname(),
 174     "NULL",
 175     nsOSG, //Namespace
 176     NULL,
 177     reinterpret_cast<InitContainerF>(&SkinningAlgorithm::initMethod),
 178     reinterpret_cast<ExitContainerF>(&SkinningAlgorithm::exitMethod),
 179     reinterpret_cast<InitalInsertDescFunc>(
 180         reinterpret_cast<void *>(&SkinningAlgorithm::classDescInserter)),
 181     false,
 182     0,
 183     "<?xml version=\"1.0\"?>\n"
 184     "\n"
 185     "<FieldContainer\n"
 186     "   name=\"SkinningAlgorithm\"\n"
 187     "   parent=\"Algorithm\"\n"
 188     "   library=\"Dynamics\"\n"
 189     "   pointerfieldtypes=\"both\"\n"
 190     "   structure=\"abstract\"\n"
 191     "   systemcomponent=\"true\"\n"
 192     "   parentsystemcomponent=\"true\"\n"
 193     "   decoratable=\"false\"\n"
 194     "   childFields=\"both\"\n"
 195     "   parentFields=\"none\"\n"
 196     ">\n"
 197     "  <Field\n"
 198     "     name=\"skin\"\n"
 199     "     type=\"SkinnedGeometry\"\n"
 200     "     category=\"parentpointer\"\n"
 201     "     cardinality=\"single\"\n"
 202     "     visibility=\"external\"\n"
 203     "     access=\"none\"\n"
 204     "     defaultValue=\"NULL\"\n"
 205     "     >\n"
 206     "  </Field>\n"
 207     "\n"
 208     "  <Field\n"
 209     "     name=\"skeleton\"\n"
 210     "     type=\"Skeleton\"\n"
 211     "     category=\"pointer\"\n"
 212     "     cardinality=\"single\"\n"
 213     "     visibility=\"external\"\n"
 214     "     access=\"public\"\n"
 215     "     defaultValue=\"NULL\"\n"
 216     "     >\n"
 217     "  </Field>\n"
 218     "\n"
 219     "</FieldContainer>\n",
 220     ""
 221     );
 222
 223 /*------------------------------ get -----------------------------------*/
 224
 225 FieldContainerType &SkinningAlgorithmBase::getType(void)
 226 {
 227     return _type;
 228 }
 229
 230 const FieldContainerType &SkinningAlgorithmBase::getType(void) const
 231 {
 232     return _type;
 233 }
 234
 235 UInt32 SkinningAlgorithmBase::getContainerSize(void) const
 236 {
 237     return sizeof(SkinningAlgorithm);
 238 }
 239
 240 /*------------------------- decorator get ------------------------------*/
 241
 242
 243
 244 //! Get the SkinningAlgorithm::_sfSkeleton field.
 245 const SFUnrecSkeletonPtr *SkinningAlgorithmBase::getSFSkeleton(void) const
 246 {
 247     return &_sfSkeleton;
 248 }
 249
 250 SFUnrecSkeletonPtr  *SkinningAlgorithmBase::editSFSkeleton       (void)
 251 {
 252     editSField(SkeletonFieldMask);
 253
 254     return &_sfSkeleton;
 255 }
 256
 257 //! Get the value of the SkinningAlgorithm::_sfSkeleton field.
 258 Skeleton * SkinningAlgorithmBase::getSkeleton(void) const
 259 {
 260     return _sfSkeleton.getValue();
 261 }
 262
 263 //! Set the value of the SkinningAlgorithm::_sfSkeleton field.
 264 void SkinningAlgorithmBase::setSkeleton(Skeleton * const value)
 265 {
 266     editSField(SkeletonFieldMask);
 267
 268     _sfSkeleton.setValue(value);
 269 }
 270
 271
 272
 273
 274
 275
 276 /*------------------------------ access -----------------------------------*/
 277
 278 SizeT SkinningAlgorithmBase::getBinSize(ConstFieldMaskArg whichField)
 279 {
 280     SizeT returnValue = Inherited::getBinSize(whichField);
 281
 282     if(FieldBits::NoField != (SkinFieldMask & whichField))
 283     {
 284         returnValue += _sfSkin.getBinSize();
 285     }
 286     if(FieldBits::NoField != (SkeletonFieldMask & whichField))
 287     {
 288         returnValue += _sfSkeleton.getBinSize();
 289     }
 290
 291     return returnValue;
 292 }
 293
 294 void SkinningAlgorithmBase::copyToBin(BinaryDataHandler &pMem,
 295                                   ConstFieldMaskArg  whichField)
 296 {
 297     Inherited::copyToBin(pMem, whichField);
 298
 299     if(FieldBits::NoField != (SkinFieldMask & whichField))
 300     {
 301         _sfSkin.copyToBin(pMem);
 302     }
 303     if(FieldBits::NoField != (SkeletonFieldMask & whichField))
 304     {
 305         _sfSkeleton.copyToBin(pMem);
 306     }
 307 }
 308
 309 void SkinningAlgorithmBase::copyFromBin(BinaryDataHandler &pMem,
 310                                     ConstFieldMaskArg  whichField)
 311 {
 312     Inherited::copyFromBin(pMem, whichField);
 313
 314     if(FieldBits::NoField != (SkinFieldMask & whichField))
 315     {
 316         editSField(SkinFieldMask);
 317         _sfSkin.copyFromBin(pMem);
 318     }
 319     if(FieldBits::NoField != (SkeletonFieldMask & whichField))
 320     {
 321         editSField(SkeletonFieldMask);
 322         _sfSkeleton.copyFromBin(pMem);
 323     }
 324 }
 325
 326
 327
 328
 329 /*------------------------- constructors ----------------------------------*/
 330
 331 SkinningAlgorithmBase::SkinningAlgorithmBase(void) :
 332     Inherited(),
 333     _sfSkin                   (NULL),
 334     _sfSkeleton               (NULL)
 335 {
 336 }
 337
 338 SkinningAlgorithmBase::SkinningAlgorithmBase(const SkinningAlgorithmBase &source) :
 339     Inherited(source),
 340     _sfSkin                   (NULL),
 341     _sfSkeleton               (NULL)
 342 {
 343 }
 344
 345
 346 /*-------------------------- destructors ----------------------------------*/
 347
 348 SkinningAlgorithmBase::~SkinningAlgorithmBase(void)
 349 {
 350 }
 351 /*-------------------------------------------------------------------------*/
 352 /* Parent linking                                                          */
 353
 354 bool SkinningAlgorithmBase::linkParent(
 355     FieldContainer * const pParent,
 356     UInt16           const childFieldId,
 357     UInt16           const parentFieldId )
 358 {
 359     if(parentFieldId == SkinFieldId)
 360     {
 361         SkinnedGeometry * pTypedParent =
 362             dynamic_cast< SkinnedGeometry * >(pParent);
 363
 364         if(pTypedParent != NULL)
 365         {
 366             FieldContainer *pOldParent =
 367                 _sfSkin.getValue         ();
 368
 369             UInt16 oldChildFieldId =
 370                 _sfSkin.getParentFieldPos();
 371
 372             if(pOldParent != NULL)
 373             {
 374                 pOldParent->unlinkChild(this, oldChildFieldId);
 375             }
 376
 377             editSField(SkinFieldMask);
 378
 379             _sfSkin.setValue(static_cast<SkinnedGeometry *>(pParent), childFieldId);
 380
 381             return true;
 382         }
 383
 384         return false;
 385     }
 386
 387     return Inherited::linkParent(pParent, childFieldId, parentFieldId);
 388 }
 389
 390 bool SkinningAlgorithmBase::unlinkParent(
 391     FieldContainer * const pParent,
 392     UInt16           const parentFieldId)
 393 {
 394     if(parentFieldId == SkinFieldId)
 395     {
 396         SkinnedGeometry * pTypedParent =
 397             dynamic_cast< SkinnedGeometry * >(pParent);
 398
 399         if(pTypedParent != NULL)
 400         {
 401             if(_sfSkin.getValue() == pTypedParent)
 402             {
 403                 editSField(SkinFieldMask);
 404
 405                 _sfSkin.setValue(NULL, 0xFFFF);
 406
 407                 return true;
 408             }
 409
 410             SWARNING << "Child (["          << this
 411                      << "] id ["            << this->getId()
 412                      << "] type ["          << this->getType().getCName()
 413                      << "] parentFieldId [" << parentFieldId
 414                      << "]) - Parent (["    << pParent
 415                      << "] id ["            << pParent->getId()
 416                      << "] type ["          << pParent->getType().getCName()
 417                      << "]): link inconsistent!"
 418                      << std::endl;
 419
 420             return false;
 421         }
 422
 423         return false;
 424     }
 425
 426     return Inherited::unlinkParent(pParent, parentFieldId);
 427 }
 428
 429
 430 void SkinningAlgorithmBase::onCreate(const SkinningAlgorithm *source)
 431 {
 432     Inherited::onCreate(source);
 433
 434     if(source != NULL)
 435     {
 436         SkinningAlgorithm *pThis = static_cast<SkinningAlgorithm *>(this);
 437
 438         pThis->setSkeleton(source->getSkeleton());
 439     }
 440 }
 441
 442 GetFieldHandlePtr SkinningAlgorithmBase::getHandleSkin            (void) const
 443 {
 444     SFParentSkinnedGeometryPtr::GetHandlePtr returnValue;
 445
 446     return returnValue;
 447 }
 448
 449 EditFieldHandlePtr SkinningAlgorithmBase::editHandleSkin           (void)
 450 {
 451     EditFieldHandlePtr returnValue;
 452
 453     return returnValue;
 454 }
 455
 456 GetFieldHandlePtr SkinningAlgorithmBase::getHandleSkeleton        (void) const
 457 {
 458     SFUnrecSkeletonPtr::GetHandlePtr returnValue(
 459         new  SFUnrecSkeletonPtr::GetHandle(
 460              &_sfSkeleton,
 461              this->getType().getFieldDesc(SkeletonFieldId),
 462              const_cast<SkinningAlgorithmBase *>(this)));
 463
 464     return returnValue;
 465 }
 466
 467 EditFieldHandlePtr SkinningAlgorithmBase::editHandleSkeleton       (void)
 468 {
 469     SFUnrecSkeletonPtr::EditHandlePtr returnValue(
 470         new  SFUnrecSkeletonPtr::EditHandle(
 471              &_sfSkeleton,
 472              this->getType().getFieldDesc(SkeletonFieldId),
 473              this));
 474
 475     returnValue->setSetMethod(
 476         boost::bind(&SkinningAlgorithm::setSkeleton,
 477                     static_cast<SkinningAlgorithm *>(this), _1));
 478
 479     editSField(SkeletonFieldMask);
 480
 481     return returnValue;
 482 }
 483
 484
 485 #ifdef OSG_MT_CPTR_ASPECT
 486 void SkinningAlgorithmBase::execSyncV(      FieldContainer    &oFrom,
 487                                         ConstFieldMaskArg  whichField,
 488                                         AspectOffsetStore &oOffsets,
 489                                         ConstFieldMaskArg  syncMode,
 490                                   const UInt32             uiSyncInfo)
 491 {
 492     SkinningAlgorithm *pThis = static_cast<SkinningAlgorithm *>(this);
 493
 494     pThis->execSync(static_cast<SkinningAlgorithm *>(&oFrom),
 495                     whichField,
 496                     oOffsets,
 497                     syncMode,
 498                     uiSyncInfo);
 499 }
 500 #endif
 501
 502
 503
 504 void SkinningAlgorithmBase::resolveLinks(void)
 505 {
 506     Inherited::resolveLinks();
 507
 508     static_cast<SkinningAlgorithm *>(this)->setSkeleton(NULL);
 509
 510
 511 }
 512
 513
 514 OSG_END_NAMESPACE