Source/System/Dynamics/Animation/OSGAnimTemplateBase.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 AnimTemplate!
  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 "OSGAnimDataSource.h"          // Sources Class
  66
  67 #include "OSGAnimTemplateBase.h"
  68 #include "OSGAnimTemplate.h"
  69
  70 #include <boost/bind.hpp>
  71
  72 OSG_BEGIN_NAMESPACE
  73
  74 /***************************************************************************\
  75  *                            Description                                  *
  76 \***************************************************************************/
  77
  78 /*! \class OSG::AnimTemplate
  79
  80  */
  81
  82 /***************************************************************************\
  83  *                        Field Documentation                              *
  84 \***************************************************************************/
  85
  86 /*! \var std::string     AnimTemplateBase::_sfName
  87
  88 */
  89
  90 /*! \var AnimDataSource * AnimTemplateBase::_mfSources
  91
  92 */
  93
  94 /*! \var std::string     AnimTemplateBase::_mfTargetIds
  95
  96 */
  97
  98
  99 /***************************************************************************\
 100  *                      FieldType/FieldTrait Instantiation                 *
 101 \***************************************************************************/
 102
 103 #if !defined(OSG_DO_DOC) || defined(OSG_DOC_DEV)
 104 PointerType FieldTraits<AnimTemplate *, nsOSG>::_type(
 105     "AnimTemplatePtr",
 106     "AttachmentContainerPtr",
 107     AnimTemplate::getClassType(),
 108     nsOSG);
 109 #endif
 110
 111 OSG_FIELDTRAITS_GETTYPE_NS(AnimTemplate *, nsOSG)
 112
 113 OSG_EXPORT_PTR_SFIELD_FULL(PointerSField,
 114                            AnimTemplate *,
 115                            nsOSG)
 116
 117 OSG_EXPORT_PTR_MFIELD_FULL(PointerMField,
 118                            AnimTemplate *,
 119                            nsOSG)
 120
 121 /***************************************************************************\
 122  *                         Field Description                               *
 123 \***************************************************************************/
 124
 125 void AnimTemplateBase::classDescInserter(TypeObject &oType)
 126 {
 127     FieldDescriptionBase *pDesc = NULL;
 128
 129
 130     pDesc = new SFString::Description(
 131         SFString::getClassType(),
 132         "name",
 133         "",
 134         NameFieldId, NameFieldMask,
 135         false,
 136         (Field::FClusterLocal),
 137         static_cast<FieldEditMethodSig>(&AnimTemplate::editHandleName),
 138         static_cast<FieldGetMethodSig >(&AnimTemplate::getHandleName));
 139
 140     oType.addInitialDesc(pDesc);
 141
 142     pDesc = new MFUnrecAnimDataSourcePtr::Description(
 143         MFUnrecAnimDataSourcePtr::getClassType(),
 144         "sources",
 145         "",
 146         SourcesFieldId, SourcesFieldMask,
 147         false,
 148         (Field::FStdAccess | Field::FClusterLocal),
 149         static_cast<FieldEditMethodSig>(&AnimTemplate::editHandleSources),
 150         static_cast<FieldGetMethodSig >(&AnimTemplate::getHandleSources));
 151
 152     oType.addInitialDesc(pDesc);
 153
 154     pDesc = new MFString::Description(
 155         MFString::getClassType(),
 156         "targetIds",
 157         "",
 158         TargetIdsFieldId, TargetIdsFieldMask,
 159         false,
 160         (Field::FClusterLocal),
 161         static_cast<FieldEditMethodSig>(&AnimTemplate::editHandleTargetIds),
 162         static_cast<FieldGetMethodSig >(&AnimTemplate::getHandleTargetIds));
 163
 164     oType.addInitialDesc(pDesc);
 165 }
 166
 167
 168 AnimTemplateBase::TypeObject AnimTemplateBase::_type(
 169     AnimTemplateBase::getClassname(),
 170     Inherited::getClassname(),
 171     "NULL",
 172     nsOSG, //Namespace
 173     NULL,
 174     reinterpret_cast<InitContainerF>(&AnimTemplate::initMethod),
 175     reinterpret_cast<ExitContainerF>(&AnimTemplate::exitMethod),
 176     reinterpret_cast<InitalInsertDescFunc>(
 177         reinterpret_cast<void *>(&AnimTemplate::classDescInserter)),
 178     false,
 179     0,
 180     "<?xml version=\"1.0\"?>\n"
 181     "\n"
 182     "<FieldContainer\n"
 183     "   name=\"AnimTemplate\"\n"
 184     "   parent=\"AttachmentContainer\"\n"
 185     "   library=\"Dynamics\"\n"
 186     "   pointerfieldtypes=\"both\"\n"
 187     "   structure=\"abstract\"\n"
 188     "   systemcomponent=\"true\"\n"
 189     "   parentsystemcomponent=\"true\"\n"
 190     "   decoratable=\"false\"\n"
 191     "   useLocalIncludes=\"false\"\n"
 192     "   isNodeCore=\"false\"\n"
 193     "   isBundle=\"false\"\n"
 194     "   parentFields=\"none\"\n"
 195     "   >\n"
 196     "  <Field\n"
 197     "     name=\"name\"\n"
 198     "     category=\"data\"\n"
 199     "     type=\"std::string\"\n"
 200     "     cardinality=\"single\"\n"
 201     "     visibility=\"external\"\n"
 202     "     access=\"public\"\n"
 203     "     fieldFlags=\"FClusterLocal\"\n"
 204     "     >\n"
 205     "  </Field>\n"
 206     "  <Field\n"
 207     "     name=\"sources\"\n"
 208     "     category=\"pointer\"\n"
 209     "     type=\"AnimDataSource\"\n"
 210     "     cardinality=\"multi\"\n"
 211     "     visibility=\"external\"\n"
 212     "     access=\"public\"\n"
 213     "     fieldFlags=\"FStdAccess, FClusterLocal\"\n"
 214     "     >\n"
 215     "    </Field>\n"
 216     "  <Field\n"
 217     "     name=\"targetIds\"\n"
 218     "     category=\"data\"\n"
 219     "     type=\"std::string\"\n"
 220     "     cardinality=\"multi\"\n"
 221     "     visibility=\"external\"\n"
 222     "     access=\"public\"\n"
 223     "     fieldFlags=\"FClusterLocal\"\n"
 224     "     >\n"
 225     "  </Field>\n"
 226     "</FieldContainer>\n",
 227     ""
 228     );
 229
 230 /*------------------------------ get -----------------------------------*/
 231
 232 FieldContainerType &AnimTemplateBase::getType(void)
 233 {
 234     return _type;
 235 }
 236
 237 const FieldContainerType &AnimTemplateBase::getType(void) const
 238 {
 239     return _type;
 240 }
 241
 242 UInt32 AnimTemplateBase::getContainerSize(void) const
 243 {
 244     return sizeof(AnimTemplate);
 245 }
 246
 247 /*------------------------- decorator get ------------------------------*/
 248
 249
 250 SFString *AnimTemplateBase::editSFName(void)
 251 {
 252     editSField(NameFieldMask);
 253
 254     return &_sfName;
 255 }
 256
 257 const SFString *AnimTemplateBase::getSFName(void) const
 258 {
 259     return &_sfName;
 260 }
 261
 262
 263 //! Get the AnimTemplate::_mfSources field.
 264 const MFUnrecAnimDataSourcePtr *AnimTemplateBase::getMFSources(void) const
 265 {
 266     return &_mfSources;
 267 }
 268
 269 MFUnrecAnimDataSourcePtr *AnimTemplateBase::editMFSources        (void)
 270 {
 271     editMField(SourcesFieldMask, _mfSources);
 272
 273     return &_mfSources;
 274 }
 275 AnimDataSource * AnimTemplateBase::getSources(const UInt32 index) const
 276 {
 277     return _mfSources[index];
 278 }
 279
 280 MFString *AnimTemplateBase::editMFTargetIds(void)
 281 {
 282     editMField(TargetIdsFieldMask, _mfTargetIds);
 283
 284     return &_mfTargetIds;
 285 }
 286
 287 const MFString *AnimTemplateBase::getMFTargetIds(void) const
 288 {
 289     return &_mfTargetIds;
 290 }
 291
 292
 293
 294
 295 void AnimTemplateBase::pushToSources(AnimDataSource * const value)
 296 {
 297     editMField(SourcesFieldMask, _mfSources);
 298
 299     _mfSources.push_back(value);
 300 }
 301
 302 void AnimTemplateBase::assignSources  (const MFUnrecAnimDataSourcePtr &value)
 303 {
 304     MFUnrecAnimDataSourcePtr::const_iterator elemIt  =
 305         value.begin();
 306     MFUnrecAnimDataSourcePtr::const_iterator elemEnd =
 307         value.end  ();
 308
 309     static_cast<AnimTemplate *>(this)->clearSources();
 310
 311     while(elemIt != elemEnd)
 312     {
 313         this->pushToSources(*elemIt);
 314
 315         ++elemIt;
 316     }
 317 }
 318
 319 void AnimTemplateBase::removeFromSources(UInt32 uiIndex)
 320 {
 321     if(uiIndex < _mfSources.size())
 322     {
 323         editMField(SourcesFieldMask, _mfSources);
 324
 325         _mfSources.erase(uiIndex);
 326     }
 327 }
 328
 329 void AnimTemplateBase::removeObjFromSources(AnimDataSource * const value)
 330 {
 331     Int32 iElemIdx = _mfSources.findIndex(value);
 332
 333     if(iElemIdx != -1)
 334     {
 335         editMField(SourcesFieldMask, _mfSources);
 336
 337         _mfSources.erase(iElemIdx);
 338     }
 339 }
 340 void AnimTemplateBase::clearSources(void)
 341 {
 342     editMField(SourcesFieldMask, _mfSources);
 343
 344
 345     _mfSources.clear();
 346 }
 347
 348
 349
 350 /*------------------------------ access -----------------------------------*/
 351
 352 SizeT AnimTemplateBase::getBinSize(ConstFieldMaskArg whichField)
 353 {
 354     SizeT returnValue = Inherited::getBinSize(whichField);
 355
 356     if(FieldBits::NoField != (NameFieldMask & whichField))
 357     {
 358         returnValue += _sfName.getBinSize();
 359     }
 360     if(FieldBits::NoField != (SourcesFieldMask & whichField))
 361     {
 362         returnValue += _mfSources.getBinSize();
 363     }
 364     if(FieldBits::NoField != (TargetIdsFieldMask & whichField))
 365     {
 366         returnValue += _mfTargetIds.getBinSize();
 367     }
 368
 369     return returnValue;
 370 }
 371
 372 void AnimTemplateBase::copyToBin(BinaryDataHandler &pMem,
 373                                   ConstFieldMaskArg  whichField)
 374 {
 375     Inherited::copyToBin(pMem, whichField);
 376
 377     if(FieldBits::NoField != (NameFieldMask & whichField))
 378     {
 379         _sfName.copyToBin(pMem);
 380     }
 381     if(FieldBits::NoField != (SourcesFieldMask & whichField))
 382     {
 383         _mfSources.copyToBin(pMem);
 384     }
 385     if(FieldBits::NoField != (TargetIdsFieldMask & whichField))
 386     {
 387         _mfTargetIds.copyToBin(pMem);
 388     }
 389 }
 390
 391 void AnimTemplateBase::copyFromBin(BinaryDataHandler &pMem,
 392                                     ConstFieldMaskArg  whichField)
 393 {
 394     Inherited::copyFromBin(pMem, whichField);
 395
 396     if(FieldBits::NoField != (NameFieldMask & whichField))
 397     {
 398         editSField(NameFieldMask);
 399         _sfName.copyFromBin(pMem);
 400     }
 401     if(FieldBits::NoField != (SourcesFieldMask & whichField))
 402     {
 403         editMField(SourcesFieldMask, _mfSources);
 404         _mfSources.copyFromBin(pMem);
 405     }
 406     if(FieldBits::NoField != (TargetIdsFieldMask & whichField))
 407     {
 408         editMField(TargetIdsFieldMask, _mfTargetIds);
 409         _mfTargetIds.copyFromBin(pMem);
 410     }
 411 }
 412
 413
 414
 415
 416 /*------------------------- constructors ----------------------------------*/
 417
 418 AnimTemplateBase::AnimTemplateBase(void) :
 419     Inherited(),
 420     _sfName                   (),
 421     _mfSources                (),
 422     _mfTargetIds              ()
 423 {
 424 }
 425
 426 AnimTemplateBase::AnimTemplateBase(const AnimTemplateBase &source) :
 427     Inherited(source),
 428     _sfName                   (source._sfName                   ),
 429     _mfSources                (),
 430     _mfTargetIds              (source._mfTargetIds              )
 431 {
 432 }
 433
 434
 435 /*-------------------------- destructors ----------------------------------*/
 436
 437 AnimTemplateBase::~AnimTemplateBase(void)
 438 {
 439 }
 440
 441 void AnimTemplateBase::onCreate(const AnimTemplate *source)
 442 {
 443     Inherited::onCreate(source);
 444
 445     if(source != NULL)
 446     {
 447         AnimTemplate *pThis = static_cast<AnimTemplate *>(this);
 448
 449         MFUnrecAnimDataSourcePtr::const_iterator SourcesIt  =
 450             source->_mfSources.begin();
 451         MFUnrecAnimDataSourcePtr::const_iterator SourcesEnd =
 452             source->_mfSources.end  ();
 453
 454         while(SourcesIt != SourcesEnd)
 455         {
 456             pThis->pushToSources(*SourcesIt);
 457
 458             ++SourcesIt;
 459         }
 460     }
 461 }
 462
 463 GetFieldHandlePtr AnimTemplateBase::getHandleName            (void) const
 464 {
 465     SFString::GetHandlePtr returnValue(
 466         new  SFString::GetHandle(
 467              &_sfName,
 468              this->getType().getFieldDesc(NameFieldId),
 469              const_cast<AnimTemplateBase *>(this)));
 470
 471     return returnValue;
 472 }
 473
 474 EditFieldHandlePtr AnimTemplateBase::editHandleName           (void)
 475 {
 476     SFString::EditHandlePtr returnValue(
 477         new  SFString::EditHandle(
 478              &_sfName,
 479              this->getType().getFieldDesc(NameFieldId),
 480              this));
 481
 482
 483     editSField(NameFieldMask);
 484
 485     return returnValue;
 486 }
 487
 488 GetFieldHandlePtr AnimTemplateBase::getHandleSources         (void) const
 489 {
 490     MFUnrecAnimDataSourcePtr::GetHandlePtr returnValue(
 491         new  MFUnrecAnimDataSourcePtr::GetHandle(
 492              &_mfSources,
 493              this->getType().getFieldDesc(SourcesFieldId),
 494              const_cast<AnimTemplateBase *>(this)));
 495
 496     return returnValue;
 497 }
 498
 499 EditFieldHandlePtr AnimTemplateBase::editHandleSources        (void)
 500 {
 501     MFUnrecAnimDataSourcePtr::EditHandlePtr returnValue(
 502         new  MFUnrecAnimDataSourcePtr::EditHandle(
 503              &_mfSources,
 504              this->getType().getFieldDesc(SourcesFieldId),
 505              this));
 506
 507     returnValue->setAddMethod(
 508         boost::bind(&AnimTemplate::pushToSources,
 509                     static_cast<AnimTemplate *>(this), _1));
 510     returnValue->setRemoveMethod(
 511         boost::bind(&AnimTemplate::removeFromSources,
 512                     static_cast<AnimTemplate *>(this), _1));
 513     returnValue->setRemoveObjMethod(
 514         boost::bind(&AnimTemplate::removeObjFromSources,
 515                     static_cast<AnimTemplate *>(this), _1));
 516     returnValue->setClearMethod(
 517         boost::bind(&AnimTemplate::clearSources,
 518                     static_cast<AnimTemplate *>(this)));
 519
 520     editMField(SourcesFieldMask, _mfSources);
 521
 522     return returnValue;
 523 }
 524
 525 GetFieldHandlePtr AnimTemplateBase::getHandleTargetIds       (void) const
 526 {
 527     MFString::GetHandlePtr returnValue(
 528         new  MFString::GetHandle(
 529              &_mfTargetIds,
 530              this->getType().getFieldDesc(TargetIdsFieldId),
 531              const_cast<AnimTemplateBase *>(this)));
 532
 533     return returnValue;
 534 }
 535
 536 EditFieldHandlePtr AnimTemplateBase::editHandleTargetIds      (void)
 537 {
 538     MFString::EditHandlePtr returnValue(
 539         new  MFString::EditHandle(
 540              &_mfTargetIds,
 541              this->getType().getFieldDesc(TargetIdsFieldId),
 542              this));
 543
 544
 545     editMField(TargetIdsFieldMask, _mfTargetIds);
 546
 547     return returnValue;
 548 }
 549
 550
 551 #ifdef OSG_MT_CPTR_ASPECT
 552 void AnimTemplateBase::execSyncV(      FieldContainer    &oFrom,
 553                                         ConstFieldMaskArg  whichField,
 554                                         AspectOffsetStore &oOffsets,
 555                                         ConstFieldMaskArg  syncMode,
 556                                   const UInt32             uiSyncInfo)
 557 {
 558     AnimTemplate *pThis = static_cast<AnimTemplate *>(this);
 559
 560     pThis->execSync(static_cast<AnimTemplate *>(&oFrom),
 561                     whichField,
 562                     oOffsets,
 563                     syncMode,
 564                     uiSyncInfo);
 565 }
 566 #endif
 567
 568
 569
 570 void AnimTemplateBase::resolveLinks(void)
 571 {
 572     Inherited::resolveLinks();
 573
 574     static_cast<AnimTemplate *>(this)->clearSources();
 575
 576 #ifdef OSG_MT_CPTR_ASPECT
 577     AspectOffsetStore oOffsets;
 578
 579     _pAspectStore->fillOffsetArray(oOffsets, this);
 580 #endif
 581
 582 #ifdef OSG_MT_CPTR_ASPECT
 583     _mfTargetIds.terminateShare(Thread::getCurrentAspect(),
 584                                       oOffsets);
 585 #endif
 586 }
 587
 588
 589 OSG_END_NAMESPACE