Source/System/Dynamics/Animation/OSGAnimQuaternionDataSource.h

   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 #ifndef _OSGANIMQUATERNIONDATASOURCE_H_
  40 #define _OSGANIMQUATERNIONDATASOURCE_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGAnimQuaternionDataSourceBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 /*! \brief AnimQuaternionDataSource class. See \ref
  50            PageDynamicsAnimQuaternionDataSource for a description.
  51 */
  52
  53 class OSG_DYNAMICS_DLLMAPPING AnimQuaternionDataSource : public AnimQuaternionDataSourceBase
  54 {
  55   protected:
  56
  57     /*==========================  PUBLIC  =================================*/
  58
  59   public:
  60
  61     typedef AnimQuaternionDataSourceBase Inherited;
  62     typedef AnimQuaternionDataSource     Self;
  63
  64     /*---------------------------------------------------------------------*/
  65     /*! \name                      Sync                                    */
  66     /*! \{                                                                 */
  67
  68     virtual void changed(ConstFieldMaskArg whichField,
  69                          UInt32            origin,
  70                          BitVector         details    );
  71
  72     /*! \}                                                                 */
  73     /*---------------------------------------------------------------------*/
  74     /*! \name                     Factory                                  */
  75     /*! \{                                                                 */
  76
  77     virtual AnimChannelTransitPtr createChannel(void) const;
  78     virtual AnimBlenderTransitPtr createBlender(void) const;
  79
  80     /*! \}                                                                 */
  81     /*---------------------------------------------------------------------*/
  82     /*! \name                   Evaluation                                 */
  83     /*! \{                                                                 */
  84
  85     void evaluate(Quaternion &outValue, Real32 inValue);
  86
  87     /*! \}                                                                 */
  88     /*---------------------------------------------------------------------*/
  89     /*! \name                     Output                                   */
  90     /*! \{                                                                 */
  91
  92     virtual void dump(      UInt32     uiIndent = 0,
  93                       const BitVector  bvFlags  = 0) const;
  94
  95     /*! \}                                                                 */
  96     /*=========================  PROTECTED  ===============================*/
  97
  98   protected:
  99
 100     // Variables should all be in AnimQuaternionDataSourceBase.
 101
 102     /*---------------------------------------------------------------------*/
 103     /*! \name                  Constructors                                */
 104     /*! \{                                                                 */
 105
 106     AnimQuaternionDataSource(void);
 107     AnimQuaternionDataSource(const AnimQuaternionDataSource &source);
 108
 109     /*! \}                                                                 */
 110     /*---------------------------------------------------------------------*/
 111     /*! \name                   Destructors                                */
 112     /*! \{                                                                 */
 113
 114     virtual ~AnimQuaternionDataSource(void);
 115
 116     /*! \}                                                                 */
 117     /*---------------------------------------------------------------------*/
 118     /*! \name                      Init                                    */
 119     /*! \{                                                                 */
 120
 121     static void initMethod(InitPhase ePhase);
 122
 123     /*! \}                                                                 */
 124     /*---------------------------------------------------------------------*/
 125     /*! \name                   Evaluation                                 */
 126     /*! \{                                                                 */
 127
 128     void evalStep        (Quaternion                     &outValue,
 129                           Real32                          inValue,
 130                           MFInValuesType::const_iterator  ivRIt    );
 131     void evalLinear      (Quaternion                     &outValue,
 132                           Real32                          inValue,
 133                           MFInValuesType::const_iterator  ivRIt    );
 134
 135     void extrapolateFront(Quaternion &outValue, Real32 inValue);
 136     void extrapolateBack (Quaternion &outValue, Real32 inValue);
 137
 138     void checkDataConsistency(void);
 139
 140     /*! \}                                                                 */
 141     /*==========================  PRIVATE  ================================*/
 142
 143   private:
 144
 145     friend class FieldContainer;
 146     friend class AnimQuaternionDataSourceBase;
 147
 148     // prohibit default functions (move to 'public' if you need one)
 149     void operator =(const AnimQuaternionDataSource &source);
 150 };
 151
 152 typedef AnimQuaternionDataSource *AnimQuaternionDataSourceP;
 153
 154 OSG_END_NAMESPACE
 155
 156 #include "OSGAnimQuaternionDataSourceBase.inl"
 157 #include "OSGAnimQuaternionDataSource.inl"
 158
 159 #endif /* _OSGANIMQUATERNIONDATASOURCE_H_ */