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