Source/System/Dynamics/Animation/OSGAnimChannelBase.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 AnimChannel!
  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 "OSGAnimation.h"               // Animation Class
  66
  67 #include "OSGAnimChannelBase.h"
  68 #include "OSGAnimChannel.h"
  69
  70 #include <boost/bind.hpp>
  71
  72 OSG_BEGIN_NAMESPACE
  73
  74 /***************************************************************************\
  75  *                            Description                                  *
  76 \***************************************************************************/
  77
  78 /*! \class OSG::AnimChannel
  79     Base for animation data sinks.
  80  */
  81
  82 /***************************************************************************\
  83  *                        Field Documentation                              *
  84 \***************************************************************************/
  85
  86 /*! \var Animation *     AnimChannelBase::_sfAnimation
  87
  88 */
  89
  90 /*! \var Real32          AnimChannelBase::_sfWeight
  91
  92 */
  93
  94 /*! \var Real32          AnimChannelBase::_sfInValue
  95
  96 */
  97
  98
  99 /***************************************************************************\
 100  *                      FieldType/FieldTrait Instantiation                 *
 101 \***************************************************************************/
 102
 103 #if !defined(OSG_DO_DOC) || defined(OSG_DOC_DEV)
 104 PointerType FieldTraits<AnimChannel *, nsOSG>::_type(
 105     "AnimChannelPtr",
 106     "NodeCorePtr",
 107     AnimChannel::getClassType(),
 108     nsOSG);
 109 #endif
 110
 111 OSG_FIELDTRAITS_GETTYPE_NS(AnimChannel *, nsOSG)
 112
 113 OSG_EXPORT_PTR_SFIELD_FULL(PointerSField,
 114                            AnimChannel *,
 115                            nsOSG)
 116
 117 OSG_EXPORT_PTR_MFIELD_FULL(PointerMField,
 118                            AnimChannel *,
 119                            nsOSG)
 120
 121 DataType &FieldTraits< AnimChannel *, nsOSG + 1 >::getType(void)
 122 {
 123     return FieldTraits<AnimChannel *, nsOSG>::getType();
 124 }
 125
 126
 127 OSG_EXPORT_PTR_SFIELD(ChildPointerSField,
 128                       AnimChannel *,
 129                       UnrecordedRefCountPolicy,
 130                       nsOSG + 1)
 131
 132
 133 OSG_EXPORT_PTR_MFIELD(ChildPointerMField,
 134                       AnimChannel *,
 135                       UnrecordedRefCountPolicy,
 136                       nsOSG + 1)
 137
 138
 139 /***************************************************************************\
 140  *                         Field Description                               *
 141 \***************************************************************************/
 142
 143 void AnimChannelBase::classDescInserter(TypeObject &oType)
 144 {
 145     FieldDescriptionBase *pDesc = NULL;
 146
 147
 148     pDesc = new SFParentAnimationPtr::Description(
 149         SFParentAnimationPtr::getClassType(),
 150         "animation",
 151         "",
 152         AnimationFieldId, AnimationFieldMask,
 153         false,
 154         (Field::FClusterLocal),
 155         static_cast     <FieldEditMethodSig>(&AnimChannel::invalidEditField),
 156         static_cast     <FieldGetMethodSig >(&AnimChannel::invalidGetField));
 157
 158     oType.addInitialDesc(pDesc);
 159
 160     pDesc = new SFReal32::Description(
 161         SFReal32::getClassType(),
 162         "weight",
 163         "",
 164         WeightFieldId, WeightFieldMask,
 165         false,
 166         (Field::FClusterLocal),
 167         static_cast<FieldEditMethodSig>(&AnimChannel::editHandleWeight),
 168         static_cast<FieldGetMethodSig >(&AnimChannel::getHandleWeight));
 169
 170     oType.addInitialDesc(pDesc);
 171
 172     pDesc = new SFReal32::Description(
 173         SFReal32::getClassType(),
 174         "inValue",
 175         "",
 176         InValueFieldId, InValueFieldMask,
 177         false,
 178         (Field::FClusterLocal),
 179         static_cast<FieldEditMethodSig>(&AnimChannel::editHandleInValue),
 180         static_cast<FieldGetMethodSig >(&AnimChannel::getHandleInValue));
 181
 182     oType.addInitialDesc(pDesc);
 183 }
 184
 185
 186 AnimChannelBase::TypeObject AnimChannelBase::_type(
 187     AnimChannelBase::getClassname(),
 188     Inherited::getClassname(),
 189     "NULL",
 190     nsOSG, //Namespace
 191     NULL,
 192     reinterpret_cast<InitContainerF>(&AnimChannel::initMethod),
 193     reinterpret_cast<ExitContainerF>(&AnimChannel::exitMethod),
 194     reinterpret_cast<InitalInsertDescFunc>(
 195         reinterpret_cast<void *>(&AnimChannel::classDescInserter)),
 196     false,
 197     0,
 198     "<?xml version=\"1.0\"?>\n"
 199     "\n"
 200     "<FieldContainer\n"
 201     "    name=\"AnimChannel\"\n"
 202     "    parent=\"NodeCore\"\n"
 203     "    library=\"Dynamics\"\n"
 204     "    pointerfieldtypes=\"both\"\n"
 205     "    structure=\"abstract\"\n"
 206     "    systemcomponent=\"true\"\n"
 207     "    parentsystemcomponent=\"true\"\n"
 208     "    decoratable=\"false\"\n"
 209     "    useLocalIncludes=\"false\"\n"
 210     "    isNodeCore=\"true\"\n"
 211     "    isBundle=\"false\"\n"
 212     "    childFields=\"both\"\n"
 213     "    parentFields=\"none\"\n"
 214     ">\n"
 215     "  Base for animation data sinks.\n"
 216     " \n"
 217     "  <Field\n"
 218     "     name=\"animation\"\n"
 219     "     category=\"parentpointer\"\n"
 220     "     type=\"Animation\"\n"
 221     "     cardinality=\"single\"\n"
 222     "     visibility=\"external\"\n"
 223     "     access=\"none\"\n"
 224     "     fieldFlags=\"FClusterLocal\"\n"
 225     "     >\n"
 226     "  </Field>\n"
 227     "  <Field\n"
 228     "     name=\"weight\"\n"
 229     "     category=\"data\"\n"
 230     "     type=\"Real32\"\n"
 231     "     cardinality=\"single\"\n"
 232     "     visibility=\"external\"\n"
 233     "     access=\"public\"\n"
 234     "     defaultValue=\"1.f\"\n"
 235     "     fieldFlags=\"FClusterLocal\"\n"
 236     "     >\n"
 237     "  </Field>\n"
 238     "  <Field\n"
 239     "     name=\"inValue\"\n"
 240     "     category=\"data\"\n"
 241     "     type=\"Real32\"\n"
 242     "     cardinality=\"single\"\n"
 243     "     visibility=\"external\"\n"
 244     "     access=\"public\"\n"
 245     "     defaultValue=\"0.0\"\n"
 246     "     fieldFlags=\"FClusterLocal\"\n"
 247     "     >\n"
 248     "  </Field>\n"
 249     "</FieldContainer>\n",
 250     "Base for animation data sinks.\n"
 251     );
 252
 253 /*------------------------------ get -----------------------------------*/
 254
 255 FieldContainerType &AnimChannelBase::getType(void)
 256 {
 257     return _type;
 258 }
 259
 260 const FieldContainerType &AnimChannelBase::getType(void) const
 261 {
 262     return _type;
 263 }
 264
 265 UInt32 AnimChannelBase::getContainerSize(void) const
 266 {
 267     return sizeof(AnimChannel);
 268 }
 269
 270 /*------------------------- decorator get ------------------------------*/
 271
 272
 273
 274 SFReal32 *AnimChannelBase::editSFWeight(void)
 275 {
 276     editSField(WeightFieldMask);
 277
 278     return &_sfWeight;
 279 }
 280
 281 const SFReal32 *AnimChannelBase::getSFWeight(void) const
 282 {
 283     return &_sfWeight;
 284 }
 285
 286
 287 SFReal32 *AnimChannelBase::editSFInValue(void)
 288 {
 289     editSField(InValueFieldMask);
 290
 291     return &_sfInValue;
 292 }
 293
 294 const SFReal32 *AnimChannelBase::getSFInValue(void) const
 295 {
 296     return &_sfInValue;
 297 }
 298
 299
 300
 301
 302
 303
 304 /*------------------------------ access -----------------------------------*/
 305
 306 SizeT AnimChannelBase::getBinSize(ConstFieldMaskArg whichField)
 307 {
 308     SizeT returnValue = Inherited::getBinSize(whichField);
 309
 310     if(FieldBits::NoField != (AnimationFieldMask & whichField))
 311     {
 312         returnValue += _sfAnimation.getBinSize();
 313     }
 314     if(FieldBits::NoField != (WeightFieldMask & whichField))
 315     {
 316         returnValue += _sfWeight.getBinSize();
 317     }
 318     if(FieldBits::NoField != (InValueFieldMask & whichField))
 319     {
 320         returnValue += _sfInValue.getBinSize();
 321     }
 322
 323     return returnValue;
 324 }
 325
 326 void AnimChannelBase::copyToBin(BinaryDataHandler &pMem,
 327                                   ConstFieldMaskArg  whichField)
 328 {
 329     Inherited::copyToBin(pMem, whichField);
 330
 331     if(FieldBits::NoField != (AnimationFieldMask & whichField))
 332     {
 333         _sfAnimation.copyToBin(pMem);
 334     }
 335     if(FieldBits::NoField != (WeightFieldMask & whichField))
 336     {
 337         _sfWeight.copyToBin(pMem);
 338     }
 339     if(FieldBits::NoField != (InValueFieldMask & whichField))
 340     {
 341         _sfInValue.copyToBin(pMem);
 342     }
 343 }
 344
 345 void AnimChannelBase::copyFromBin(BinaryDataHandler &pMem,
 346                                     ConstFieldMaskArg  whichField)
 347 {
 348     Inherited::copyFromBin(pMem, whichField);
 349
 350     if(FieldBits::NoField != (AnimationFieldMask & whichField))
 351     {
 352         editSField(AnimationFieldMask);
 353         _sfAnimation.copyFromBin(pMem);
 354     }
 355     if(FieldBits::NoField != (WeightFieldMask & whichField))
 356     {
 357         editSField(WeightFieldMask);
 358         _sfWeight.copyFromBin(pMem);
 359     }
 360     if(FieldBits::NoField != (InValueFieldMask & whichField))
 361     {
 362         editSField(InValueFieldMask);
 363         _sfInValue.copyFromBin(pMem);
 364     }
 365 }
 366
 367
 368
 369
 370 /*------------------------- constructors ----------------------------------*/
 371
 372 AnimChannelBase::AnimChannelBase(void) :
 373     Inherited(),
 374     _sfAnimation              (NULL),
 375     _sfWeight                 (Real32(1.f)),
 376     _sfInValue                (Real32(0.0))
 377 {
 378 }
 379
 380 AnimChannelBase::AnimChannelBase(const AnimChannelBase &source) :
 381     Inherited(source),
 382     _sfAnimation              (NULL),
 383     _sfWeight                 (source._sfWeight                 ),
 384     _sfInValue                (source._sfInValue                )
 385 {
 386 }
 387
 388
 389 /*-------------------------- destructors ----------------------------------*/
 390
 391 AnimChannelBase::~AnimChannelBase(void)
 392 {
 393 }
 394 /*-------------------------------------------------------------------------*/
 395 /* Parent linking                                                          */
 396
 397 bool AnimChannelBase::linkParent(
 398     FieldContainer * const pParent,
 399     UInt16           const childFieldId,
 400     UInt16           const parentFieldId )
 401 {
 402     if(parentFieldId == AnimationFieldId)
 403     {
 404         Animation * pTypedParent =
 405             dynamic_cast< Animation * >(pParent);
 406
 407         if(pTypedParent != NULL)
 408         {
 409             FieldContainer *pOldParent =
 410                 _sfAnimation.getValue         ();
 411
 412             UInt16 oldChildFieldId =
 413                 _sfAnimation.getParentFieldPos();
 414
 415             if(pOldParent != NULL)
 416             {
 417                 pOldParent->unlinkChild(this, oldChildFieldId);
 418             }
 419
 420             editSField(AnimationFieldMask);
 421
 422             _sfAnimation.setValue(static_cast<Animation *>(pParent), childFieldId);
 423
 424             return true;
 425         }
 426
 427         return false;
 428     }
 429
 430     return Inherited::linkParent(pParent, childFieldId, parentFieldId);
 431 }
 432
 433 bool AnimChannelBase::unlinkParent(
 434     FieldContainer * const pParent,
 435     UInt16           const parentFieldId)
 436 {
 437     if(parentFieldId == AnimationFieldId)
 438     {
 439         Animation * pTypedParent =
 440             dynamic_cast< Animation * >(pParent);
 441
 442         if(pTypedParent != NULL)
 443         {
 444             if(_sfAnimation.getValue() == pTypedParent)
 445             {
 446                 editSField(AnimationFieldMask);
 447
 448                 _sfAnimation.setValue(NULL, 0xFFFF);
 449
 450                 return true;
 451             }
 452
 453             SWARNING << "Child (["          << this
 454                      << "] id ["            << this->getId()
 455                      << "] type ["          << this->getType().getCName()
 456                      << "] parentFieldId [" << parentFieldId
 457                      << "]) - Parent (["    << pParent
 458                      << "] id ["            << pParent->getId()
 459                      << "] type ["          << pParent->getType().getCName()
 460                      << "]): link inconsistent!"
 461                      << std::endl;
 462
 463             return false;
 464         }
 465
 466         return false;
 467     }
 468
 469     return Inherited::unlinkParent(pParent, parentFieldId);
 470 }
 471
 472
 473
 474 GetFieldHandlePtr AnimChannelBase::getHandleAnimation       (void) const
 475 {
 476     SFParentAnimationPtr::GetHandlePtr returnValue;
 477
 478     return returnValue;
 479 }
 480
 481 EditFieldHandlePtr AnimChannelBase::editHandleAnimation      (void)
 482 {
 483     EditFieldHandlePtr returnValue;
 484
 485     return returnValue;
 486 }
 487
 488 GetFieldHandlePtr AnimChannelBase::getHandleWeight          (void) const
 489 {
 490     SFReal32::GetHandlePtr returnValue(
 491         new  SFReal32::GetHandle(
 492              &_sfWeight,
 493              this->getType().getFieldDesc(WeightFieldId),
 494              const_cast<AnimChannelBase *>(this)));
 495
 496     return returnValue;
 497 }
 498
 499 EditFieldHandlePtr AnimChannelBase::editHandleWeight         (void)
 500 {
 501     SFReal32::EditHandlePtr returnValue(
 502         new  SFReal32::EditHandle(
 503              &_sfWeight,
 504              this->getType().getFieldDesc(WeightFieldId),
 505              this));
 506
 507
 508     editSField(WeightFieldMask);
 509
 510     return returnValue;
 511 }
 512
 513 GetFieldHandlePtr AnimChannelBase::getHandleInValue         (void) const
 514 {
 515     SFReal32::GetHandlePtr returnValue(
 516         new  SFReal32::GetHandle(
 517              &_sfInValue,
 518              this->getType().getFieldDesc(InValueFieldId),
 519              const_cast<AnimChannelBase *>(this)));
 520
 521     return returnValue;
 522 }
 523
 524 EditFieldHandlePtr AnimChannelBase::editHandleInValue        (void)
 525 {
 526     SFReal32::EditHandlePtr returnValue(
 527         new  SFReal32::EditHandle(
 528              &_sfInValue,
 529              this->getType().getFieldDesc(InValueFieldId),
 530              this));
 531
 532
 533     editSField(InValueFieldMask);
 534
 535     return returnValue;
 536 }
 537
 538
 539 #ifdef OSG_MT_CPTR_ASPECT
 540 void AnimChannelBase::execSyncV(      FieldContainer    &oFrom,
 541                                         ConstFieldMaskArg  whichField,
 542                                         AspectOffsetStore &oOffsets,
 543                                         ConstFieldMaskArg  syncMode,
 544                                   const UInt32             uiSyncInfo)
 545 {
 546     AnimChannel *pThis = static_cast<AnimChannel *>(this);
 547
 548     pThis->execSync(static_cast<AnimChannel *>(&oFrom),
 549                     whichField,
 550                     oOffsets,
 551                     syncMode,
 552                     uiSyncInfo);
 553 }
 554 #endif
 555
 556
 557
 558 void AnimChannelBase::resolveLinks(void)
 559 {
 560     Inherited::resolveLinks();
 561
 562
 563 }
 564
 565
 566 OSG_END_NAMESPACE