Source/System/Window/Base/OSGStereoCameraDecoratorBase.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 StereoCameraDecorator!
  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 "OSGStereoCameraDecoratorBase.h"
  67 #include "OSGStereoCameraDecorator.h"
  68
  69 #include <boost/bind.hpp>
  70
  71 OSG_BEGIN_NAMESPACE
  72
  73 /***************************************************************************\
  74  *                            Description                                  *
  75 \***************************************************************************/
  76
  77 /*! \class OSG::StereoCameraDecorator
  78     The abstract base class for stereo camera decorators, see \ref
  79     PageSystemWindowCameraDecoratorsStereo for a description.
  80
  81     The basic parameters are given by the _sfEyeSeparation and _sfLeftEye fields.
  82  */
  83
  84 /***************************************************************************\
  85  *                        Field Documentation                              *
  86 \***************************************************************************/
  87
  88 /*! \var bool            StereoCameraDecoratorBase::_sfLeftEye
  89     Flag to distinguish between left and right eye views.
  90 */
  91
  92 /*! \var Real32          StereoCameraDecoratorBase::_sfEyeSeparation
  93     The distance between the two eyes.
  94 */
  95
  96
  97 /***************************************************************************\
  98  *                      FieldType/FieldTrait Instantiation                 *
  99 \***************************************************************************/
 100
 101 #if !defined(OSG_DO_DOC) || defined(OSG_DOC_DEV)
 102 PointerType FieldTraits<StereoCameraDecorator *, nsOSG>::_type(
 103     "StereoCameraDecoratorPtr",
 104     "CameraDecoratorPtr",
 105     StereoCameraDecorator::getClassType(),
 106     nsOSG);
 107 #endif
 108
 109 OSG_FIELDTRAITS_GETTYPE_NS(StereoCameraDecorator *, nsOSG)
 110
 111 OSG_EXPORT_PTR_SFIELD_FULL(PointerSField,
 112                            StereoCameraDecorator *,
 113                            nsOSG)
 114
 115 OSG_EXPORT_PTR_MFIELD_FULL(PointerMField,
 116                            StereoCameraDecorator *,
 117                            nsOSG)
 118
 119 /***************************************************************************\
 120  *                         Field Description                               *
 121 \***************************************************************************/
 122
 123 void StereoCameraDecoratorBase::classDescInserter(TypeObject &oType)
 124 {
 125     FieldDescriptionBase *pDesc = NULL;
 126
 127
 128     pDesc = new SFBool::Description(
 129         SFBool::getClassType(),
 130         "leftEye",
 131         "Flag to distinguish between left and right eye views.\n",
 132         LeftEyeFieldId, LeftEyeFieldMask,
 133         false,
 134         (Field::SFDefaultFlags | Field::FStdAccess),
 135         static_cast<FieldEditMethodSig>(&StereoCameraDecorator::editHandleLeftEye),
 136         static_cast<FieldGetMethodSig >(&StereoCameraDecorator::getHandleLeftEye));
 137
 138     oType.addInitialDesc(pDesc);
 139
 140     pDesc = new SFReal32::Description(
 141         SFReal32::getClassType(),
 142         "eyeSeparation",
 143         "The distance between the two eyes.\n",
 144         EyeSeparationFieldId, EyeSeparationFieldMask,
 145         false,
 146         (Field::SFDefaultFlags | Field::FStdAccess),
 147         static_cast<FieldEditMethodSig>(&StereoCameraDecorator::editHandleEyeSeparation),
 148         static_cast<FieldGetMethodSig >(&StereoCameraDecorator::getHandleEyeSeparation));
 149
 150     oType.addInitialDesc(pDesc);
 151 }
 152
 153
 154 StereoCameraDecoratorBase::TypeObject StereoCameraDecoratorBase::_type(
 155     StereoCameraDecoratorBase::getClassname(),
 156     Inherited::getClassname(),
 157     "NULL",
 158     nsOSG, //Namespace
 159     NULL,
 160     reinterpret_cast<InitContainerF>(&StereoCameraDecorator::initMethod),
 161     reinterpret_cast<ExitContainerF>(&StereoCameraDecorator::exitMethod),
 162     reinterpret_cast<InitalInsertDescFunc>(
 163         reinterpret_cast<void *>(&StereoCameraDecorator::classDescInserter)),
 164     false,
 165     0,
 166     "<?xml version=\"1.0\"?>\n"
 167     "\n"
 168     "<FieldContainer\n"
 169     "   name=\"StereoCameraDecorator\"\n"
 170     "   parent=\"CameraDecorator\"\n"
 171     "   library=\"System\"\n"
 172     "   pointerfieldtypes=\"both\"\n"
 173     "   structure=\"abstract\"\n"
 174     "   systemcomponent=\"true\"\n"
 175     "   parentsystemcomponent=\"true\"\n"
 176     "   decoratable=\"false\"\n"
 177     "   docGroupBase=\"GrpSystemWindow\"\n"
 178     "   >\n"
 179     "\n"
 180     "The abstract base class for stereo camera decorators, see \\ref\n"
 181     "PageSystemWindowCameraDecoratorsStereo for a description.\n"
 182     "\n"
 183     "The basic parameters are given by the _sfEyeSeparation and _sfLeftEye fields.\n"
 184     "\t<Field\n"
 185     "\t\tname=\"leftEye\"\n"
 186     "\t\ttype=\"bool\"\n"
 187     "\t\tcardinality=\"single\"\n"
 188     "\t\tvisibility=\"external\"\n"
 189     "\t\taccess=\"public\"\n"
 190     "\t>\n"
 191     "\tFlag to distinguish between left and right eye views.\n"
 192     "\t</Field>\n"
 193     "\t<Field\n"
 194     "\t\tname=\"eyeSeparation\"\n"
 195     "\t\ttype=\"Real32\"\n"
 196     "\t\tcardinality=\"single\"\n"
 197     "\t\tvisibility=\"external\"\n"
 198     "\t\taccess=\"public\"\n"
 199     "\t>\n"
 200     "\tThe distance between the two eyes.\n"
 201     "\t</Field>\n"
 202     "</FieldContainer>\n",
 203     "The abstract base class for stereo camera decorators, see \\ref\n"
 204     "PageSystemWindowCameraDecoratorsStereo for a description.\n"
 205     "\n"
 206     "The basic parameters are given by the _sfEyeSeparation and _sfLeftEye fields.\n"
 207     );
 208
 209 /*------------------------------ get -----------------------------------*/
 210
 211 FieldContainerType &StereoCameraDecoratorBase::getType(void)
 212 {
 213     return _type;
 214 }
 215
 216 const FieldContainerType &StereoCameraDecoratorBase::getType(void) const
 217 {
 218     return _type;
 219 }
 220
 221 UInt32 StereoCameraDecoratorBase::getContainerSize(void) const
 222 {
 223     return sizeof(StereoCameraDecorator);
 224 }
 225
 226 /*------------------------- decorator get ------------------------------*/
 227
 228
 229 SFBool *StereoCameraDecoratorBase::editSFLeftEye(void)
 230 {
 231     editSField(LeftEyeFieldMask);
 232
 233     return &_sfLeftEye;
 234 }
 235
 236 const SFBool *StereoCameraDecoratorBase::getSFLeftEye(void) const
 237 {
 238     return &_sfLeftEye;
 239 }
 240
 241
 242 SFReal32 *StereoCameraDecoratorBase::editSFEyeSeparation(void)
 243 {
 244     editSField(EyeSeparationFieldMask);
 245
 246     return &_sfEyeSeparation;
 247 }
 248
 249 const SFReal32 *StereoCameraDecoratorBase::getSFEyeSeparation(void) const
 250 {
 251     return &_sfEyeSeparation;
 252 }
 253
 254
 255
 256
 257
 258
 259 /*------------------------------ access -----------------------------------*/
 260
 261 SizeT StereoCameraDecoratorBase::getBinSize(ConstFieldMaskArg whichField)
 262 {
 263     SizeT returnValue = Inherited::getBinSize(whichField);
 264
 265     if(FieldBits::NoField != (LeftEyeFieldMask & whichField))
 266     {
 267         returnValue += _sfLeftEye.getBinSize();
 268     }
 269     if(FieldBits::NoField != (EyeSeparationFieldMask & whichField))
 270     {
 271         returnValue += _sfEyeSeparation.getBinSize();
 272     }
 273
 274     return returnValue;
 275 }
 276
 277 void StereoCameraDecoratorBase::copyToBin(BinaryDataHandler &pMem,
 278                                   ConstFieldMaskArg  whichField)
 279 {
 280     Inherited::copyToBin(pMem, whichField);
 281
 282     if(FieldBits::NoField != (LeftEyeFieldMask & whichField))
 283     {
 284         _sfLeftEye.copyToBin(pMem);
 285     }
 286     if(FieldBits::NoField != (EyeSeparationFieldMask & whichField))
 287     {
 288         _sfEyeSeparation.copyToBin(pMem);
 289     }
 290 }
 291
 292 void StereoCameraDecoratorBase::copyFromBin(BinaryDataHandler &pMem,
 293                                     ConstFieldMaskArg  whichField)
 294 {
 295     Inherited::copyFromBin(pMem, whichField);
 296
 297     if(FieldBits::NoField != (LeftEyeFieldMask & whichField))
 298     {
 299         editSField(LeftEyeFieldMask);
 300         _sfLeftEye.copyFromBin(pMem);
 301     }
 302     if(FieldBits::NoField != (EyeSeparationFieldMask & whichField))
 303     {
 304         editSField(EyeSeparationFieldMask);
 305         _sfEyeSeparation.copyFromBin(pMem);
 306     }
 307 }
 308
 309
 310
 311
 312 /*------------------------- constructors ----------------------------------*/
 313
 314 StereoCameraDecoratorBase::StereoCameraDecoratorBase(void) :
 315     Inherited(),
 316     _sfLeftEye                (),
 317     _sfEyeSeparation          ()
 318 {
 319 }
 320
 321 StereoCameraDecoratorBase::StereoCameraDecoratorBase(const StereoCameraDecoratorBase &source) :
 322     Inherited(source),
 323     _sfLeftEye                (source._sfLeftEye                ),
 324     _sfEyeSeparation          (source._sfEyeSeparation          )
 325 {
 326 }
 327
 328
 329 /*-------------------------- destructors ----------------------------------*/
 330
 331 StereoCameraDecoratorBase::~StereoCameraDecoratorBase(void)
 332 {
 333 }
 334
 335
 336 GetFieldHandlePtr StereoCameraDecoratorBase::getHandleLeftEye         (void) const
 337 {
 338     SFBool::GetHandlePtr returnValue(
 339         new  SFBool::GetHandle(
 340              &_sfLeftEye,
 341              this->getType().getFieldDesc(LeftEyeFieldId),
 342              const_cast<StereoCameraDecoratorBase *>(this)));
 343
 344     return returnValue;
 345 }
 346
 347 EditFieldHandlePtr StereoCameraDecoratorBase::editHandleLeftEye        (void)
 348 {
 349     SFBool::EditHandlePtr returnValue(
 350         new  SFBool::EditHandle(
 351              &_sfLeftEye,
 352              this->getType().getFieldDesc(LeftEyeFieldId),
 353              this));
 354
 355
 356     editSField(LeftEyeFieldMask);
 357
 358     return returnValue;
 359 }
 360
 361 GetFieldHandlePtr StereoCameraDecoratorBase::getHandleEyeSeparation   (void) const
 362 {
 363     SFReal32::GetHandlePtr returnValue(
 364         new  SFReal32::GetHandle(
 365              &_sfEyeSeparation,
 366              this->getType().getFieldDesc(EyeSeparationFieldId),
 367              const_cast<StereoCameraDecoratorBase *>(this)));
 368
 369     return returnValue;
 370 }
 371
 372 EditFieldHandlePtr StereoCameraDecoratorBase::editHandleEyeSeparation  (void)
 373 {
 374     SFReal32::EditHandlePtr returnValue(
 375         new  SFReal32::EditHandle(
 376              &_sfEyeSeparation,
 377              this->getType().getFieldDesc(EyeSeparationFieldId),
 378              this));
 379
 380
 381     editSField(EyeSeparationFieldMask);
 382
 383     return returnValue;
 384 }
 385
 386
 387 #ifdef OSG_MT_CPTR_ASPECT
 388 void StereoCameraDecoratorBase::execSyncV(      FieldContainer    &oFrom,
 389                                         ConstFieldMaskArg  whichField,
 390                                         AspectOffsetStore &oOffsets,
 391                                         ConstFieldMaskArg  syncMode,
 392                                   const UInt32             uiSyncInfo)
 393 {
 394     StereoCameraDecorator *pThis = static_cast<StereoCameraDecorator *>(this);
 395
 396     pThis->execSync(static_cast<StereoCameraDecorator *>(&oFrom),
 397                     whichField,
 398                     oOffsets,
 399                     syncMode,
 400                     uiSyncInfo);
 401 }
 402 #endif
 403
 404
 405
 406 void StereoCameraDecoratorBase::resolveLinks(void)
 407 {
 408     Inherited::resolveLinks();
 409
 410
 411 }
 412
 413
 414 OSG_END_NAMESPACE