Source/WindowSystem/X/OSGXWindowBase.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 XWindow!
  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 "OSGXWindowBase.h"
  67 #include "OSGXWindow.h"
  68
  69 #include <boost/bind.hpp>
  70
  71 OSG_BEGIN_NAMESPACE
  72
  73 /***************************************************************************\
  74  *                            Description                                  *
  75 \***************************************************************************/
  76
  77 /*! \class OSG::XWindow
  78     The class for X-based windows. See \ref PageWindowX for a description.
  79  */
  80
  81 /***************************************************************************\
  82  *                        Field Documentation                              *
  83 \***************************************************************************/
  84
  85 /*! \var DisplayP        XWindowBase::_sfDisplay
  86
  87 */
  88
  89 /*! \var X11Window       XWindowBase::_sfWindow
  90
  91 */
  92
  93 /*! \var GLXContext      XWindowBase::_sfContext
  94
  95 */
  96
  97 /*! \var Int32           XWindowBase::_sfFbConfigId
  98
  99 */
 100
 101
 102 /***************************************************************************\
 103  *                      FieldType/FieldTrait Instantiation                 *
 104 \***************************************************************************/
 105
 106 #if !defined(OSG_DO_DOC) || defined(OSG_DOC_DEV)
 107 PointerType FieldTraits<XWindow *, nsOSG>::_type(
 108     "XWindowPtr",
 109     "WindowPtr",
 110     XWindow::getClassType(),
 111     nsOSG);
 112 #endif
 113
 114 OSG_FIELDTRAITS_GETTYPE_NS(XWindow *, nsOSG)
 115
 116 OSG_EXPORT_PTR_SFIELD_FULL(PointerSField,
 117                            XWindow *,
 118                            nsOSG)
 119
 120 OSG_EXPORT_PTR_MFIELD_FULL(PointerMField,
 121                            XWindow *,
 122                            nsOSG)
 123
 124 /***************************************************************************\
 125  *                         Field Description                               *
 126 \***************************************************************************/
 127
 128 void XWindowBase::classDescInserter(TypeObject &oType)
 129 {
 130     FieldDescriptionBase *pDesc = NULL;
 131
 132
 133     pDesc = new SFDisplayP::Description(
 134         SFDisplayP::getClassType(),
 135         "display",
 136         "",
 137         DisplayFieldId, DisplayFieldMask,
 138         true,
 139         (Field::FClusterLocal),
 140         static_cast<FieldEditMethodSig>(&XWindow::editHandleDisplay),
 141         static_cast<FieldGetMethodSig >(&XWindow::getHandleDisplay));
 142
 143     oType.addInitialDesc(pDesc);
 144
 145     pDesc = new SFX11Window::Description(
 146         SFX11Window::getClassType(),
 147         "window",
 148         "",
 149         WindowFieldId, WindowFieldMask,
 150         true,
 151         (Field::FClusterLocal),
 152         static_cast<FieldEditMethodSig>(&XWindow::editHandleWindow),
 153         static_cast<FieldGetMethodSig >(&XWindow::getHandleWindow));
 154
 155     oType.addInitialDesc(pDesc);
 156
 157     pDesc = new SFGLXContext::Description(
 158         SFGLXContext::getClassType(),
 159         "context",
 160         "",
 161         ContextFieldId, ContextFieldMask,
 162         true,
 163         (Field::FClusterLocal),
 164         static_cast<FieldEditMethodSig>(&XWindow::editHandleContext),
 165         static_cast<FieldGetMethodSig >(&XWindow::getHandleContext));
 166
 167     oType.addInitialDesc(pDesc);
 168
 169     pDesc = new SFInt32::Description(
 170         SFInt32::getClassType(),
 171         "fbConfigId",
 172         "",
 173         FbConfigIdFieldId, FbConfigIdFieldMask,
 174         true,
 175         (Field::FClusterLocal),
 176         static_cast<FieldEditMethodSig>(&XWindow::editHandleFbConfigId),
 177         static_cast<FieldGetMethodSig >(&XWindow::getHandleFbConfigId));
 178
 179     oType.addInitialDesc(pDesc);
 180 }
 181
 182
 183 XWindowBase::TypeObject XWindowBase::_type(
 184     XWindowBase::getClassname(),
 185     Inherited::getClassname(),
 186     "NULL",
 187     nsOSG, //Namespace
 188     reinterpret_cast<PrototypeCreateF>(&XWindowBase::createEmptyLocal),
 189     reinterpret_cast<InitContainerF>(&XWindow::initMethod),
 190     reinterpret_cast<ExitContainerF>(&XWindow::exitMethod),
 191     reinterpret_cast<InitalInsertDescFunc>(
 192         reinterpret_cast<void *>(&XWindow::classDescInserter)),
 193     false,
 194     0,
 195     "<?xml version=\"1.0\"?>\n"
 196     "\n"
 197     "<FieldContainer\n"
 198     "    name=\"XWindow\"\n"
 199     "    parent=\"Window\"\n"
 200     "    library=\"WindowX\"\n"
 201     "    pointerfieldtypes=\"both\"\n"
 202     "    structure=\"concrete\"\n"
 203     "    systemcomponent=\"true\"\n"
 204     "    parentsystemcomponent=\"true\"\n"
 205     "    docGroupBase=\"GrpWindowX\"\n"
 206     "    >\n"
 207     "    The class for X-based windows. See \\ref PageWindowX for a description.\n"
 208     "    <Field\n"
 209     "        name=\"display\"\n"
 210     "        type=\"DisplayP\"\n"
 211     "        cardinality=\"single\"\n"
 212     "        visibility=\"internal\"\n"
 213     "        defaultValue=\"NULL\"\n"
 214     "        fieldHeader=\"OSGXWindowDataFields.h\"\n"
 215     "        access=\"public\"\n"
 216     "        fieldFlags=\"FClusterLocal\"\n"
 217     "        >\n"
 218     "    </Field>\n"
 219     "    <Field\n"
 220     "        name=\"window\"\n"
 221     "        type=\"X11Window\"\n"
 222     "        cardinality=\"single\"\n"
 223     "        visibility=\"internal\"\n"
 224     "        defaultValue=\"NULL\"\n"
 225     "        fieldHeader=\"OSGXWindowDataFields.h\"\n"
 226     "        access=\"public\"\n"
 227     "        fieldFlags=\"FClusterLocal\"\n"
 228     "        >\n"
 229     "    </Field>\n"
 230     "    <Field\n"
 231     "        name=\"context\"\n"
 232     "        type=\"GLXContext\"\n"
 233     "        cardinality=\"single\"\n"
 234     "        visibility=\"internal\"\n"
 235     "        defaultValue=\"NULL\"\n"
 236     "        fieldHeader=\"OSGXWindowDataFields.h\"\n"
 237     "        access=\"public\"\n"
 238     "        fieldFlags=\"FClusterLocal\"\n"
 239     "        >\n"
 240     "    </Field>\n"
 241     "    <Field\n"
 242     "        name=\"fbConfigId\"\n"
 243     "        type=\"Int32\"\n"
 244     "        cardinality=\"single\"\n"
 245     "        visibility=\"internal\"\n"
 246     "        defaultValue=\"-1\"\n"
 247     "        access=\"public\"\n"
 248     "        fieldFlags=\"FClusterLocal\"\n"
 249     "        >\n"
 250     "    </Field>\n"
 251     "</FieldContainer>\n",
 252     "The class for X-based windows. See \\ref PageWindowX for a description.\n"
 253     );
 254
 255 /*------------------------------ get -----------------------------------*/
 256
 257 FieldContainerType &XWindowBase::getType(void)
 258 {
 259     return _type;
 260 }
 261
 262 const FieldContainerType &XWindowBase::getType(void) const
 263 {
 264     return _type;
 265 }
 266
 267 UInt32 XWindowBase::getContainerSize(void) const
 268 {
 269     return sizeof(XWindow);
 270 }
 271
 272 /*------------------------- decorator get ------------------------------*/
 273
 274
 275 SFDisplayP *XWindowBase::editSFDisplay(void)
 276 {
 277     editSField(DisplayFieldMask);
 278
 279     return &_sfDisplay;
 280 }
 281
 282 const SFDisplayP *XWindowBase::getSFDisplay(void) const
 283 {
 284     return &_sfDisplay;
 285 }
 286
 287
 288 SFX11Window *XWindowBase::editSFWindow(void)
 289 {
 290     editSField(WindowFieldMask);
 291
 292     return &_sfWindow;
 293 }
 294
 295 const SFX11Window *XWindowBase::getSFWindow(void) const
 296 {
 297     return &_sfWindow;
 298 }
 299
 300
 301 SFGLXContext *XWindowBase::editSFContext(void)
 302 {
 303     editSField(ContextFieldMask);
 304
 305     return &_sfContext;
 306 }
 307
 308 const SFGLXContext *XWindowBase::getSFContext(void) const
 309 {
 310     return &_sfContext;
 311 }
 312
 313
 314 SFInt32 *XWindowBase::editSFFbConfigId(void)
 315 {
 316     editSField(FbConfigIdFieldMask);
 317
 318     return &_sfFbConfigId;
 319 }
 320
 321 const SFInt32 *XWindowBase::getSFFbConfigId(void) const
 322 {
 323     return &_sfFbConfigId;
 324 }
 325
 326
 327
 328
 329
 330
 331 /*------------------------------ access -----------------------------------*/
 332
 333 SizeT XWindowBase::getBinSize(ConstFieldMaskArg whichField)
 334 {
 335     SizeT returnValue = Inherited::getBinSize(whichField);
 336
 337     if(FieldBits::NoField != (DisplayFieldMask & whichField))
 338     {
 339         returnValue += _sfDisplay.getBinSize();
 340     }
 341     if(FieldBits::NoField != (WindowFieldMask & whichField))
 342     {
 343         returnValue += _sfWindow.getBinSize();
 344     }
 345     if(FieldBits::NoField != (ContextFieldMask & whichField))
 346     {
 347         returnValue += _sfContext.getBinSize();
 348     }
 349     if(FieldBits::NoField != (FbConfigIdFieldMask & whichField))
 350     {
 351         returnValue += _sfFbConfigId.getBinSize();
 352     }
 353
 354     return returnValue;
 355 }
 356
 357 void XWindowBase::copyToBin(BinaryDataHandler &pMem,
 358                                   ConstFieldMaskArg  whichField)
 359 {
 360     Inherited::copyToBin(pMem, whichField);
 361
 362     if(FieldBits::NoField != (DisplayFieldMask & whichField))
 363     {
 364         _sfDisplay.copyToBin(pMem);
 365     }
 366     if(FieldBits::NoField != (WindowFieldMask & whichField))
 367     {
 368         _sfWindow.copyToBin(pMem);
 369     }
 370     if(FieldBits::NoField != (ContextFieldMask & whichField))
 371     {
 372         _sfContext.copyToBin(pMem);
 373     }
 374     if(FieldBits::NoField != (FbConfigIdFieldMask & whichField))
 375     {
 376         _sfFbConfigId.copyToBin(pMem);
 377     }
 378 }
 379
 380 void XWindowBase::copyFromBin(BinaryDataHandler &pMem,
 381                                     ConstFieldMaskArg  whichField)
 382 {
 383     Inherited::copyFromBin(pMem, whichField);
 384
 385     if(FieldBits::NoField != (DisplayFieldMask & whichField))
 386     {
 387         editSField(DisplayFieldMask);
 388         _sfDisplay.copyFromBin(pMem);
 389     }
 390     if(FieldBits::NoField != (WindowFieldMask & whichField))
 391     {
 392         editSField(WindowFieldMask);
 393         _sfWindow.copyFromBin(pMem);
 394     }
 395     if(FieldBits::NoField != (ContextFieldMask & whichField))
 396     {
 397         editSField(ContextFieldMask);
 398         _sfContext.copyFromBin(pMem);
 399     }
 400     if(FieldBits::NoField != (FbConfigIdFieldMask & whichField))
 401     {
 402         editSField(FbConfigIdFieldMask);
 403         _sfFbConfigId.copyFromBin(pMem);
 404     }
 405 }
 406
 407 //! create a new instance of the class
 408 XWindowTransitPtr XWindowBase::createLocal(BitVector bFlags)
 409 {
 410     XWindowTransitPtr fc;
 411
 412     if(getClassType().getPrototype() != NULL)
 413     {
 414         FieldContainerTransitPtr tmpPtr =
 415             getClassType().getPrototype()-> shallowCopyLocal(bFlags);
 416
 417         fc = dynamic_pointer_cast<XWindow>(tmpPtr);
 418     }
 419
 420     return fc;
 421 }
 422
 423 //! create a new instance of the class, copy the container flags
 424 XWindowTransitPtr XWindowBase::createDependent(BitVector bFlags)
 425 {
 426     XWindowTransitPtr fc;
 427
 428     if(getClassType().getPrototype() != NULL)
 429     {
 430         FieldContainerTransitPtr tmpPtr =
 431             getClassType().getPrototype()-> shallowCopyDependent(bFlags);
 432
 433         fc = dynamic_pointer_cast<XWindow>(tmpPtr);
 434     }
 435
 436     return fc;
 437 }
 438
 439 //! create a new instance of the class
 440 XWindowTransitPtr XWindowBase::create(void)
 441 {
 442     XWindowTransitPtr fc;
 443
 444     if(getClassType().getPrototype() != NULL)
 445     {
 446         FieldContainerTransitPtr tmpPtr =
 447             getClassType().getPrototype()-> shallowCopy();
 448
 449         fc = dynamic_pointer_cast<XWindow>(tmpPtr);
 450     }
 451
 452     return fc;
 453 }
 454
 455 XWindow *XWindowBase::createEmptyLocal(BitVector bFlags)
 456 {
 457     XWindow *returnValue;
 458
 459     newPtr<XWindow>(returnValue, bFlags);
 460
 461     returnValue->_pFieldFlags->_bNamespaceMask &= ~bFlags;
 462
 463     return returnValue;
 464 }
 465
 466 //! create an empty new instance of the class, do not copy the prototype
 467 XWindow *XWindowBase::createEmpty(void)
 468 {
 469     XWindow *returnValue;
 470
 471     newPtr<XWindow>(returnValue, Thread::getCurrentLocalFlags());
 472
 473     returnValue->_pFieldFlags->_bNamespaceMask &=
 474         ~Thread::getCurrentLocalFlags();
 475
 476     return returnValue;
 477 }
 478
 479
 480 FieldContainerTransitPtr XWindowBase::shallowCopyLocal(
 481     BitVector bFlags) const
 482 {
 483     XWindow *tmpPtr;
 484
 485     newPtr(tmpPtr, dynamic_cast<const XWindow *>(this), bFlags);
 486
 487     FieldContainerTransitPtr returnValue(tmpPtr);
 488
 489     tmpPtr->_pFieldFlags->_bNamespaceMask &= ~bFlags;
 490
 491     return returnValue;
 492 }
 493
 494 FieldContainerTransitPtr XWindowBase::shallowCopyDependent(
 495     BitVector bFlags) const
 496 {
 497     XWindow *tmpPtr;
 498
 499     newPtr(tmpPtr, dynamic_cast<const XWindow *>(this), ~bFlags);
 500
 501     FieldContainerTransitPtr returnValue(tmpPtr);
 502
 503     tmpPtr->_pFieldFlags->_bNamespaceMask = bFlags;
 504
 505     return returnValue;
 506 }
 507
 508 FieldContainerTransitPtr XWindowBase::shallowCopy(void) const
 509 {
 510     XWindow *tmpPtr;
 511
 512     newPtr(tmpPtr,
 513            dynamic_cast<const XWindow *>(this),
 514            Thread::getCurrentLocalFlags());
 515
 516     tmpPtr->_pFieldFlags->_bNamespaceMask &= ~Thread::getCurrentLocalFlags();
 517
 518     FieldContainerTransitPtr returnValue(tmpPtr);
 519
 520     return returnValue;
 521 }
 522
 523
 524
 525
 526 /*------------------------- constructors ----------------------------------*/
 527
 528 XWindowBase::XWindowBase(void) :
 529     Inherited(),
 530     _sfDisplay                (DisplayP(NULL)),
 531     _sfWindow                 (X11Window(NULL)),
 532     _sfContext                (GLXContext(NULL)),
 533     _sfFbConfigId             (Int32(-1))
 534 {
 535 }
 536
 537 XWindowBase::XWindowBase(const XWindowBase &source) :
 538     Inherited(source),
 539     _sfDisplay                (source._sfDisplay                ),
 540     _sfWindow                 (source._sfWindow                 ),
 541     _sfContext                (source._sfContext                ),
 542     _sfFbConfigId             (source._sfFbConfigId             )
 543 {
 544 }
 545
 546
 547 /*-------------------------- destructors ----------------------------------*/
 548
 549 XWindowBase::~XWindowBase(void)
 550 {
 551 }
 552
 553
 554 GetFieldHandlePtr XWindowBase::getHandleDisplay         (void) const
 555 {
 556     SFDisplayP::GetHandlePtr returnValue(
 557         new  SFDisplayP::GetHandle(
 558              &_sfDisplay,
 559              this->getType().getFieldDesc(DisplayFieldId),
 560              const_cast<XWindowBase *>(this)));
 561
 562     return returnValue;
 563 }
 564
 565 EditFieldHandlePtr XWindowBase::editHandleDisplay        (void)
 566 {
 567     SFDisplayP::EditHandlePtr returnValue(
 568         new  SFDisplayP::EditHandle(
 569              &_sfDisplay,
 570              this->getType().getFieldDesc(DisplayFieldId),
 571              this));
 572
 573
 574     editSField(DisplayFieldMask);
 575
 576     return returnValue;
 577 }
 578
 579 GetFieldHandlePtr XWindowBase::getHandleWindow          (void) const
 580 {
 581     SFX11Window::GetHandlePtr returnValue(
 582         new  SFX11Window::GetHandle(
 583              &_sfWindow,
 584              this->getType().getFieldDesc(WindowFieldId),
 585              const_cast<XWindowBase *>(this)));
 586
 587     return returnValue;
 588 }
 589
 590 EditFieldHandlePtr XWindowBase::editHandleWindow         (void)
 591 {
 592     SFX11Window::EditHandlePtr returnValue(
 593         new  SFX11Window::EditHandle(
 594              &_sfWindow,
 595              this->getType().getFieldDesc(WindowFieldId),
 596              this));
 597
 598
 599     editSField(WindowFieldMask);
 600
 601     return returnValue;
 602 }
 603
 604 GetFieldHandlePtr XWindowBase::getHandleContext         (void) const
 605 {
 606     SFGLXContext::GetHandlePtr returnValue(
 607         new  SFGLXContext::GetHandle(
 608              &_sfContext,
 609              this->getType().getFieldDesc(ContextFieldId),
 610              const_cast<XWindowBase *>(this)));
 611
 612     return returnValue;
 613 }
 614
 615 EditFieldHandlePtr XWindowBase::editHandleContext        (void)
 616 {
 617     SFGLXContext::EditHandlePtr returnValue(
 618         new  SFGLXContext::EditHandle(
 619              &_sfContext,
 620              this->getType().getFieldDesc(ContextFieldId),
 621              this));
 622
 623
 624     editSField(ContextFieldMask);
 625
 626     return returnValue;
 627 }
 628
 629 GetFieldHandlePtr XWindowBase::getHandleFbConfigId      (void) const
 630 {
 631     SFInt32::GetHandlePtr returnValue(
 632         new  SFInt32::GetHandle(
 633              &_sfFbConfigId,
 634              this->getType().getFieldDesc(FbConfigIdFieldId),
 635              const_cast<XWindowBase *>(this)));
 636
 637     return returnValue;
 638 }
 639
 640 EditFieldHandlePtr XWindowBase::editHandleFbConfigId     (void)
 641 {
 642     SFInt32::EditHandlePtr returnValue(
 643         new  SFInt32::EditHandle(
 644              &_sfFbConfigId,
 645              this->getType().getFieldDesc(FbConfigIdFieldId),
 646              this));
 647
 648
 649     editSField(FbConfigIdFieldMask);
 650
 651     return returnValue;
 652 }
 653
 654
 655 #ifdef OSG_MT_CPTR_ASPECT
 656 void XWindowBase::execSyncV(      FieldContainer    &oFrom,
 657                                         ConstFieldMaskArg  whichField,
 658                                         AspectOffsetStore &oOffsets,
 659                                         ConstFieldMaskArg  syncMode,
 660                                   const UInt32             uiSyncInfo)
 661 {
 662     XWindow *pThis = static_cast<XWindow *>(this);
 663
 664     pThis->execSync(static_cast<XWindow *>(&oFrom),
 665                     whichField,
 666                     oOffsets,
 667                     syncMode,
 668                     uiSyncInfo);
 669 }
 670 #endif
 671
 672
 673 #ifdef OSG_MT_CPTR_ASPECT
 674 FieldContainer *XWindowBase::createAspectCopy(
 675     const FieldContainer *pRefAspect) const
 676 {
 677     XWindow *returnValue;
 678
 679     newAspectCopy(returnValue,
 680                   dynamic_cast<const XWindow *>(pRefAspect),
 681                   dynamic_cast<const XWindow *>(this));
 682
 683     return returnValue;
 684 }
 685 #endif
 686
 687 void XWindowBase::resolveLinks(void)
 688 {
 689     Inherited::resolveLinks();
 690
 691
 692 }
 693
 694
 695 OSG_END_NAMESPACE