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