Source/System/Window/Background/OSGFBOBackgroundBase.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 FBOBackground!
  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 "OSGFrameBufferObject.h"       // FrameBufferObject Class
  66
  67 #include "OSGFBOBackgroundBase.h"
  68 #include "OSGFBOBackground.h"
  69
  70 #include <boost/bind.hpp>
  71
  72 OSG_BEGIN_NAMESPACE
  73
  74 /***************************************************************************\
  75  *                            Description                                  *
  76 \***************************************************************************/
  77
  78 /*! \class OSG::FBOBackground
  79
  80  */
  81
  82 /***************************************************************************\
  83  *                        Field Documentation                              *
  84 \***************************************************************************/
  85
  86 /*! \var FrameBufferObject * FBOBackgroundBase::_sfFrameBufferObject
  87     The FramebufferObject to clear from.
  88 */
  89
  90
  91 /***************************************************************************\
  92  *                      FieldType/FieldTrait Instantiation                 *
  93 \***************************************************************************/
  94
  95 #if !defined(OSG_DO_DOC) || defined(OSG_DOC_DEV)
  96 PointerType FieldTraits<FBOBackground *, nsOSG>::_type(
  97     "FBOBackgroundPtr",
  98     "BackgroundPtr",
  99     FBOBackground::getClassType(),
 100     nsOSG);
 101 #endif
 102
 103 OSG_FIELDTRAITS_GETTYPE_NS(FBOBackground *, nsOSG)
 104
 105 OSG_EXPORT_PTR_SFIELD_FULL(PointerSField,
 106                            FBOBackground *,
 107                            nsOSG)
 108
 109
 110 /***************************************************************************\
 111  *                         Field Description                               *
 112 \***************************************************************************/
 113
 114 void FBOBackgroundBase::classDescInserter(TypeObject &oType)
 115 {
 116     FieldDescriptionBase *pDesc = NULL;
 117
 118
 119     pDesc = new SFUnrecFrameBufferObjectPtr::Description(
 120         SFUnrecFrameBufferObjectPtr::getClassType(),
 121         "frameBufferObject",
 122         "The FramebufferObject to clear from.\n",
 123         FrameBufferObjectFieldId, FrameBufferObjectFieldMask,
 124         false,
 125         (Field::SFDefaultFlags | Field::FStdAccess),
 126         static_cast<FieldEditMethodSig>(&FBOBackground::editHandleFrameBufferObject),
 127         static_cast<FieldGetMethodSig >(&FBOBackground::getHandleFrameBufferObject));
 128
 129     oType.addInitialDesc(pDesc);
 130 }
 131
 132
 133 FBOBackgroundBase::TypeObject FBOBackgroundBase::_type(
 134     FBOBackgroundBase::getClassname(),
 135     Inherited::getClassname(),
 136     "NULL",
 137     nsOSG, //Namespace
 138     reinterpret_cast<PrototypeCreateF>(&FBOBackgroundBase::createEmptyLocal),
 139     reinterpret_cast<InitContainerF>(&FBOBackground::initMethod),
 140     reinterpret_cast<ExitContainerF>(&FBOBackground::exitMethod),
 141     reinterpret_cast<InitalInsertDescFunc>(
 142         reinterpret_cast<void *>(&FBOBackground::classDescInserter)),
 143     false,
 144     0,
 145     "<?xml version=\"1.0\" ?>\n"
 146     "\n"
 147     "<FieldContainer\n"
 148     "   name=\"FBOBackground\"\n"
 149     "   parent=\"Background\"\n"
 150     "   library=\"Window\"\n"
 151     "   structure=\"concrete\"\n"
 152     "   pointerfieldtypes=\"single\"\n"
 153     "   systemcomponent=\"true\"\n"
 154     "   parentsystemcomponent=\"true\"\n"
 155     "   docGroupBase=\"GrpWindowPassive\"\n"
 156     "   >\n"
 157     "  <Field\n"
 158     "\t  name=\"frameBufferObject\"\n"
 159     "\t  type=\"FrameBufferObjectPtr\"\n"
 160     "\t  cardinality=\"single\"\n"
 161     "\t  visibility=\"external\"\n"
 162     "\t  access=\"public\"\n"
 163     "\t  >\n"
 164     "    The FramebufferObject to clear from.\n"
 165     "  </Field>\n"
 166     "</FieldContainer>\n",
 167     ""
 168     );
 169
 170 /*------------------------------ get -----------------------------------*/
 171
 172 FieldContainerType &FBOBackgroundBase::getType(void)
 173 {
 174     return _type;
 175 }
 176
 177 const FieldContainerType &FBOBackgroundBase::getType(void) const
 178 {
 179     return _type;
 180 }
 181
 182 UInt32 FBOBackgroundBase::getContainerSize(void) const
 183 {
 184     return sizeof(FBOBackground);
 185 }
 186
 187 /*------------------------- decorator get ------------------------------*/
 188
 189
 190 //! Get the FBOBackground::_sfFrameBufferObject field.
 191 const SFUnrecFrameBufferObjectPtr *FBOBackgroundBase::getSFFrameBufferObject(void) const
 192 {
 193     return &_sfFrameBufferObject;
 194 }
 195
 196 SFUnrecFrameBufferObjectPtr *FBOBackgroundBase::editSFFrameBufferObject(void)
 197 {
 198     editSField(FrameBufferObjectFieldMask);
 199
 200     return &_sfFrameBufferObject;
 201 }
 202
 203 //! Get the value of the FBOBackground::_sfFrameBufferObject field.
 204 FrameBufferObject * FBOBackgroundBase::getFrameBufferObject(void) const
 205 {
 206     return _sfFrameBufferObject.getValue();
 207 }
 208
 209 //! Set the value of the FBOBackground::_sfFrameBufferObject field.
 210 void FBOBackgroundBase::setFrameBufferObject(FrameBufferObject * const value)
 211 {
 212     editSField(FrameBufferObjectFieldMask);
 213
 214     _sfFrameBufferObject.setValue(value);
 215 }
 216
 217
 218
 219
 220
 221
 222 /*------------------------------ access -----------------------------------*/
 223
 224 SizeT FBOBackgroundBase::getBinSize(ConstFieldMaskArg whichField)
 225 {
 226     SizeT returnValue = Inherited::getBinSize(whichField);
 227
 228     if(FieldBits::NoField != (FrameBufferObjectFieldMask & whichField))
 229     {
 230         returnValue += _sfFrameBufferObject.getBinSize();
 231     }
 232
 233     return returnValue;
 234 }
 235
 236 void FBOBackgroundBase::copyToBin(BinaryDataHandler &pMem,
 237                                   ConstFieldMaskArg  whichField)
 238 {
 239     Inherited::copyToBin(pMem, whichField);
 240
 241     if(FieldBits::NoField != (FrameBufferObjectFieldMask & whichField))
 242     {
 243         _sfFrameBufferObject.copyToBin(pMem);
 244     }
 245 }
 246
 247 void FBOBackgroundBase::copyFromBin(BinaryDataHandler &pMem,
 248                                     ConstFieldMaskArg  whichField)
 249 {
 250     Inherited::copyFromBin(pMem, whichField);
 251
 252     if(FieldBits::NoField != (FrameBufferObjectFieldMask & whichField))
 253     {
 254         editSField(FrameBufferObjectFieldMask);
 255         _sfFrameBufferObject.copyFromBin(pMem);
 256     }
 257 }
 258
 259 //! create a new instance of the class
 260 FBOBackgroundTransitPtr FBOBackgroundBase::createLocal(BitVector bFlags)
 261 {
 262     FBOBackgroundTransitPtr fc;
 263
 264     if(getClassType().getPrototype() != NULL)
 265     {
 266         FieldContainerTransitPtr tmpPtr =
 267             getClassType().getPrototype()-> shallowCopyLocal(bFlags);
 268
 269         fc = dynamic_pointer_cast<FBOBackground>(tmpPtr);
 270     }
 271
 272     return fc;
 273 }
 274
 275 //! create a new instance of the class, copy the container flags
 276 FBOBackgroundTransitPtr FBOBackgroundBase::createDependent(BitVector bFlags)
 277 {
 278     FBOBackgroundTransitPtr fc;
 279
 280     if(getClassType().getPrototype() != NULL)
 281     {
 282         FieldContainerTransitPtr tmpPtr =
 283             getClassType().getPrototype()-> shallowCopyDependent(bFlags);
 284
 285         fc = dynamic_pointer_cast<FBOBackground>(tmpPtr);
 286     }
 287
 288     return fc;
 289 }
 290
 291 //! create a new instance of the class
 292 FBOBackgroundTransitPtr FBOBackgroundBase::create(void)
 293 {
 294     FBOBackgroundTransitPtr fc;
 295
 296     if(getClassType().getPrototype() != NULL)
 297     {
 298         FieldContainerTransitPtr tmpPtr =
 299             getClassType().getPrototype()-> shallowCopy();
 300
 301         fc = dynamic_pointer_cast<FBOBackground>(tmpPtr);
 302     }
 303
 304     return fc;
 305 }
 306
 307 FBOBackground *FBOBackgroundBase::createEmptyLocal(BitVector bFlags)
 308 {
 309     FBOBackground *returnValue;
 310
 311     newPtr<FBOBackground>(returnValue, bFlags);
 312
 313     returnValue->_pFieldFlags->_bNamespaceMask &= ~bFlags;
 314
 315     return returnValue;
 316 }
 317
 318 //! create an empty new instance of the class, do not copy the prototype
 319 FBOBackground *FBOBackgroundBase::createEmpty(void)
 320 {
 321     FBOBackground *returnValue;
 322
 323     newPtr<FBOBackground>(returnValue, Thread::getCurrentLocalFlags());
 324
 325     returnValue->_pFieldFlags->_bNamespaceMask &=
 326         ~Thread::getCurrentLocalFlags();
 327
 328     return returnValue;
 329 }
 330
 331
 332 FieldContainerTransitPtr FBOBackgroundBase::shallowCopyLocal(
 333     BitVector bFlags) const
 334 {
 335     FBOBackground *tmpPtr;
 336
 337     newPtr(tmpPtr, dynamic_cast<const FBOBackground *>(this), bFlags);
 338
 339     FieldContainerTransitPtr returnValue(tmpPtr);
 340
 341     tmpPtr->_pFieldFlags->_bNamespaceMask &= ~bFlags;
 342
 343     return returnValue;
 344 }
 345
 346 FieldContainerTransitPtr FBOBackgroundBase::shallowCopyDependent(
 347     BitVector bFlags) const
 348 {
 349     FBOBackground *tmpPtr;
 350
 351     newPtr(tmpPtr, dynamic_cast<const FBOBackground *>(this), ~bFlags);
 352
 353     FieldContainerTransitPtr returnValue(tmpPtr);
 354
 355     tmpPtr->_pFieldFlags->_bNamespaceMask = bFlags;
 356
 357     return returnValue;
 358 }
 359
 360 FieldContainerTransitPtr FBOBackgroundBase::shallowCopy(void) const
 361 {
 362     FBOBackground *tmpPtr;
 363
 364     newPtr(tmpPtr,
 365            dynamic_cast<const FBOBackground *>(this),
 366            Thread::getCurrentLocalFlags());
 367
 368     tmpPtr->_pFieldFlags->_bNamespaceMask &= ~Thread::getCurrentLocalFlags();
 369
 370     FieldContainerTransitPtr returnValue(tmpPtr);
 371
 372     return returnValue;
 373 }
 374
 375
 376
 377
 378 /*------------------------- constructors ----------------------------------*/
 379
 380 FBOBackgroundBase::FBOBackgroundBase(void) :
 381     Inherited(),
 382     _sfFrameBufferObject      (NULL)
 383 {
 384 }
 385
 386 FBOBackgroundBase::FBOBackgroundBase(const FBOBackgroundBase &source) :
 387     Inherited(source),
 388     _sfFrameBufferObject      (NULL)
 389 {
 390 }
 391
 392
 393 /*-------------------------- destructors ----------------------------------*/
 394
 395 FBOBackgroundBase::~FBOBackgroundBase(void)
 396 {
 397 }
 398
 399 void FBOBackgroundBase::onCreate(const FBOBackground *source)
 400 {
 401     Inherited::onCreate(source);
 402
 403     if(source != NULL)
 404     {
 405         FBOBackground *pThis = static_cast<FBOBackground *>(this);
 406
 407         pThis->setFrameBufferObject(source->getFrameBufferObject());
 408     }
 409 }
 410
 411 GetFieldHandlePtr FBOBackgroundBase::getHandleFrameBufferObject (void) const
 412 {
 413     SFUnrecFrameBufferObjectPtr::GetHandlePtr returnValue(
 414         new  SFUnrecFrameBufferObjectPtr::GetHandle(
 415              &_sfFrameBufferObject,
 416              this->getType().getFieldDesc(FrameBufferObjectFieldId),
 417              const_cast<FBOBackgroundBase *>(this)));
 418
 419     return returnValue;
 420 }
 421
 422 EditFieldHandlePtr FBOBackgroundBase::editHandleFrameBufferObject(void)
 423 {
 424     SFUnrecFrameBufferObjectPtr::EditHandlePtr returnValue(
 425         new  SFUnrecFrameBufferObjectPtr::EditHandle(
 426              &_sfFrameBufferObject,
 427              this->getType().getFieldDesc(FrameBufferObjectFieldId),
 428              this));
 429
 430     returnValue->setSetMethod(
 431         boost::bind(&FBOBackground::setFrameBufferObject,
 432                     static_cast<FBOBackground *>(this), _1));
 433
 434     editSField(FrameBufferObjectFieldMask);
 435
 436     return returnValue;
 437 }
 438
 439
 440 #ifdef OSG_MT_CPTR_ASPECT
 441 void FBOBackgroundBase::execSyncV(      FieldContainer    &oFrom,
 442                                         ConstFieldMaskArg  whichField,
 443                                         AspectOffsetStore &oOffsets,
 444                                         ConstFieldMaskArg  syncMode,
 445                                   const UInt32             uiSyncInfo)
 446 {
 447     FBOBackground *pThis = static_cast<FBOBackground *>(this);
 448
 449     pThis->execSync(static_cast<FBOBackground *>(&oFrom),
 450                     whichField,
 451                     oOffsets,
 452                     syncMode,
 453                     uiSyncInfo);
 454 }
 455 #endif
 456
 457
 458 #ifdef OSG_MT_CPTR_ASPECT
 459 FieldContainer *FBOBackgroundBase::createAspectCopy(
 460     const FieldContainer *pRefAspect) const
 461 {
 462     FBOBackground *returnValue;
 463
 464     newAspectCopy(returnValue,
 465                   dynamic_cast<const FBOBackground *>(pRefAspect),
 466                   dynamic_cast<const FBOBackground *>(this));
 467
 468     return returnValue;
 469 }
 470 #endif
 471
 472 void FBOBackgroundBase::resolveLinks(void)
 473 {
 474     Inherited::resolveLinks();
 475
 476     static_cast<FBOBackground *>(this)->setFrameBufferObject(NULL);
 477
 478
 479 }
 480
 481
 482 OSG_END_NAMESPACE