Source/System/Window/Viewport/OSGStereoBufferViewportBase.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 StereoBufferViewport!
  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
  66 #include "OSGStereoBufferViewportBase.h"
  67 #include "OSGStereoBufferViewport.h"
  68
  69 #include <boost/bind.hpp>
  70
  71 OSG_BEGIN_NAMESPACE
  72
  73 /***************************************************************************\
  74  *                            Description                                  *
  75 \***************************************************************************/
  76
  77 /*! \class OSG::StereoBufferViewport
  78     Viewport for quad-buffered stereo rendering, see \ref
  79     PageSystemWindowViewports for a description.
  80
  81     The active buffers are selected using the _sfLeftBuffer and _sfRightBuffer
  82     Fields.
  83  */
  84
  85 /***************************************************************************\
  86  *                        Field Documentation                              *
  87 \***************************************************************************/
  88
  89 /*! \var bool            StereoBufferViewportBase::_sfLeftBuffer
  90     Defines whether the left buffer is written to.
  91 */
  92
  93 /*! \var bool            StereoBufferViewportBase::_sfRightBuffer
  94     Defines whether the right buffer is written to.
  95 */
  96
  97
  98 /***************************************************************************\
  99  *                      FieldType/FieldTrait Instantiation                 *
 100 \***************************************************************************/
 101
 102 #if !defined(OSG_DO_DOC) || defined(OSG_DOC_DEV)
 103 PointerType FieldTraits<StereoBufferViewport *, nsOSG>::_type(
 104     "StereoBufferViewportPtr",
 105     "ViewportPtr",
 106     StereoBufferViewport::getClassType(),
 107     nsOSG);
 108 #endif
 109
 110 OSG_FIELDTRAITS_GETTYPE_NS(StereoBufferViewport *, nsOSG)
 111
 112 OSG_EXPORT_PTR_SFIELD_FULL(PointerSField,
 113                            StereoBufferViewport *,
 114                            nsOSG)
 115
 116 OSG_EXPORT_PTR_MFIELD_FULL(PointerMField,
 117                            StereoBufferViewport *,
 118                            nsOSG)
 119
 120 /***************************************************************************\
 121  *                         Field Description                               *
 122 \***************************************************************************/
 123
 124 void StereoBufferViewportBase::classDescInserter(TypeObject &oType)
 125 {
 126     FieldDescriptionBase *pDesc = NULL;
 127
 128
 129     pDesc = new SFBool::Description(
 130         SFBool::getClassType(),
 131         "leftBuffer",
 132         "Defines whether the left buffer is written to.\n",
 133         LeftBufferFieldId, LeftBufferFieldMask,
 134         false,
 135         (Field::SFDefaultFlags | Field::FStdAccess),
 136         static_cast<FieldEditMethodSig>(&StereoBufferViewport::editHandleLeftBuffer),
 137         static_cast<FieldGetMethodSig >(&StereoBufferViewport::getHandleLeftBuffer));
 138
 139     oType.addInitialDesc(pDesc);
 140
 141     pDesc = new SFBool::Description(
 142         SFBool::getClassType(),
 143         "rightBuffer",
 144         "Defines whether the right buffer is written to.\n",
 145         RightBufferFieldId, RightBufferFieldMask,
 146         false,
 147         (Field::SFDefaultFlags | Field::FStdAccess),
 148         static_cast<FieldEditMethodSig>(&StereoBufferViewport::editHandleRightBuffer),
 149         static_cast<FieldGetMethodSig >(&StereoBufferViewport::getHandleRightBuffer));
 150
 151     oType.addInitialDesc(pDesc);
 152 }
 153
 154
 155 StereoBufferViewportBase::TypeObject StereoBufferViewportBase::_type(
 156     StereoBufferViewportBase::getClassname(),
 157     Inherited::getClassname(),
 158     "NULL",
 159     nsOSG, //Namespace
 160     reinterpret_cast<PrototypeCreateF>(&StereoBufferViewportBase::createEmptyLocal),
 161     reinterpret_cast<InitContainerF>(&StereoBufferViewport::initMethod),
 162     reinterpret_cast<ExitContainerF>(&StereoBufferViewport::exitMethod),
 163     reinterpret_cast<InitalInsertDescFunc>(
 164         reinterpret_cast<void *>(&StereoBufferViewport::classDescInserter)),
 165     false,
 166     0,
 167     "<?xml version=\"1.0\"?>\n"
 168     "\n"
 169     "<FieldContainer\n"
 170     "   name=\"StereoBufferViewport\"\n"
 171     "   parent=\"Viewport\"\n"
 172     "   library=\"Window\"\n"
 173     "   pointerfieldtypes=\"both\"\n"
 174     "   structure=\"concrete\"\n"
 175     "   systemcomponent=\"true\"\n"
 176     "   parentsystemcomponent=\"true\"\n"
 177     "   decoratable=\"false\"\n"
 178     "   docGroupBase=\"GrpWindowViewport\"\n"
 179     "   >\n"
 180     "  Viewport for quad-buffered stereo rendering, see \\ref\n"
 181     "  PageSystemWindowViewports for a description.\n"
 182     "\n"
 183     "  The active buffers are selected using the _sfLeftBuffer and _sfRightBuffer\n"
 184     "  Fields.\n"
 185     "  <Field\n"
 186     "\t name=\"leftBuffer\"\n"
 187     "\t type=\"bool\"\n"
 188     "\t cardinality=\"single\"\n"
 189     "\t visibility=\"external\"\n"
 190     "\t defaultValue=\"true\"\n"
 191     "\t access=\"public\"\n"
 192     "\t >\n"
 193     "    Defines whether the left buffer is written to.\n"
 194     "  </Field>\n"
 195     "  <Field\n"
 196     "\t name=\"rightBuffer\"\n"
 197     "\t type=\"bool\"\n"
 198     "\t cardinality=\"single\"\n"
 199     "\t visibility=\"external\"\n"
 200     "\t defaultValue=\"true\"\n"
 201     "\t access=\"public\"\n"
 202     "\t >\n"
 203     "    Defines whether the right buffer is written to.\n"
 204     "  </Field>\n"
 205     "</FieldContainer>\n",
 206     "Viewport for quad-buffered stereo rendering, see \\ref\n"
 207     "PageSystemWindowViewports for a description.\n"
 208     "\n"
 209     "The active buffers are selected using the _sfLeftBuffer and _sfRightBuffer\n"
 210     "Fields.\n"
 211     );
 212
 213 /*------------------------------ get -----------------------------------*/
 214
 215 FieldContainerType &StereoBufferViewportBase::getType(void)
 216 {
 217     return _type;
 218 }
 219
 220 const FieldContainerType &StereoBufferViewportBase::getType(void) const
 221 {
 222     return _type;
 223 }
 224
 225 UInt32 StereoBufferViewportBase::getContainerSize(void) const
 226 {
 227     return sizeof(StereoBufferViewport);
 228 }
 229
 230 /*------------------------- decorator get ------------------------------*/
 231
 232
 233 SFBool *StereoBufferViewportBase::editSFLeftBuffer(void)
 234 {
 235     editSField(LeftBufferFieldMask);
 236
 237     return &_sfLeftBuffer;
 238 }
 239
 240 const SFBool *StereoBufferViewportBase::getSFLeftBuffer(void) const
 241 {
 242     return &_sfLeftBuffer;
 243 }
 244
 245
 246 SFBool *StereoBufferViewportBase::editSFRightBuffer(void)
 247 {
 248     editSField(RightBufferFieldMask);
 249
 250     return &_sfRightBuffer;
 251 }
 252
 253 const SFBool *StereoBufferViewportBase::getSFRightBuffer(void) const
 254 {
 255     return &_sfRightBuffer;
 256 }
 257
 258
 259
 260
 261
 262
 263 /*------------------------------ access -----------------------------------*/
 264
 265 SizeT StereoBufferViewportBase::getBinSize(ConstFieldMaskArg whichField)
 266 {
 267     SizeT returnValue = Inherited::getBinSize(whichField);
 268
 269     if(FieldBits::NoField != (LeftBufferFieldMask & whichField))
 270     {
 271         returnValue += _sfLeftBuffer.getBinSize();
 272     }
 273     if(FieldBits::NoField != (RightBufferFieldMask & whichField))
 274     {
 275         returnValue += _sfRightBuffer.getBinSize();
 276     }
 277
 278     return returnValue;
 279 }
 280
 281 void StereoBufferViewportBase::copyToBin(BinaryDataHandler &pMem,
 282                                   ConstFieldMaskArg  whichField)
 283 {
 284     Inherited::copyToBin(pMem, whichField);
 285
 286     if(FieldBits::NoField != (LeftBufferFieldMask & whichField))
 287     {
 288         _sfLeftBuffer.copyToBin(pMem);
 289     }
 290     if(FieldBits::NoField != (RightBufferFieldMask & whichField))
 291     {
 292         _sfRightBuffer.copyToBin(pMem);
 293     }
 294 }
 295
 296 void StereoBufferViewportBase::copyFromBin(BinaryDataHandler &pMem,
 297                                     ConstFieldMaskArg  whichField)
 298 {
 299     Inherited::copyFromBin(pMem, whichField);
 300
 301     if(FieldBits::NoField != (LeftBufferFieldMask & whichField))
 302     {
 303         editSField(LeftBufferFieldMask);
 304         _sfLeftBuffer.copyFromBin(pMem);
 305     }
 306     if(FieldBits::NoField != (RightBufferFieldMask & whichField))
 307     {
 308         editSField(RightBufferFieldMask);
 309         _sfRightBuffer.copyFromBin(pMem);
 310     }
 311 }
 312
 313 //! create a new instance of the class
 314 StereoBufferViewportTransitPtr StereoBufferViewportBase::createLocal(BitVector bFlags)
 315 {
 316     StereoBufferViewportTransitPtr fc;
 317
 318     if(getClassType().getPrototype() != NULL)
 319     {
 320         FieldContainerTransitPtr tmpPtr =
 321             getClassType().getPrototype()-> shallowCopyLocal(bFlags);
 322
 323         fc = dynamic_pointer_cast<StereoBufferViewport>(tmpPtr);
 324     }
 325
 326     return fc;
 327 }
 328
 329 //! create a new instance of the class, copy the container flags
 330 StereoBufferViewportTransitPtr StereoBufferViewportBase::createDependent(BitVector bFlags)
 331 {
 332     StereoBufferViewportTransitPtr fc;
 333
 334     if(getClassType().getPrototype() != NULL)
 335     {
 336         FieldContainerTransitPtr tmpPtr =
 337             getClassType().getPrototype()-> shallowCopyDependent(bFlags);
 338
 339         fc = dynamic_pointer_cast<StereoBufferViewport>(tmpPtr);
 340     }
 341
 342     return fc;
 343 }
 344
 345 //! create a new instance of the class
 346 StereoBufferViewportTransitPtr StereoBufferViewportBase::create(void)
 347 {
 348     StereoBufferViewportTransitPtr fc;
 349
 350     if(getClassType().getPrototype() != NULL)
 351     {
 352         FieldContainerTransitPtr tmpPtr =
 353             getClassType().getPrototype()-> shallowCopy();
 354
 355         fc = dynamic_pointer_cast<StereoBufferViewport>(tmpPtr);
 356     }
 357
 358     return fc;
 359 }
 360
 361 StereoBufferViewport *StereoBufferViewportBase::createEmptyLocal(BitVector bFlags)
 362 {
 363     StereoBufferViewport *returnValue;
 364
 365     newPtr<StereoBufferViewport>(returnValue, bFlags);
 366
 367     returnValue->_pFieldFlags->_bNamespaceMask &= ~bFlags;
 368
 369     return returnValue;
 370 }
 371
 372 //! create an empty new instance of the class, do not copy the prototype
 373 StereoBufferViewport *StereoBufferViewportBase::createEmpty(void)
 374 {
 375     StereoBufferViewport *returnValue;
 376
 377     newPtr<StereoBufferViewport>(returnValue, Thread::getCurrentLocalFlags());
 378
 379     returnValue->_pFieldFlags->_bNamespaceMask &=
 380         ~Thread::getCurrentLocalFlags();
 381
 382     return returnValue;
 383 }
 384
 385
 386 FieldContainerTransitPtr StereoBufferViewportBase::shallowCopyLocal(
 387     BitVector bFlags) const
 388 {
 389     StereoBufferViewport *tmpPtr;
 390
 391     newPtr(tmpPtr, dynamic_cast<const StereoBufferViewport *>(this), bFlags);
 392
 393     FieldContainerTransitPtr returnValue(tmpPtr);
 394
 395     tmpPtr->_pFieldFlags->_bNamespaceMask &= ~bFlags;
 396
 397     return returnValue;
 398 }
 399
 400 FieldContainerTransitPtr StereoBufferViewportBase::shallowCopyDependent(
 401     BitVector bFlags) const
 402 {
 403     StereoBufferViewport *tmpPtr;
 404
 405     newPtr(tmpPtr, dynamic_cast<const StereoBufferViewport *>(this), ~bFlags);
 406
 407     FieldContainerTransitPtr returnValue(tmpPtr);
 408
 409     tmpPtr->_pFieldFlags->_bNamespaceMask = bFlags;
 410
 411     return returnValue;
 412 }
 413
 414 FieldContainerTransitPtr StereoBufferViewportBase::shallowCopy(void) const
 415 {
 416     StereoBufferViewport *tmpPtr;
 417
 418     newPtr(tmpPtr,
 419            dynamic_cast<const StereoBufferViewport *>(this),
 420            Thread::getCurrentLocalFlags());
 421
 422     tmpPtr->_pFieldFlags->_bNamespaceMask &= ~Thread::getCurrentLocalFlags();
 423
 424     FieldContainerTransitPtr returnValue(tmpPtr);
 425
 426     return returnValue;
 427 }
 428
 429
 430
 431
 432 /*------------------------- constructors ----------------------------------*/
 433
 434 StereoBufferViewportBase::StereoBufferViewportBase(void) :
 435     Inherited(),
 436     _sfLeftBuffer             (bool(true)),
 437     _sfRightBuffer            (bool(true))
 438 {
 439 }
 440
 441 StereoBufferViewportBase::StereoBufferViewportBase(const StereoBufferViewportBase &source) :
 442     Inherited(source),
 443     _sfLeftBuffer             (source._sfLeftBuffer             ),
 444     _sfRightBuffer            (source._sfRightBuffer            )
 445 {
 446 }
 447
 448
 449 /*-------------------------- destructors ----------------------------------*/
 450
 451 StereoBufferViewportBase::~StereoBufferViewportBase(void)
 452 {
 453 }
 454
 455
 456 GetFieldHandlePtr StereoBufferViewportBase::getHandleLeftBuffer      (void) const
 457 {
 458     SFBool::GetHandlePtr returnValue(
 459         new  SFBool::GetHandle(
 460              &_sfLeftBuffer,
 461              this->getType().getFieldDesc(LeftBufferFieldId),
 462              const_cast<StereoBufferViewportBase *>(this)));
 463
 464     return returnValue;
 465 }
 466
 467 EditFieldHandlePtr StereoBufferViewportBase::editHandleLeftBuffer     (void)
 468 {
 469     SFBool::EditHandlePtr returnValue(
 470         new  SFBool::EditHandle(
 471              &_sfLeftBuffer,
 472              this->getType().getFieldDesc(LeftBufferFieldId),
 473              this));
 474
 475
 476     editSField(LeftBufferFieldMask);
 477
 478     return returnValue;
 479 }
 480
 481 GetFieldHandlePtr StereoBufferViewportBase::getHandleRightBuffer     (void) const
 482 {
 483     SFBool::GetHandlePtr returnValue(
 484         new  SFBool::GetHandle(
 485              &_sfRightBuffer,
 486              this->getType().getFieldDesc(RightBufferFieldId),
 487              const_cast<StereoBufferViewportBase *>(this)));
 488
 489     return returnValue;
 490 }
 491
 492 EditFieldHandlePtr StereoBufferViewportBase::editHandleRightBuffer    (void)
 493 {
 494     SFBool::EditHandlePtr returnValue(
 495         new  SFBool::EditHandle(
 496              &_sfRightBuffer,
 497              this->getType().getFieldDesc(RightBufferFieldId),
 498              this));
 499
 500
 501     editSField(RightBufferFieldMask);
 502
 503     return returnValue;
 504 }
 505
 506
 507 #ifdef OSG_MT_CPTR_ASPECT
 508 void StereoBufferViewportBase::execSyncV(      FieldContainer    &oFrom,
 509                                         ConstFieldMaskArg  whichField,
 510                                         AspectOffsetStore &oOffsets,
 511                                         ConstFieldMaskArg  syncMode,
 512                                   const UInt32             uiSyncInfo)
 513 {
 514     StereoBufferViewport *pThis = static_cast<StereoBufferViewport *>(this);
 515
 516     pThis->execSync(static_cast<StereoBufferViewport *>(&oFrom),
 517                     whichField,
 518                     oOffsets,
 519                     syncMode,
 520                     uiSyncInfo);
 521 }
 522 #endif
 523
 524
 525 #ifdef OSG_MT_CPTR_ASPECT
 526 FieldContainer *StereoBufferViewportBase::createAspectCopy(
 527     const FieldContainer *pRefAspect) const
 528 {
 529     StereoBufferViewport *returnValue;
 530
 531     newAspectCopy(returnValue,
 532                   dynamic_cast<const StereoBufferViewport *>(pRefAspect),
 533                   dynamic_cast<const StereoBufferViewport *>(this));
 534
 535     return returnValue;
 536 }
 537 #endif
 538
 539 void StereoBufferViewportBase::resolveLinks(void)
 540 {
 541     Inherited::resolveLinks();
 542
 543
 544 }
 545
 546
 547 OSG_END_NAMESPACE