Source/System/NodeCores/Groups/Misc/OSGVisitSubTreeBase.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 VisitSubTree!
  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 "OSGNode.h"                    // SubTreeRoot Class
  66
  67 #include "OSGVisitSubTreeBase.h"
  68 #include "OSGVisitSubTree.h"
  69
  70 #include <boost/bind.hpp>
  71
  72 OSG_BEGIN_NAMESPACE
  73
  74 /***************************************************************************\
  75  *                            Description                                  *
  76 \***************************************************************************/
  77
  78 /*! \class OSG::VisitSubTree
  79     VisitSubTree provides a way to point the renderer to another section of the
  80     scene graph for rendering. This is useful for multi-pass algorithms using
  81     OSG::Stage because it provides a way to render the same graph multiple times
  82     without duplicating the nodes.
  83  */
  84
  85 /***************************************************************************\
  86  *                        Field Documentation                              *
  87 \***************************************************************************/
  88
  89 /*! \var Node *          VisitSubTreeBase::_sfSubTreeRoot
  90     Reference to the sub-graph to draw in place of this node.
  91     Whatever node is pointed to will be drawn here as if it was duplicated
  92     at this location.
  93 */
  94
  95 /*! \var UInt32          VisitSubTreeBase::_sfSubTreeTravMask
  96     This travmask will be used to update the action mask on traversal (and)
  97 */
  98
  99 /*! \var UInt32          VisitSubTreeBase::_sfTravMaskMode
 100     This defines how the travmask will be used to update the action mask on
 101     traversal
 102 */
 103
 104
 105 /***************************************************************************\
 106  *                      FieldType/FieldTrait Instantiation                 *
 107 \***************************************************************************/
 108
 109 #if !defined(OSG_DO_DOC) || defined(OSG_DOC_DEV)
 110 PointerType FieldTraits<VisitSubTree *, nsOSG>::_type(
 111     "VisitSubTreePtr",
 112     "GroupPtr",
 113     VisitSubTree::getClassType(),
 114     nsOSG);
 115 #endif
 116
 117 OSG_FIELDTRAITS_GETTYPE_NS(VisitSubTree *, nsOSG)
 118
 119 /***************************************************************************\
 120  *                         Field Description                               *
 121 \***************************************************************************/
 122
 123 void VisitSubTreeBase::classDescInserter(TypeObject &oType)
 124 {
 125     FieldDescriptionBase *pDesc = NULL;
 126
 127
 128     pDesc = new SFWeakNodePtr::Description(
 129         SFWeakNodePtr::getClassType(),
 130         "subTreeRoot",
 131         "Reference to the sub-graph to draw in place of this node.\n"
 132         "Whatever node is pointed to will be drawn here as if it was duplicated\n"
 133         "at this location.\n",
 134         SubTreeRootFieldId, SubTreeRootFieldMask,
 135         false,
 136         (Field::SFDefaultFlags | Field::FCustomAccess),
 137         static_cast<FieldEditMethodSig>(&VisitSubTree::editHandleSubTreeRoot),
 138         static_cast<FieldGetMethodSig >(&VisitSubTree::getHandleSubTreeRoot));
 139
 140     oType.addInitialDesc(pDesc);
 141
 142     pDesc = new SFUInt32::Description(
 143         SFUInt32::getClassType(),
 144         "subTreeTravMask",
 145         "This travmask will be used to update the action mask on traversal (and)\n",
 146         SubTreeTravMaskFieldId, SubTreeTravMaskFieldMask,
 147         false,
 148         (Field::SFDefaultFlags | Field::FStdAccess),
 149         static_cast<FieldEditMethodSig>(&VisitSubTree::editHandleSubTreeTravMask),
 150         static_cast<FieldGetMethodSig >(&VisitSubTree::getHandleSubTreeTravMask));
 151
 152     oType.addInitialDesc(pDesc);
 153
 154     pDesc = new SFUInt32::Description(
 155         SFUInt32::getClassType(),
 156         "travMaskMode",
 157         "This defines how the travmask will be used to update the action mask on \n"
 158         "traversal\n",
 159         TravMaskModeFieldId, TravMaskModeFieldMask,
 160         false,
 161         (Field::SFDefaultFlags | Field::FStdAccess),
 162         static_cast<FieldEditMethodSig>(&VisitSubTree::editHandleTravMaskMode),
 163         static_cast<FieldGetMethodSig >(&VisitSubTree::getHandleTravMaskMode));
 164
 165     oType.addInitialDesc(pDesc);
 166 }
 167
 168
 169 VisitSubTreeBase::TypeObject VisitSubTreeBase::_type(
 170     VisitSubTreeBase::getClassname(),
 171     Inherited::getClassname(),
 172     "NULL",
 173     nsOSG, //Namespace
 174     reinterpret_cast<PrototypeCreateF>(&VisitSubTreeBase::createEmptyLocal),
 175     reinterpret_cast<InitContainerF>(&VisitSubTree::initMethod),
 176     reinterpret_cast<ExitContainerF>(&VisitSubTree::exitMethod),
 177     reinterpret_cast<InitalInsertDescFunc>(
 178         reinterpret_cast<void *>(&VisitSubTree::classDescInserter)),
 179     false,
 180     0,
 181     "<?xml version=\"1.0\"?>\n"
 182     "\n"
 183     "<FieldContainer\n"
 184     "   name=\"VisitSubTree\"\n"
 185     "   parent=\"Group\"\n"
 186     "   library=\"Group\"\n"
 187     "   pointerfieldtypes=\"none\"\n"
 188     "   structure=\"concrete\"\n"
 189     "   systemcomponent=\"true\"\n"
 190     "   parentsystemcomponent=\"true\"\n"
 191     "   decoratable=\"false\"\n"
 192     "   useLocalIncludes=\"false\"\n"
 193     "   isNodeCore=\"true\"\n"
 194     "   docGroupBase=\"GrpGroupMisc\"\n"
 195     "   >\n"
 196     "  VisitSubTree provides a way to point the renderer to another section of the\n"
 197     "  scene graph for rendering. This is useful for multi-pass algorithms using\n"
 198     "  OSG::Stage because it provides a way to render the same graph multiple times\n"
 199     "  without duplicating the nodes.\n"
 200     "  <Field\n"
 201     "     name=\"subTreeRoot\"\n"
 202     "     type=\"Node\"\n"
 203     "     category=\"weakpointer\"\n"
 204     "     cardinality=\"single\"\n"
 205     "     visibility=\"external\"\n"
 206     "     defaultValue=\"NULL\"\n"
 207     "     access=\"protected\"\n"
 208     "     ptrFieldAccess = \"custom\"\n"
 209     "     >\n"
 210     "    Reference to the sub-graph to draw in place of this node.\n"
 211     "    Whatever node is pointed to will be drawn here as if it was duplicated\n"
 212     "    at this location.\n"
 213     "  </Field>\n"
 214     "  <Field\n"
 215     "     name=\"subTreeTravMask\"\n"
 216     "     type=\"UInt32\"\n"
 217     "     cardinality=\"single\"\n"
 218     "     visibility=\"external\"\n"
 219     "     defaultValue=\"TypeTraits&lt;UInt32&gt;::getMax()\"\n"
 220     "     access=\"public\"\n"
 221     "     >\n"
 222     "    This travmask will be used to update the action mask on traversal (and)\n"
 223     "  </Field>\n"
 224     "  <Field\n"
 225     "     name=\"travMaskMode\"\n"
 226     "     type=\"UInt32\"\n"
 227     "     cardinality=\"single\"\n"
 228     "     visibility=\"external\"\n"
 229     "     defaultValue=\"VisitSubTree::AndTravMask\"\n"
 230     "     access=\"public\"\n"
 231     "     >\n"
 232     "    This defines how the travmask will be used to update the action mask on \n"
 233     "    traversal\n"
 234     "  </Field>\n"
 235     "</FieldContainer>\n",
 236     "VisitSubTree provides a way to point the renderer to another section of the\n"
 237     "scene graph for rendering. This is useful for multi-pass algorithms using\n"
 238     "OSG::Stage because it provides a way to render the same graph multiple times\n"
 239     "without duplicating the nodes.\n"
 240     );
 241
 242 /*------------------------------ get -----------------------------------*/
 243
 244 FieldContainerType &VisitSubTreeBase::getType(void)
 245 {
 246     return _type;
 247 }
 248
 249 const FieldContainerType &VisitSubTreeBase::getType(void) const
 250 {
 251     return _type;
 252 }
 253
 254 UInt32 VisitSubTreeBase::getContainerSize(void) const
 255 {
 256     return sizeof(VisitSubTree);
 257 }
 258
 259 /*------------------------- decorator get ------------------------------*/
 260
 261
 262 //! Get the VisitSubTree::_sfSubTreeRoot field.
 263 const SFWeakNodePtr *VisitSubTreeBase::getSFSubTreeRoot(void) const
 264 {
 265     return &_sfSubTreeRoot;
 266 }
 267
 268 //! Get the value of the VisitSubTree::_sfSubTreeRoot field.
 269 Node * VisitSubTreeBase::getSubTreeRoot(void) const
 270 {
 271     return _sfSubTreeRoot.getValue();
 272 }
 273
 274
 275
 276 SFUInt32 *VisitSubTreeBase::editSFSubTreeTravMask(void)
 277 {
 278     editSField(SubTreeTravMaskFieldMask);
 279
 280     return &_sfSubTreeTravMask;
 281 }
 282
 283 const SFUInt32 *VisitSubTreeBase::getSFSubTreeTravMask(void) const
 284 {
 285     return &_sfSubTreeTravMask;
 286 }
 287
 288
 289 SFUInt32 *VisitSubTreeBase::editSFTravMaskMode(void)
 290 {
 291     editSField(TravMaskModeFieldMask);
 292
 293     return &_sfTravMaskMode;
 294 }
 295
 296 const SFUInt32 *VisitSubTreeBase::getSFTravMaskMode(void) const
 297 {
 298     return &_sfTravMaskMode;
 299 }
 300
 301
 302
 303
 304
 305
 306 /*------------------------------ access -----------------------------------*/
 307
 308 SizeT VisitSubTreeBase::getBinSize(ConstFieldMaskArg whichField)
 309 {
 310     SizeT returnValue = Inherited::getBinSize(whichField);
 311
 312     if(FieldBits::NoField != (SubTreeRootFieldMask & whichField))
 313     {
 314         returnValue += _sfSubTreeRoot.getBinSize();
 315     }
 316     if(FieldBits::NoField != (SubTreeTravMaskFieldMask & whichField))
 317     {
 318         returnValue += _sfSubTreeTravMask.getBinSize();
 319     }
 320     if(FieldBits::NoField != (TravMaskModeFieldMask & whichField))
 321     {
 322         returnValue += _sfTravMaskMode.getBinSize();
 323     }
 324
 325     return returnValue;
 326 }
 327
 328 void VisitSubTreeBase::copyToBin(BinaryDataHandler &pMem,
 329                                   ConstFieldMaskArg  whichField)
 330 {
 331     Inherited::copyToBin(pMem, whichField);
 332
 333     if(FieldBits::NoField != (SubTreeRootFieldMask & whichField))
 334     {
 335         _sfSubTreeRoot.copyToBin(pMem);
 336     }
 337     if(FieldBits::NoField != (SubTreeTravMaskFieldMask & whichField))
 338     {
 339         _sfSubTreeTravMask.copyToBin(pMem);
 340     }
 341     if(FieldBits::NoField != (TravMaskModeFieldMask & whichField))
 342     {
 343         _sfTravMaskMode.copyToBin(pMem);
 344     }
 345 }
 346
 347 void VisitSubTreeBase::copyFromBin(BinaryDataHandler &pMem,
 348                                     ConstFieldMaskArg  whichField)
 349 {
 350     Inherited::copyFromBin(pMem, whichField);
 351
 352     if(FieldBits::NoField != (SubTreeRootFieldMask & whichField))
 353     {
 354         editSField(SubTreeRootFieldMask);
 355         _sfSubTreeRoot.copyFromBin(pMem);
 356     }
 357     if(FieldBits::NoField != (SubTreeTravMaskFieldMask & whichField))
 358     {
 359         editSField(SubTreeTravMaskFieldMask);
 360         _sfSubTreeTravMask.copyFromBin(pMem);
 361     }
 362     if(FieldBits::NoField != (TravMaskModeFieldMask & whichField))
 363     {
 364         editSField(TravMaskModeFieldMask);
 365         _sfTravMaskMode.copyFromBin(pMem);
 366     }
 367 }
 368
 369 //! create a new instance of the class
 370 VisitSubTreeTransitPtr VisitSubTreeBase::createLocal(BitVector bFlags)
 371 {
 372     VisitSubTreeTransitPtr fc;
 373
 374     if(getClassType().getPrototype() != NULL)
 375     {
 376         FieldContainerTransitPtr tmpPtr =
 377             getClassType().getPrototype()-> shallowCopyLocal(bFlags);
 378
 379         fc = dynamic_pointer_cast<VisitSubTree>(tmpPtr);
 380     }
 381
 382     return fc;
 383 }
 384
 385 //! create a new instance of the class, copy the container flags
 386 VisitSubTreeTransitPtr VisitSubTreeBase::createDependent(BitVector bFlags)
 387 {
 388     VisitSubTreeTransitPtr fc;
 389
 390     if(getClassType().getPrototype() != NULL)
 391     {
 392         FieldContainerTransitPtr tmpPtr =
 393             getClassType().getPrototype()-> shallowCopyDependent(bFlags);
 394
 395         fc = dynamic_pointer_cast<VisitSubTree>(tmpPtr);
 396     }
 397
 398     return fc;
 399 }
 400
 401 //! create a new instance of the class
 402 VisitSubTreeTransitPtr VisitSubTreeBase::create(void)
 403 {
 404     VisitSubTreeTransitPtr fc;
 405
 406     if(getClassType().getPrototype() != NULL)
 407     {
 408         FieldContainerTransitPtr tmpPtr =
 409             getClassType().getPrototype()-> shallowCopy();
 410
 411         fc = dynamic_pointer_cast<VisitSubTree>(tmpPtr);
 412     }
 413
 414     return fc;
 415 }
 416
 417 VisitSubTree *VisitSubTreeBase::createEmptyLocal(BitVector bFlags)
 418 {
 419     VisitSubTree *returnValue;
 420
 421     newPtr<VisitSubTree>(returnValue, bFlags);
 422
 423     returnValue->_pFieldFlags->_bNamespaceMask &= ~bFlags;
 424
 425     return returnValue;
 426 }
 427
 428 //! create an empty new instance of the class, do not copy the prototype
 429 VisitSubTree *VisitSubTreeBase::createEmpty(void)
 430 {
 431     VisitSubTree *returnValue;
 432
 433     newPtr<VisitSubTree>(returnValue, Thread::getCurrentLocalFlags());
 434
 435     returnValue->_pFieldFlags->_bNamespaceMask &=
 436         ~Thread::getCurrentLocalFlags();
 437
 438     return returnValue;
 439 }
 440
 441
 442 FieldContainerTransitPtr VisitSubTreeBase::shallowCopyLocal(
 443     BitVector bFlags) const
 444 {
 445     VisitSubTree *tmpPtr;
 446
 447     newPtr(tmpPtr, dynamic_cast<const VisitSubTree *>(this), bFlags);
 448
 449     FieldContainerTransitPtr returnValue(tmpPtr);
 450
 451     tmpPtr->_pFieldFlags->_bNamespaceMask &= ~bFlags;
 452
 453     return returnValue;
 454 }
 455
 456 FieldContainerTransitPtr VisitSubTreeBase::shallowCopyDependent(
 457     BitVector bFlags) const
 458 {
 459     VisitSubTree *tmpPtr;
 460
 461     newPtr(tmpPtr, dynamic_cast<const VisitSubTree *>(this), ~bFlags);
 462
 463     FieldContainerTransitPtr returnValue(tmpPtr);
 464
 465     tmpPtr->_pFieldFlags->_bNamespaceMask = bFlags;
 466
 467     return returnValue;
 468 }
 469
 470 FieldContainerTransitPtr VisitSubTreeBase::shallowCopy(void) const
 471 {
 472     VisitSubTree *tmpPtr;
 473
 474     newPtr(tmpPtr,
 475            dynamic_cast<const VisitSubTree *>(this),
 476            Thread::getCurrentLocalFlags());
 477
 478     tmpPtr->_pFieldFlags->_bNamespaceMask &= ~Thread::getCurrentLocalFlags();
 479
 480     FieldContainerTransitPtr returnValue(tmpPtr);
 481
 482     return returnValue;
 483 }
 484
 485
 486
 487
 488 /*------------------------- constructors ----------------------------------*/
 489
 490 VisitSubTreeBase::VisitSubTreeBase(void) :
 491     Inherited(),
 492     _sfSubTreeRoot            (NULL),
 493     _sfSubTreeTravMask        (UInt32(TypeTraits<UInt32>::getMax())),
 494     _sfTravMaskMode           (UInt32(VisitSubTree::AndTravMask))
 495 {
 496 }
 497
 498 VisitSubTreeBase::VisitSubTreeBase(const VisitSubTreeBase &source) :
 499     Inherited(source),
 500     _sfSubTreeRoot            (NULL),
 501     _sfSubTreeTravMask        (source._sfSubTreeTravMask        ),
 502     _sfTravMaskMode           (source._sfTravMaskMode           )
 503 {
 504 }
 505
 506
 507 /*-------------------------- destructors ----------------------------------*/
 508
 509 VisitSubTreeBase::~VisitSubTreeBase(void)
 510 {
 511 }
 512
 513 void VisitSubTreeBase::onCreate(const VisitSubTree *source)
 514 {
 515     Inherited::onCreate(source);
 516
 517     if(source != NULL)
 518     {
 519         VisitSubTree *pThis = static_cast<VisitSubTree *>(this);
 520
 521         pThis->setSubTreeRoot(source->getSubTreeRoot());
 522     }
 523 }
 524
 525 GetFieldHandlePtr VisitSubTreeBase::getHandleSubTreeRoot     (void) const
 526 {
 527     SFWeakNodePtr::GetHandlePtr returnValue(
 528         new  SFWeakNodePtr::GetHandle(
 529              &_sfSubTreeRoot,
 530              this->getType().getFieldDesc(SubTreeRootFieldId),
 531              const_cast<VisitSubTreeBase *>(this)));
 532
 533     return returnValue;
 534 }
 535
 536 EditFieldHandlePtr VisitSubTreeBase::editHandleSubTreeRoot    (void)
 537 {
 538     SFWeakNodePtr::EditHandlePtr returnValue(
 539         new  SFWeakNodePtr::EditHandle(
 540              &_sfSubTreeRoot,
 541              this->getType().getFieldDesc(SubTreeRootFieldId),
 542              this));
 543
 544     returnValue->setSetMethod(
 545         boost::bind(&VisitSubTree::setSubTreeRoot,
 546                     static_cast<VisitSubTree *>(this), _1));
 547
 548     editSField(SubTreeRootFieldMask);
 549
 550     return returnValue;
 551 }
 552
 553 GetFieldHandlePtr VisitSubTreeBase::getHandleSubTreeTravMask (void) const
 554 {
 555     SFUInt32::GetHandlePtr returnValue(
 556         new  SFUInt32::GetHandle(
 557              &_sfSubTreeTravMask,
 558              this->getType().getFieldDesc(SubTreeTravMaskFieldId),
 559              const_cast<VisitSubTreeBase *>(this)));
 560
 561     return returnValue;
 562 }
 563
 564 EditFieldHandlePtr VisitSubTreeBase::editHandleSubTreeTravMask(void)
 565 {
 566     SFUInt32::EditHandlePtr returnValue(
 567         new  SFUInt32::EditHandle(
 568              &_sfSubTreeTravMask,
 569              this->getType().getFieldDesc(SubTreeTravMaskFieldId),
 570              this));
 571
 572
 573     editSField(SubTreeTravMaskFieldMask);
 574
 575     return returnValue;
 576 }
 577
 578 GetFieldHandlePtr VisitSubTreeBase::getHandleTravMaskMode    (void) const
 579 {
 580     SFUInt32::GetHandlePtr returnValue(
 581         new  SFUInt32::GetHandle(
 582              &_sfTravMaskMode,
 583              this->getType().getFieldDesc(TravMaskModeFieldId),
 584              const_cast<VisitSubTreeBase *>(this)));
 585
 586     return returnValue;
 587 }
 588
 589 EditFieldHandlePtr VisitSubTreeBase::editHandleTravMaskMode   (void)
 590 {
 591     SFUInt32::EditHandlePtr returnValue(
 592         new  SFUInt32::EditHandle(
 593              &_sfTravMaskMode,
 594              this->getType().getFieldDesc(TravMaskModeFieldId),
 595              this));
 596
 597
 598     editSField(TravMaskModeFieldMask);
 599
 600     return returnValue;
 601 }
 602
 603
 604 #ifdef OSG_MT_CPTR_ASPECT
 605 void VisitSubTreeBase::execSyncV(      FieldContainer    &oFrom,
 606                                         ConstFieldMaskArg  whichField,
 607                                         AspectOffsetStore &oOffsets,
 608                                         ConstFieldMaskArg  syncMode,
 609                                   const UInt32             uiSyncInfo)
 610 {
 611     VisitSubTree *pThis = static_cast<VisitSubTree *>(this);
 612
 613     pThis->execSync(static_cast<VisitSubTree *>(&oFrom),
 614                     whichField,
 615                     oOffsets,
 616                     syncMode,
 617                     uiSyncInfo);
 618 }
 619 #endif
 620
 621
 622 #ifdef OSG_MT_CPTR_ASPECT
 623 FieldContainer *VisitSubTreeBase::createAspectCopy(
 624     const FieldContainer *pRefAspect) const
 625 {
 626     VisitSubTree *returnValue;
 627
 628     newAspectCopy(returnValue,
 629                   dynamic_cast<const VisitSubTree *>(pRefAspect),
 630                   dynamic_cast<const VisitSubTree *>(this));
 631
 632     return returnValue;
 633 }
 634 #endif
 635
 636 void VisitSubTreeBase::resolveLinks(void)
 637 {
 638     Inherited::resolveLinks();
 639
 640     static_cast<VisitSubTree *>(this)->setSubTreeRoot(NULL);
 641
 642
 643 }
 644
 645
 646 OSG_END_NAMESPACE