Source/System/Window/Base/OSGViewportBase.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 Viewport!
  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"          // Parent Class
  66 #include "OSGCamera.h"                  // Camera Class
  67 #include "OSGNode.h"                    // Root Class
  68 #include "OSGBackground.h"              // Background Class
  69 #include "OSGForeground.h"              // Foregrounds Class
  70
  71 #include "OSGViewportBase.h"
  72 #include "OSGViewport.h"
  73
  74 #include <boost/bind.hpp>
  75
  76 OSG_BEGIN_NAMESPACE
  77
  78 /***************************************************************************\
  79  *                            Description                                  *
  80 \***************************************************************************/
  81
  82 /*! \class OSG::Viewport
  83     A Viewport is a part of the Window it is attached to used for rendering. See
  84     \ref PageSystemWindowViewports for a description.
  85
  86     The size of the viewport is defined by the _sfLeft, _sfRight, _sfBottom and
  87     _sfTop Fields. The Window this Viewport is attached is stored in _sfWindow.
  88     _sfBackground defines the background clearing method, the
  89     _sfRoot and _sfCamera Fields the scene being rendered and the camera used to
  90     view it. The optional _mfForegrounds define which information are added or
  91     actions are executed after the Viewport has been rendered.
  92
  93     \ext
  94
  95     To create a new Viewport the draw and render methods should be overridden.
  96
  97     \endext
  98
  99     \dev
 100
 101     When adding fields to the Viewport, make sure to add the code to copy them to
 102     all the different ClusterWindows!
 103
 104     \enddev
 105  */
 106
 107 /***************************************************************************\
 108  *                        Field Documentation                              *
 109 \***************************************************************************/
 110
 111 /*! \var FieldContainer * ViewportBase::_sfParent
 112     The Window this viewport is contained in.
 113 */
 114
 115 /*! \var Camera *        ViewportBase::_sfCamera
 116     The Camera used to render the viewport.
 117 */
 118
 119 /*! \var Node *          ViewportBase::_sfRoot
 120     The root of the tree that is displayed in this viewport.
 121 */
 122
 123 /*! \var Background *    ViewportBase::_sfBackground
 124     The background used to clear this viewport.
 125 */
 126
 127 /*! \var Foreground *    ViewportBase::_mfForegrounds
 128     The foreground additions to the rendered image.
 129 */
 130
 131
 132 /***************************************************************************\
 133  *                      FieldType/FieldTrait Instantiation                 *
 134 \***************************************************************************/
 135
 136 #if !defined(OSG_DO_DOC) || defined(OSG_DOC_DEV)
 137 PointerType FieldTraits<Viewport *, nsOSG>::_type(
 138     "ViewportPtr",
 139     "ViewareaPtr",
 140     Viewport::getClassType(),
 141     nsOSG);
 142 #endif
 143
 144 OSG_FIELDTRAITS_GETTYPE_NS(Viewport *, nsOSG)
 145
 146 OSG_EXPORT_PTR_SFIELD_FULL(PointerSField,
 147                            Viewport *,
 148                            nsOSG)
 149
 150 OSG_EXPORT_PTR_MFIELD_FULL(PointerMField,
 151                            Viewport *,
 152                            nsOSG)
 153
 154 DataType &FieldTraits< Viewport *, nsOSG + 1 >::getType(void)
 155 {
 156     return FieldTraits<Viewport *, nsOSG>::getType();
 157 }
 158
 159
 160 OSG_EXPORT_PTR_MFIELD(ChildPointerMField,
 161                       Viewport *,
 162                       UnrecordedRefCountPolicy,
 163                       nsOSG + 1)
 164
 165
 166 /***************************************************************************\
 167  *                         Field Description                               *
 168 \***************************************************************************/
 169
 170 void ViewportBase::classDescInserter(TypeObject &oType)
 171 {
 172     FieldDescriptionBase *pDesc = NULL;
 173
 174
 175     pDesc = new SFParentFieldContainerPtr::Description(
 176         SFParentFieldContainerPtr::getClassType(),
 177         "parent",
 178         "The Window this viewport is contained in.\n",
 179         ParentFieldId, ParentFieldMask,
 180         false,
 181         (Field::SFDefaultFlags | Field::FStdAccess),
 182         static_cast     <FieldEditMethodSig>(&Viewport::invalidEditField),
 183         static_cast     <FieldGetMethodSig >(&Viewport::invalidGetField));
 184
 185     oType.addInitialDesc(pDesc);
 186
 187     pDesc = new SFUnrecCameraPtr::Description(
 188         SFUnrecCameraPtr::getClassType(),
 189         "camera",
 190         "The Camera used to render the viewport.\n",
 191         CameraFieldId, CameraFieldMask,
 192         false,
 193         (Field::SFDefaultFlags | Field::FStdAccess),
 194         static_cast<FieldEditMethodSig>(&Viewport::editHandleCamera),
 195         static_cast<FieldGetMethodSig >(&Viewport::getHandleCamera));
 196
 197     oType.addInitialDesc(pDesc);
 198
 199     pDesc = new SFUnrecNodePtr::Description(
 200         SFUnrecNodePtr::getClassType(),
 201         "root",
 202         "The root of the tree that is displayed in this viewport.\n",
 203         RootFieldId, RootFieldMask,
 204         false,
 205         (Field::SFDefaultFlags | Field::FStdAccess),
 206         static_cast<FieldEditMethodSig>(&Viewport::editHandleRoot),
 207         static_cast<FieldGetMethodSig >(&Viewport::getHandleRoot));
 208
 209     oType.addInitialDesc(pDesc);
 210
 211     pDesc = new SFUnrecBackgroundPtr::Description(
 212         SFUnrecBackgroundPtr::getClassType(),
 213         "background",
 214         "The background used to clear this viewport.\n",
 215         BackgroundFieldId, BackgroundFieldMask,
 216         false,
 217         (Field::SFDefaultFlags | Field::FStdAccess),
 218         static_cast<FieldEditMethodSig>(&Viewport::editHandleBackground),
 219         static_cast<FieldGetMethodSig >(&Viewport::getHandleBackground));
 220
 221     oType.addInitialDesc(pDesc);
 222
 223     pDesc = new MFUnrecForegroundPtr::Description(
 224         MFUnrecForegroundPtr::getClassType(),
 225         "foregrounds",
 226         "The foreground additions to the rendered image.\n",
 227         ForegroundsFieldId, ForegroundsFieldMask,
 228         false,
 229         (Field::MFDefaultFlags | Field::FStdAccess),
 230         static_cast<FieldEditMethodSig>(&Viewport::editHandleForegrounds),
 231         static_cast<FieldGetMethodSig >(&Viewport::getHandleForegrounds));
 232
 233     oType.addInitialDesc(pDesc);
 234 }
 235
 236
 237 ViewportBase::TypeObject ViewportBase::_type(
 238     ViewportBase::getClassname(),
 239     Inherited::getClassname(),
 240     "NULL",
 241     nsOSG, //Namespace
 242     reinterpret_cast<PrototypeCreateF>(&ViewportBase::createEmptyLocal),
 243     reinterpret_cast<InitContainerF>(&Viewport::initMethod),
 244     reinterpret_cast<ExitContainerF>(&Viewport::exitMethod),
 245     reinterpret_cast<InitalInsertDescFunc>(
 246         reinterpret_cast<void *>(&Viewport::classDescInserter)),
 247     false,
 248     0,
 249     "<?xml version=\"1.0\"?>\n"
 250     "\n"
 251     "<FieldContainer\n"
 252     "   name=\"Viewport\"\n"
 253     "   parent=\"Viewarea\"\n"
 254     "   library=\"System\"\n"
 255     "   pointerfieldtypes=\"both\"\n"
 256     "   structure=\"concrete\"\n"
 257     "   systemcomponent=\"true\"\n"
 258     "   parentsystemcomponent=\"true\"\n"
 259     "   childFields=\"multi\"\n"
 260     "   docGroupBase=\"GrpSystemWindow\"\n"
 261     "   >\n"
 262     "\n"
 263     "  A Viewport is a part of the Window it is attached to used for rendering. See\n"
 264     "  \\ref PageSystemWindowViewports for a description.\n"
 265     "\n"
 266     "  The size of the viewport is defined by the _sfLeft, _sfRight, _sfBottom and\n"
 267     "  _sfTop Fields. The Window this Viewport is attached is stored in _sfWindow.\n"
 268     "  _sfBackground defines the background clearing method, the\n"
 269     "  _sfRoot and _sfCamera Fields the scene being rendered and the camera used to\n"
 270     "  view it. The optional _mfForegrounds define which information are added or\n"
 271     "  actions are executed after the Viewport has been rendered.\n"
 272     "  \n"
 273     "  \\ext\n"
 274     "\n"
 275     "  To create a new Viewport the draw and render methods should be overridden. \n"
 276     "  \n"
 277     "  \\endext\n"
 278     "  \n"
 279     "  \\dev\n"
 280     "\n"
 281     "  When adding fields to the Viewport, make sure to add the code to copy them to\n"
 282     "  all the different ClusterWindows!\n"
 283     "  \n"
 284     "  \\enddev\n"
 285     "\n"
 286     "  <Field\n"
 287     "      name=\"parent\"\n"
 288     "      type=\"FieldContainer\"\n"
 289     "      cardinality=\"single\"\n"
 290     "      visibility=\"external\"\n"
 291     "      access=\"none\"\n"
 292     "      category=\"parentpointer\"\n"
 293     "       >\n"
 294     "    The Window this viewport is contained in.\n"
 295     "  </Field>\n"
 296     "  <Field\n"
 297     "      name=\"camera\"\n"
 298     "      type=\"CameraPtr\"\n"
 299     "      cardinality=\"single\"\n"
 300     "      visibility=\"external\"\n"
 301     "      access=\"public\"\n"
 302     "      >\n"
 303     "    The Camera used to render the viewport.\n"
 304     "  </Field>\n"
 305     "  <Field\n"
 306     "      name=\"root\"\n"
 307     "      type=\"NodePtr\"\n"
 308     "      cardinality=\"single\"\n"
 309     "      visibility=\"external\"\n"
 310     "      access=\"public\"\n"
 311     "      >\n"
 312     "    The root of the tree that is displayed in this viewport.\n"
 313     "  </Field>\n"
 314     "  <Field\n"
 315     "      name=\"background\"\n"
 316     "      type=\"BackgroundPtr\"\n"
 317     "      cardinality=\"single\"\n"
 318     "      visibility=\"external\"\n"
 319     "      access=\"public\"\n"
 320     "      >\n"
 321     "    The background used to clear this viewport.\n"
 322     "  </Field>\n"
 323     "  <Field\n"
 324     "      name=\"foregrounds\"\n"
 325     "      type=\"ForegroundPtr\"\n"
 326     "      cardinality=\"multi\"\n"
 327     "      visibility=\"external\"\n"
 328     "      access=\"public\"\n"
 329     "      pushToFieldAs=\"addForeground\"\n"
 330     "      >\n"
 331     "    The foreground additions to the rendered image.\n"
 332     "  </Field>\n"
 333     "</FieldContainer>\n",
 334     "A Viewport is a part of the Window it is attached to used for rendering. See\n"
 335     "\\ref PageSystemWindowViewports for a description.\n"
 336     "\n"
 337     "The size of the viewport is defined by the _sfLeft, _sfRight, _sfBottom and\n"
 338     "_sfTop Fields. The Window this Viewport is attached is stored in _sfWindow.\n"
 339     "_sfBackground defines the background clearing method, the\n"
 340     "_sfRoot and _sfCamera Fields the scene being rendered and the camera used to\n"
 341     "view it. The optional _mfForegrounds define which information are added or\n"
 342     "actions are executed after the Viewport has been rendered.\n"
 343     "\n"
 344     "\\ext\n"
 345     "\n"
 346     "To create a new Viewport the draw and render methods should be overridden. \n"
 347     "\n"
 348     "\\endext\n"
 349     "\n"
 350     "\\dev\n"
 351     "\n"
 352     "When adding fields to the Viewport, make sure to add the code to copy them to\n"
 353     "all the different ClusterWindows!\n"
 354     "\n"
 355     "\\enddev\n"
 356     );
 357
 358 /*------------------------------ get -----------------------------------*/
 359
 360 FieldContainerType &ViewportBase::getType(void)
 361 {
 362     return _type;
 363 }
 364
 365 const FieldContainerType &ViewportBase::getType(void) const
 366 {
 367     return _type;
 368 }
 369
 370 UInt32 ViewportBase::getContainerSize(void) const
 371 {
 372     return sizeof(Viewport);
 373 }
 374
 375 /*------------------------- decorator get ------------------------------*/
 376
 377
 378
 379 //! Get the Viewport::_sfCamera field.
 380 const SFUnrecCameraPtr *ViewportBase::getSFCamera(void) const
 381 {
 382     return &_sfCamera;
 383 }
 384
 385 SFUnrecCameraPtr    *ViewportBase::editSFCamera         (void)
 386 {
 387     editSField(CameraFieldMask);
 388
 389     return &_sfCamera;
 390 }
 391
 392 //! Get the value of the Viewport::_sfCamera field.
 393 Camera * ViewportBase::getCamera(void) const
 394 {
 395     return _sfCamera.getValue();
 396 }
 397
 398 //! Set the value of the Viewport::_sfCamera field.
 399 void ViewportBase::setCamera(Camera * const value)
 400 {
 401     editSField(CameraFieldMask);
 402
 403     _sfCamera.setValue(value);
 404 }
 405
 406
 407 //! Get the Viewport::_sfRoot field.
 408 const SFUnrecNodePtr *ViewportBase::getSFRoot(void) const
 409 {
 410     return &_sfRoot;
 411 }
 412
 413 SFUnrecNodePtr      *ViewportBase::editSFRoot           (void)
 414 {
 415     editSField(RootFieldMask);
 416
 417     return &_sfRoot;
 418 }
 419
 420 //! Get the value of the Viewport::_sfRoot field.
 421 Node * ViewportBase::getRoot(void) const
 422 {
 423     return _sfRoot.getValue();
 424 }
 425
 426 //! Set the value of the Viewport::_sfRoot field.
 427 void ViewportBase::setRoot(Node * const value)
 428 {
 429     editSField(RootFieldMask);
 430
 431     _sfRoot.setValue(value);
 432 }
 433
 434
 435 //! Get the Viewport::_sfBackground field.
 436 const SFUnrecBackgroundPtr *ViewportBase::getSFBackground(void) const
 437 {
 438     return &_sfBackground;
 439 }
 440
 441 SFUnrecBackgroundPtr *ViewportBase::editSFBackground     (void)
 442 {
 443     editSField(BackgroundFieldMask);
 444
 445     return &_sfBackground;
 446 }
 447
 448 //! Get the value of the Viewport::_sfBackground field.
 449 Background * ViewportBase::getBackground(void) const
 450 {
 451     return _sfBackground.getValue();
 452 }
 453
 454 //! Set the value of the Viewport::_sfBackground field.
 455 void ViewportBase::setBackground(Background * const value)
 456 {
 457     editSField(BackgroundFieldMask);
 458
 459     _sfBackground.setValue(value);
 460 }
 461
 462
 463 //! Get the Viewport::_mfForegrounds field.
 464 const MFUnrecForegroundPtr *ViewportBase::getMFForegrounds(void) const
 465 {
 466     return &_mfForegrounds;
 467 }
 468
 469 MFUnrecForegroundPtr *ViewportBase::editMFForegrounds    (void)
 470 {
 471     editMField(ForegroundsFieldMask, _mfForegrounds);
 472
 473     return &_mfForegrounds;
 474 }
 475 Foreground * ViewportBase::getForegrounds(const UInt32 index) const
 476 {
 477     return _mfForegrounds[index];
 478 }
 479
 480
 481
 482 void ViewportBase::addForeground(Foreground * const value)
 483 {
 484     editMField(ForegroundsFieldMask, _mfForegrounds);
 485
 486     _mfForegrounds.push_back(value);
 487 }
 488
 489 void ViewportBase::assignForegrounds(const MFUnrecForegroundPtr &value)
 490 {
 491     MFUnrecForegroundPtr::const_iterator elemIt  =
 492         value.begin();
 493     MFUnrecForegroundPtr::const_iterator elemEnd =
 494         value.end  ();
 495
 496     static_cast<Viewport *>(this)->clearForegrounds();
 497
 498     while(elemIt != elemEnd)
 499     {
 500         this->addForeground(*elemIt);
 501
 502         ++elemIt;
 503     }
 504 }
 505
 506 void ViewportBase::removeFromForegrounds(UInt32 uiIndex)
 507 {
 508     if(uiIndex < _mfForegrounds.size())
 509     {
 510         editMField(ForegroundsFieldMask, _mfForegrounds);
 511
 512         _mfForegrounds.erase(uiIndex);
 513     }
 514 }
 515
 516 void ViewportBase::removeObjFromForegrounds(Foreground * const value)
 517 {
 518     Int32 iElemIdx = _mfForegrounds.findIndex(value);
 519
 520     if(iElemIdx != -1)
 521     {
 522         editMField(ForegroundsFieldMask, _mfForegrounds);
 523
 524         _mfForegrounds.erase(iElemIdx);
 525     }
 526 }
 527 void ViewportBase::clearForegrounds(void)
 528 {
 529     editMField(ForegroundsFieldMask, _mfForegrounds);
 530
 531
 532     _mfForegrounds.clear();
 533 }
 534
 535
 536
 537 /*------------------------------ access -----------------------------------*/
 538
 539 SizeT ViewportBase::getBinSize(ConstFieldMaskArg whichField)
 540 {
 541     SizeT returnValue = Inherited::getBinSize(whichField);
 542
 543     if(FieldBits::NoField != (ParentFieldMask & whichField))
 544     {
 545         returnValue += _sfParent.getBinSize();
 546     }
 547     if(FieldBits::NoField != (CameraFieldMask & whichField))
 548     {
 549         returnValue += _sfCamera.getBinSize();
 550     }
 551     if(FieldBits::NoField != (RootFieldMask & whichField))
 552     {
 553         returnValue += _sfRoot.getBinSize();
 554     }
 555     if(FieldBits::NoField != (BackgroundFieldMask & whichField))
 556     {
 557         returnValue += _sfBackground.getBinSize();
 558     }
 559     if(FieldBits::NoField != (ForegroundsFieldMask & whichField))
 560     {
 561         returnValue += _mfForegrounds.getBinSize();
 562     }
 563
 564     return returnValue;
 565 }
 566
 567 void ViewportBase::copyToBin(BinaryDataHandler &pMem,
 568                                   ConstFieldMaskArg  whichField)
 569 {
 570     Inherited::copyToBin(pMem, whichField);
 571
 572     if(FieldBits::NoField != (ParentFieldMask & whichField))
 573     {
 574         _sfParent.copyToBin(pMem);
 575     }
 576     if(FieldBits::NoField != (CameraFieldMask & whichField))
 577     {
 578         _sfCamera.copyToBin(pMem);
 579     }
 580     if(FieldBits::NoField != (RootFieldMask & whichField))
 581     {
 582         _sfRoot.copyToBin(pMem);
 583     }
 584     if(FieldBits::NoField != (BackgroundFieldMask & whichField))
 585     {
 586         _sfBackground.copyToBin(pMem);
 587     }
 588     if(FieldBits::NoField != (ForegroundsFieldMask & whichField))
 589     {
 590         _mfForegrounds.copyToBin(pMem);
 591     }
 592 }
 593
 594 void ViewportBase::copyFromBin(BinaryDataHandler &pMem,
 595                                     ConstFieldMaskArg  whichField)
 596 {
 597     Inherited::copyFromBin(pMem, whichField);
 598
 599     if(FieldBits::NoField != (ParentFieldMask & whichField))
 600     {
 601         editSField(ParentFieldMask);
 602         _sfParent.copyFromBin(pMem);
 603     }
 604     if(FieldBits::NoField != (CameraFieldMask & whichField))
 605     {
 606         editSField(CameraFieldMask);
 607         _sfCamera.copyFromBin(pMem);
 608     }
 609     if(FieldBits::NoField != (RootFieldMask & whichField))
 610     {
 611         editSField(RootFieldMask);
 612         _sfRoot.copyFromBin(pMem);
 613     }
 614     if(FieldBits::NoField != (BackgroundFieldMask & whichField))
 615     {
 616         editSField(BackgroundFieldMask);
 617         _sfBackground.copyFromBin(pMem);
 618     }
 619     if(FieldBits::NoField != (ForegroundsFieldMask & whichField))
 620     {
 621         editMField(ForegroundsFieldMask, _mfForegrounds);
 622         _mfForegrounds.copyFromBin(pMem);
 623     }
 624 }
 625
 626 //! create a new instance of the class
 627 ViewportTransitPtr ViewportBase::createLocal(BitVector bFlags)
 628 {
 629     ViewportTransitPtr fc;
 630
 631     if(getClassType().getPrototype() != NULL)
 632     {
 633         FieldContainerTransitPtr tmpPtr =
 634             getClassType().getPrototype()-> shallowCopyLocal(bFlags);
 635
 636         fc = dynamic_pointer_cast<Viewport>(tmpPtr);
 637     }
 638
 639     return fc;
 640 }
 641
 642 //! create a new instance of the class, copy the container flags
 643 ViewportTransitPtr ViewportBase::createDependent(BitVector bFlags)
 644 {
 645     ViewportTransitPtr fc;
 646
 647     if(getClassType().getPrototype() != NULL)
 648     {
 649         FieldContainerTransitPtr tmpPtr =
 650             getClassType().getPrototype()-> shallowCopyDependent(bFlags);
 651
 652         fc = dynamic_pointer_cast<Viewport>(tmpPtr);
 653     }
 654
 655     return fc;
 656 }
 657
 658 //! create a new instance of the class
 659 ViewportTransitPtr ViewportBase::create(void)
 660 {
 661     ViewportTransitPtr fc;
 662
 663     if(getClassType().getPrototype() != NULL)
 664     {
 665         FieldContainerTransitPtr tmpPtr =
 666             getClassType().getPrototype()-> shallowCopy();
 667
 668         fc = dynamic_pointer_cast<Viewport>(tmpPtr);
 669     }
 670
 671     return fc;
 672 }
 673
 674 Viewport *ViewportBase::createEmptyLocal(BitVector bFlags)
 675 {
 676     Viewport *returnValue;
 677
 678     newPtr<Viewport>(returnValue, bFlags);
 679
 680     returnValue->_pFieldFlags->_bNamespaceMask &= ~bFlags;
 681
 682     return returnValue;
 683 }
 684
 685 //! create an empty new instance of the class, do not copy the prototype
 686 Viewport *ViewportBase::createEmpty(void)
 687 {
 688     Viewport *returnValue;
 689
 690     newPtr<Viewport>(returnValue, Thread::getCurrentLocalFlags());
 691
 692     returnValue->_pFieldFlags->_bNamespaceMask &=
 693         ~Thread::getCurrentLocalFlags();
 694
 695     return returnValue;
 696 }
 697
 698
 699 FieldContainerTransitPtr ViewportBase::shallowCopyLocal(
 700     BitVector bFlags) const
 701 {
 702     Viewport *tmpPtr;
 703
 704     newPtr(tmpPtr, dynamic_cast<const Viewport *>(this), bFlags);
 705
 706     FieldContainerTransitPtr returnValue(tmpPtr);
 707
 708     tmpPtr->_pFieldFlags->_bNamespaceMask &= ~bFlags;
 709
 710     return returnValue;
 711 }
 712
 713 FieldContainerTransitPtr ViewportBase::shallowCopyDependent(
 714     BitVector bFlags) const
 715 {
 716     Viewport *tmpPtr;
 717
 718     newPtr(tmpPtr, dynamic_cast<const Viewport *>(this), ~bFlags);
 719
 720     FieldContainerTransitPtr returnValue(tmpPtr);
 721
 722     tmpPtr->_pFieldFlags->_bNamespaceMask = bFlags;
 723
 724     return returnValue;
 725 }
 726
 727 FieldContainerTransitPtr ViewportBase::shallowCopy(void) const
 728 {
 729     Viewport *tmpPtr;
 730
 731     newPtr(tmpPtr,
 732            dynamic_cast<const Viewport *>(this),
 733            Thread::getCurrentLocalFlags());
 734
 735     tmpPtr->_pFieldFlags->_bNamespaceMask &= ~Thread::getCurrentLocalFlags();
 736
 737     FieldContainerTransitPtr returnValue(tmpPtr);
 738
 739     return returnValue;
 740 }
 741
 742
 743
 744
 745 /*------------------------- constructors ----------------------------------*/
 746
 747 ViewportBase::ViewportBase(void) :
 748     Inherited(),
 749     _sfParent                 (NULL),
 750     _sfCamera                 (NULL),
 751     _sfRoot                   (NULL),
 752     _sfBackground             (NULL),
 753     _mfForegrounds            ()
 754 {
 755 }
 756
 757 ViewportBase::ViewportBase(const ViewportBase &source) :
 758     Inherited(source),
 759     _sfParent                 (NULL),
 760     _sfCamera                 (NULL),
 761     _sfRoot                   (NULL),
 762     _sfBackground             (NULL),
 763     _mfForegrounds            ()
 764 {
 765 }
 766
 767
 768 /*-------------------------- destructors ----------------------------------*/
 769
 770 ViewportBase::~ViewportBase(void)
 771 {
 772 }
 773 /*-------------------------------------------------------------------------*/
 774 /* Parent linking                                                          */
 775
 776 bool ViewportBase::linkParent(
 777     FieldContainer * const pParent,
 778     UInt16           const childFieldId,
 779     UInt16           const parentFieldId )
 780 {
 781     if(parentFieldId == ParentFieldId)
 782     {
 783         FieldContainer * pTypedParent =
 784             dynamic_cast< FieldContainer * >(pParent);
 785
 786         if(pTypedParent != NULL)
 787         {
 788             FieldContainer *pOldParent =
 789                 _sfParent.getValue         ();
 790
 791             UInt16 oldChildFieldId =
 792                 _sfParent.getParentFieldPos();
 793
 794             if(pOldParent != NULL)
 795             {
 796                 pOldParent->unlinkChild(this, oldChildFieldId);
 797             }
 798
 799             editSField(ParentFieldMask);
 800
 801             _sfParent.setValue(static_cast<FieldContainer *>(pParent), childFieldId);
 802
 803             return true;
 804         }
 805
 806         return false;
 807     }
 808
 809     return Inherited::linkParent(pParent, childFieldId, parentFieldId);
 810 }
 811
 812 bool ViewportBase::unlinkParent(
 813     FieldContainer * const pParent,
 814     UInt16           const parentFieldId)
 815 {
 816     if(parentFieldId == ParentFieldId)
 817     {
 818         FieldContainer * pTypedParent =
 819             dynamic_cast< FieldContainer * >(pParent);
 820
 821         if(pTypedParent != NULL)
 822         {
 823             if(_sfParent.getValue() == pTypedParent)
 824             {
 825                 editSField(ParentFieldMask);
 826
 827                 _sfParent.setValue(NULL, 0xFFFF);
 828
 829                 return true;
 830             }
 831
 832             SWARNING << "Child (["          << this
 833                      << "] id ["            << this->getId()
 834                      << "] type ["          << this->getType().getCName()
 835                      << "] parentFieldId [" << parentFieldId
 836                      << "]) - Parent (["    << pParent
 837                      << "] id ["            << pParent->getId()
 838                      << "] type ["          << pParent->getType().getCName()
 839                      << "]): link inconsistent!"
 840                      << std::endl;
 841
 842             return false;
 843         }
 844
 845         return false;
 846     }
 847
 848     return Inherited::unlinkParent(pParent, parentFieldId);
 849 }
 850
 851
 852 void ViewportBase::onCreate(const Viewport *source)
 853 {
 854     Inherited::onCreate(source);
 855
 856     if(source != NULL)
 857     {
 858         Viewport *pThis = static_cast<Viewport *>(this);
 859
 860         pThis->setCamera(source->getCamera());
 861
 862         pThis->setRoot(source->getRoot());
 863
 864         pThis->setBackground(source->getBackground());
 865
 866         MFUnrecForegroundPtr::const_iterator ForegroundsIt  =
 867             source->_mfForegrounds.begin();
 868         MFUnrecForegroundPtr::const_iterator ForegroundsEnd =
 869             source->_mfForegrounds.end  ();
 870
 871         while(ForegroundsIt != ForegroundsEnd)
 872         {
 873             pThis->addForeground(*ForegroundsIt);
 874
 875             ++ForegroundsIt;
 876         }
 877     }
 878 }
 879
 880 GetFieldHandlePtr ViewportBase::getHandleParent          (void) const
 881 {
 882     SFParentFieldContainerPtr::GetHandlePtr returnValue;
 883
 884     return returnValue;
 885 }
 886
 887 EditFieldHandlePtr ViewportBase::editHandleParent         (void)
 888 {
 889     EditFieldHandlePtr returnValue;
 890
 891     return returnValue;
 892 }
 893
 894 GetFieldHandlePtr ViewportBase::getHandleCamera          (void) const
 895 {
 896     SFUnrecCameraPtr::GetHandlePtr returnValue(
 897         new  SFUnrecCameraPtr::GetHandle(
 898              &_sfCamera,
 899              this->getType().getFieldDesc(CameraFieldId),
 900              const_cast<ViewportBase *>(this)));
 901
 902     return returnValue;
 903 }
 904
 905 EditFieldHandlePtr ViewportBase::editHandleCamera         (void)
 906 {
 907     SFUnrecCameraPtr::EditHandlePtr returnValue(
 908         new  SFUnrecCameraPtr::EditHandle(
 909              &_sfCamera,
 910              this->getType().getFieldDesc(CameraFieldId),
 911              this));
 912
 913     returnValue->setSetMethod(
 914         boost::bind(&Viewport::setCamera,
 915                     static_cast<Viewport *>(this), _1));
 916
 917     editSField(CameraFieldMask);
 918
 919     return returnValue;
 920 }
 921
 922 GetFieldHandlePtr ViewportBase::getHandleRoot            (void) const
 923 {
 924     SFUnrecNodePtr::GetHandlePtr returnValue(
 925         new  SFUnrecNodePtr::GetHandle(
 926              &_sfRoot,
 927              this->getType().getFieldDesc(RootFieldId),
 928              const_cast<ViewportBase *>(this)));
 929
 930     return returnValue;
 931 }
 932
 933 EditFieldHandlePtr ViewportBase::editHandleRoot           (void)
 934 {
 935     SFUnrecNodePtr::EditHandlePtr returnValue(
 936         new  SFUnrecNodePtr::EditHandle(
 937              &_sfRoot,
 938              this->getType().getFieldDesc(RootFieldId),
 939              this));
 940
 941     returnValue->setSetMethod(
 942         boost::bind(&Viewport::setRoot,
 943                     static_cast<Viewport *>(this), _1));
 944
 945     editSField(RootFieldMask);
 946
 947     return returnValue;
 948 }
 949
 950 GetFieldHandlePtr ViewportBase::getHandleBackground      (void) const
 951 {
 952     SFUnrecBackgroundPtr::GetHandlePtr returnValue(
 953         new  SFUnrecBackgroundPtr::GetHandle(
 954              &_sfBackground,
 955              this->getType().getFieldDesc(BackgroundFieldId),
 956              const_cast<ViewportBase *>(this)));
 957
 958     return returnValue;
 959 }
 960
 961 EditFieldHandlePtr ViewportBase::editHandleBackground     (void)
 962 {
 963     SFUnrecBackgroundPtr::EditHandlePtr returnValue(
 964         new  SFUnrecBackgroundPtr::EditHandle(
 965              &_sfBackground,
 966              this->getType().getFieldDesc(BackgroundFieldId),
 967              this));
 968
 969     returnValue->setSetMethod(
 970         boost::bind(&Viewport::setBackground,
 971                     static_cast<Viewport *>(this), _1));
 972
 973     editSField(BackgroundFieldMask);
 974
 975     return returnValue;
 976 }
 977
 978 GetFieldHandlePtr ViewportBase::getHandleForegrounds     (void) const
 979 {
 980     MFUnrecForegroundPtr::GetHandlePtr returnValue(
 981         new  MFUnrecForegroundPtr::GetHandle(
 982              &_mfForegrounds,
 983              this->getType().getFieldDesc(ForegroundsFieldId),
 984              const_cast<ViewportBase *>(this)));
 985
 986     return returnValue;
 987 }
 988
 989 EditFieldHandlePtr ViewportBase::editHandleForegrounds    (void)
 990 {
 991     MFUnrecForegroundPtr::EditHandlePtr returnValue(
 992         new  MFUnrecForegroundPtr::EditHandle(
 993              &_mfForegrounds,
 994              this->getType().getFieldDesc(ForegroundsFieldId),
 995              this));
 996
 997     returnValue->setAddMethod(
 998         boost::bind(&Viewport::addForeground,
 999                     static_cast<Viewport *>(this), _1));
1000     returnValue->setRemoveMethod(
1001         boost::bind(&Viewport::removeFromForegrounds,
1002                     static_cast<Viewport *>(this), _1));
1003     returnValue->setRemoveObjMethod(
1004         boost::bind(&Viewport::removeObjFromForegrounds,
1005                     static_cast<Viewport *>(this), _1));
1006     returnValue->setClearMethod(
1007         boost::bind(&Viewport::clearForegrounds,
1008                     static_cast<Viewport *>(this)));
1009
1010     editMField(ForegroundsFieldMask, _mfForegrounds);
1011
1012     return returnValue;
1013 }
1014
1015
1016 #ifdef OSG_MT_CPTR_ASPECT
1017 void ViewportBase::execSyncV(      FieldContainer    &oFrom,
1018                                         ConstFieldMaskArg  whichField,
1019                                         AspectOffsetStore &oOffsets,
1020                                         ConstFieldMaskArg  syncMode,
1021                                   const UInt32             uiSyncInfo)
1022 {
1023     Viewport *pThis = static_cast<Viewport *>(this);
1024
1025     pThis->execSync(static_cast<Viewport *>(&oFrom),
1026                     whichField,
1027                     oOffsets,
1028                     syncMode,
1029                     uiSyncInfo);
1030 }
1031 #endif
1032
1033
1034 #ifdef OSG_MT_CPTR_ASPECT
1035 FieldContainer *ViewportBase::createAspectCopy(
1036     const FieldContainer *pRefAspect) const
1037 {
1038     Viewport *returnValue;
1039
1040     newAspectCopy(returnValue,
1041                   dynamic_cast<const Viewport *>(pRefAspect),
1042                   dynamic_cast<const Viewport *>(this));
1043
1044     return returnValue;
1045 }
1046 #endif
1047
1048 void ViewportBase::resolveLinks(void)
1049 {
1050     Inherited::resolveLinks();
1051
1052     static_cast<Viewport *>(this)->setCamera(NULL);
1053
1054     static_cast<Viewport *>(this)->setRoot(NULL);
1055
1056     static_cast<Viewport *>(this)->setBackground(NULL);
1057
1058     static_cast<Viewport *>(this)->clearForegrounds();
1059
1060
1061 }
1062
1063
1064 OSG_END_NAMESPACE