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