Source/WindowSystem/WIN32/OSGWIN32WindowBase.cpp

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