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