Source/System/Window/Base/OSGCameraBase.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 Camera!
  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"                    // Beacon Class
  66
  67 #include "OSGCameraBase.h"
  68 #include "OSGCamera.h"
  69
  70 #include <boost/bind.hpp>
  71
  72 OSG_BEGIN_NAMESPACE
  73
  74 /***************************************************************************\
  75  *                            Description                                  *
  76 \***************************************************************************/
  77
  78 /*! \class OSG::Camera
  79     The Camera base class, see \ref PageSystemWindowCamera for a description.
  80
  81     The only common fields are _sfNear and _sfFar.
  82  */
  83
  84 /***************************************************************************\
  85  *                        Field Documentation                              *
  86 \***************************************************************************/
  87
  88 /*! \var Node *          CameraBase::_sfBeacon
  89     The object that define's the camera's coordinate system. The camera is
  90     positioned at the origin of the system and looks down the negative z-axis
  91     (OpenGL-style).
  92 */
  93
  94 /*! \var Real32          CameraBase::_sfNear
  95     The near distance of the camera.
  96 */
  97
  98 /*! \var Real32          CameraBase::_sfFar
  99     The far distance of the camera.
 100 */
 101
 102
 103 /***************************************************************************\
 104  *                      FieldType/FieldTrait Instantiation                 *
 105 \***************************************************************************/
 106
 107 #if !defined(OSG_DO_DOC) || defined(OSG_DOC_DEV)
 108 PointerType FieldTraits<Camera *, nsOSG>::_type(
 109     "CameraPtr",
 110     "AttachmentContainerPtr",
 111     Camera::getClassType(),
 112     nsOSG);
 113 #endif
 114
 115 OSG_FIELDTRAITS_GETTYPE_NS(Camera *, nsOSG)
 116
 117 OSG_EXPORT_PTR_SFIELD_FULL(PointerSField,
 118                            Camera *,
 119                            nsOSG)
 120
 121 OSG_EXPORT_PTR_MFIELD_FULL(PointerMField,
 122                            Camera *,
 123                            nsOSG)
 124
 125 /***************************************************************************\
 126  *                         Field Description                               *
 127 \***************************************************************************/
 128
 129 void CameraBase::classDescInserter(TypeObject &oType)
 130 {
 131     FieldDescriptionBase *pDesc = NULL;
 132
 133
 134     pDesc = new SFWeakNodePtr::Description(
 135         SFWeakNodePtr::getClassType(),
 136         "beacon",
 137         "The object that define's the camera's coordinate system. The camera is\n"
 138         "positioned at the origin of the system and looks down the negative z-axis\n"
 139         "(OpenGL-style). \n",
 140         BeaconFieldId, BeaconFieldMask,
 141         false,
 142         (Field::SFDefaultFlags | Field::FStdAccess),
 143         static_cast<FieldEditMethodSig>(&Camera::editHandleBeacon),
 144         static_cast<FieldGetMethodSig >(&Camera::getHandleBeacon));
 145
 146     oType.addInitialDesc(pDesc);
 147
 148     pDesc = new SFReal32::Description(
 149         SFReal32::getClassType(),
 150         "near",
 151         "The near distance of the camera.\n",
 152         NearFieldId, NearFieldMask,
 153         false,
 154         (Field::SFDefaultFlags | Field::FStdAccess),
 155         static_cast<FieldEditMethodSig>(&Camera::editHandleNear),
 156         static_cast<FieldGetMethodSig >(&Camera::getHandleNear));
 157
 158     oType.addInitialDesc(pDesc);
 159
 160     pDesc = new SFReal32::Description(
 161         SFReal32::getClassType(),
 162         "far",
 163         "The far distance of the camera.\n",
 164         FarFieldId, FarFieldMask,
 165         false,
 166         (Field::SFDefaultFlags | Field::FStdAccess),
 167         static_cast<FieldEditMethodSig>(&Camera::editHandleFar),
 168         static_cast<FieldGetMethodSig >(&Camera::getHandleFar));
 169
 170     oType.addInitialDesc(pDesc);
 171 }
 172
 173
 174 CameraBase::TypeObject CameraBase::_type(
 175     CameraBase::getClassname(),
 176     Inherited::getClassname(),
 177     "NULL",
 178     nsOSG, //Namespace
 179     NULL,
 180     reinterpret_cast<InitContainerF>(&Camera::initMethod),
 181     reinterpret_cast<ExitContainerF>(&Camera::exitMethod),
 182     reinterpret_cast<InitalInsertDescFunc>(
 183         reinterpret_cast<void *>(&Camera::classDescInserter)),
 184     false,
 185     0,
 186     "<?xml version=\"1.0\" ?>\n"
 187     "\n"
 188     "<FieldContainer\n"
 189     "   name=\"Camera\"\n"
 190     "   parent=\"AttachmentContainer\"\n"
 191     "   library=\"System\"\n"
 192     "   structure=\"abstract\"\n"
 193     "   pointerfieldtypes=\"both\"\n"
 194     "   systemcomponent=\"true\"\n"
 195     "   parentsystemcomponent=\"true\"\n"
 196     "   decoratable=\"true\"\n"
 197     "   decorateeFieldFlags=\"SFDefaultFlags | Field::FStdAccess\"\n"
 198     "   docGroupBase=\"GrpSystemWindow\"\n"
 199     "   >\n"
 200     "\n"
 201     "  The Camera base class, see \\ref PageSystemWindowCamera for a description.\n"
 202     "\n"
 203     "  The only common fields are _sfNear and _sfFar.\n"
 204     "\n"
 205     "  <Field\n"
 206     "\t name=\"beacon\"\n"
 207     "\t type=\"Node\"\n"
 208     "     category=\"weakpointer\"\n"
 209     "\t cardinality=\"single\"\n"
 210     "\t visibility=\"external\"\n"
 211     "\t >\n"
 212     "\tThe object that define's the camera's coordinate system. The camera is\n"
 213     "\t positioned at the origin of the system and looks down the negative z-axis\n"
 214     "\t (OpenGL-style). \n"
 215     "  </Field>\n"
 216     "  <Field\n"
 217     "\t name=\"near\"\n"
 218     "\t type=\"Real32\"\n"
 219     "\t cardinality=\"single\"\n"
 220     "\t visibility=\"external\"\n"
 221     "\t >\n"
 222     "\tThe near distance of the camera.\n"
 223     "  </Field>\n"
 224     "  <Field\n"
 225     "\t name=\"far\"\n"
 226     "\t type=\"Real32\"\n"
 227     "\t cardinality=\"single\"\n"
 228     "\t visibility=\"external\"\n"
 229     "\t >\n"
 230     "\tThe far distance of the camera.\n"
 231     "  </Field>\n"
 232     "</FieldContainer>\n",
 233     "The Camera base class, see \\ref PageSystemWindowCamera for a description.\n"
 234     "\n"
 235     "The only common fields are _sfNear and _sfFar.\n"
 236     );
 237
 238 /*------------------------------ get -----------------------------------*/
 239
 240 FieldContainerType &CameraBase::getType(void)
 241 {
 242     return _type;
 243 }
 244
 245 const FieldContainerType &CameraBase::getType(void) const
 246 {
 247     return _type;
 248 }
 249
 250 UInt32 CameraBase::getContainerSize(void) const
 251 {
 252     return sizeof(Camera);
 253 }
 254
 255 /*------------------------- decorator get ------------------------------*/
 256
 257
 258 //! Get the Camera::_sfBeacon field.
 259 const SFWeakNodePtr *CameraBase::getSFBeacon(void) const
 260 {
 261     return &_sfBeacon;
 262 }
 263
 264 SFWeakNodePtr       *CameraBase::editSFBeacon         (void)
 265 {
 266     editSField(BeaconFieldMask);
 267
 268     return &_sfBeacon;
 269 }
 270
 271
 272
 273 SFReal32 *CameraBase::editSFNear(void)
 274 {
 275     editSField(NearFieldMask);
 276
 277     return &_sfNear;
 278 }
 279
 280 const SFReal32 *CameraBase::getSFNear(void) const
 281 {
 282     return &_sfNear;
 283 }
 284
 285
 286 SFReal32 *CameraBase::editSFFar(void)
 287 {
 288     editSField(FarFieldMask);
 289
 290     return &_sfFar;
 291 }
 292
 293 const SFReal32 *CameraBase::getSFFar(void) const
 294 {
 295     return &_sfFar;
 296 }
 297
 298
 299
 300
 301
 302
 303 /*------------------------------ access -----------------------------------*/
 304
 305 SizeT CameraBase::getBinSize(ConstFieldMaskArg whichField)
 306 {
 307     SizeT returnValue = Inherited::getBinSize(whichField);
 308
 309     if(FieldBits::NoField != (BeaconFieldMask & whichField))
 310     {
 311         returnValue += _sfBeacon.getBinSize();
 312     }
 313     if(FieldBits::NoField != (NearFieldMask & whichField))
 314     {
 315         returnValue += _sfNear.getBinSize();
 316     }
 317     if(FieldBits::NoField != (FarFieldMask & whichField))
 318     {
 319         returnValue += _sfFar.getBinSize();
 320     }
 321
 322     return returnValue;
 323 }
 324
 325 void CameraBase::copyToBin(BinaryDataHandler &pMem,
 326                                   ConstFieldMaskArg  whichField)
 327 {
 328     Inherited::copyToBin(pMem, whichField);
 329
 330     if(FieldBits::NoField != (BeaconFieldMask & whichField))
 331     {
 332         _sfBeacon.copyToBin(pMem);
 333     }
 334     if(FieldBits::NoField != (NearFieldMask & whichField))
 335     {
 336         _sfNear.copyToBin(pMem);
 337     }
 338     if(FieldBits::NoField != (FarFieldMask & whichField))
 339     {
 340         _sfFar.copyToBin(pMem);
 341     }
 342 }
 343
 344 void CameraBase::copyFromBin(BinaryDataHandler &pMem,
 345                                     ConstFieldMaskArg  whichField)
 346 {
 347     Inherited::copyFromBin(pMem, whichField);
 348
 349     if(FieldBits::NoField != (BeaconFieldMask & whichField))
 350     {
 351         editSField(BeaconFieldMask);
 352         _sfBeacon.copyFromBin(pMem);
 353     }
 354     if(FieldBits::NoField != (NearFieldMask & whichField))
 355     {
 356         editSField(NearFieldMask);
 357         _sfNear.copyFromBin(pMem);
 358     }
 359     if(FieldBits::NoField != (FarFieldMask & whichField))
 360     {
 361         editSField(FarFieldMask);
 362         _sfFar.copyFromBin(pMem);
 363     }
 364 }
 365
 366
 367
 368
 369 /*------------------------- constructors ----------------------------------*/
 370
 371 CameraBase::CameraBase(void) :
 372     Inherited(),
 373     _sfBeacon                 (NULL),
 374     _sfNear                   (),
 375     _sfFar                    ()
 376 {
 377 }
 378
 379 CameraBase::CameraBase(const CameraBase &source) :
 380     Inherited(source),
 381     _sfBeacon                 (NULL),
 382     _sfNear                   (source._sfNear                   ),
 383     _sfFar                    (source._sfFar                    )
 384 {
 385 }
 386
 387
 388 /*-------------------------- destructors ----------------------------------*/
 389
 390 CameraBase::~CameraBase(void)
 391 {
 392 }
 393
 394 void CameraBase::onCreate(const Camera *source)
 395 {
 396     Inherited::onCreate(source);
 397
 398     if(source != NULL)
 399     {
 400         Camera *pThis = static_cast<Camera *>(this);
 401
 402         pThis->setBeacon(source->getBeacon());
 403     }
 404 }
 405
 406 GetFieldHandlePtr CameraBase::getHandleBeacon          (void) const
 407 {
 408     SFWeakNodePtr::GetHandlePtr returnValue(
 409         new  SFWeakNodePtr::GetHandle(
 410              &_sfBeacon,
 411              this->getType().getFieldDesc(BeaconFieldId),
 412              const_cast<CameraBase *>(this)));
 413
 414     return returnValue;
 415 }
 416
 417 EditFieldHandlePtr CameraBase::editHandleBeacon         (void)
 418 {
 419     SFWeakNodePtr::EditHandlePtr returnValue(
 420         new  SFWeakNodePtr::EditHandle(
 421              &_sfBeacon,
 422              this->getType().getFieldDesc(BeaconFieldId),
 423              this));
 424
 425     returnValue->setSetMethod(
 426         boost::bind(&Camera::setBeacon,
 427                     static_cast<Camera *>(this), _1));
 428
 429     editSField(BeaconFieldMask);
 430
 431     return returnValue;
 432 }
 433
 434 GetFieldHandlePtr CameraBase::getHandleNear            (void) const
 435 {
 436     SFReal32::GetHandlePtr returnValue(
 437         new  SFReal32::GetHandle(
 438              &_sfNear,
 439              this->getType().getFieldDesc(NearFieldId),
 440              const_cast<CameraBase *>(this)));
 441
 442     return returnValue;
 443 }
 444
 445 EditFieldHandlePtr CameraBase::editHandleNear           (void)
 446 {
 447     SFReal32::EditHandlePtr returnValue(
 448         new  SFReal32::EditHandle(
 449              &_sfNear,
 450              this->getType().getFieldDesc(NearFieldId),
 451              this));
 452
 453
 454     editSField(NearFieldMask);
 455
 456     return returnValue;
 457 }
 458
 459 GetFieldHandlePtr CameraBase::getHandleFar             (void) const
 460 {
 461     SFReal32::GetHandlePtr returnValue(
 462         new  SFReal32::GetHandle(
 463              &_sfFar,
 464              this->getType().getFieldDesc(FarFieldId),
 465              const_cast<CameraBase *>(this)));
 466
 467     return returnValue;
 468 }
 469
 470 EditFieldHandlePtr CameraBase::editHandleFar            (void)
 471 {
 472     SFReal32::EditHandlePtr returnValue(
 473         new  SFReal32::EditHandle(
 474              &_sfFar,
 475              this->getType().getFieldDesc(FarFieldId),
 476              this));
 477
 478
 479     editSField(FarFieldMask);
 480
 481     return returnValue;
 482 }
 483
 484
 485 #ifdef OSG_MT_CPTR_ASPECT
 486 void CameraBase::execSyncV(      FieldContainer    &oFrom,
 487                                         ConstFieldMaskArg  whichField,
 488                                         AspectOffsetStore &oOffsets,
 489                                         ConstFieldMaskArg  syncMode,
 490                                   const UInt32             uiSyncInfo)
 491 {
 492     Camera *pThis = static_cast<Camera *>(this);
 493
 494     pThis->execSync(static_cast<Camera *>(&oFrom),
 495                     whichField,
 496                     oOffsets,
 497                     syncMode,
 498                     uiSyncInfo);
 499 }
 500 #endif
 501
 502
 503
 504 void CameraBase::resolveLinks(void)
 505 {
 506     Inherited::resolveLinks();
 507
 508     static_cast<Camera *>(this)->setBeacon(NULL);
 509
 510
 511 }
 512
 513 /*------------------------------ get -----------------------------------*/
 514
 515
 516 //! Get the value of the Camera::_sfBeacon field.
 517 Node * CameraBase::getBeacon(void) const
 518 {
 519     return _sfBeacon.getValue();
 520 }
 521
 522 //! Set the value of the Camera::_sfBeacon field.
 523 void CameraBase::setBeacon(Node * const value)
 524 {
 525     editSField(BeaconFieldMask);
 526
 527     _sfBeacon.setValue(value);
 528 }
 529 //! Get the value of the Camera::_sfNear field.
 530
 531 Real32 &CameraBase::editNear(void)
 532 {
 533     editSField(NearFieldMask);
 534
 535     return _sfNear.getValue();
 536 }
 537
 538 //! Get the value of the Camera::_sfNear field.
 539       Real32  CameraBase::getNear(void) const
 540 {
 541     return _sfNear.getValue();
 542 }
 543
 544
 545 //! Set the value of the Camera::_sfNear field.
 546 void CameraBase::setNear(const Real32 value)
 547 {
 548     editSField(NearFieldMask);
 549
 550     _sfNear.setValue(value);
 551 }
 552 //! Get the value of the Camera::_sfFar field.
 553
 554 Real32 &CameraBase::editFar(void)
 555 {
 556     editSField(FarFieldMask);
 557
 558     return _sfFar.getValue();
 559 }
 560
 561 //! Get the value of the Camera::_sfFar field.
 562       Real32  CameraBase::getFar(void) const
 563 {
 564     return _sfFar.getValue();
 565 }
 566
 567
 568 //! Set the value of the Camera::_sfFar field.
 569 void CameraBase::setFar(const Real32 value)
 570 {
 571     editSField(FarFieldMask);
 572
 573     _sfFar.setValue(value);
 574 }
 575
 576
 577 OSG_END_NAMESPACE