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