Source/System/Dynamics/Animation/OSGAnimBlender.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 _OSGANIMBLENDER_H_
  40 #define _OSGANIMBLENDER_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGAnimBlenderBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 // forward decl
  50 class AnimChannel;
  51
  52 /*! \brief AnimBlender class. See \ref
  53            PageDynamicsAnimBlender for a description.
  54 */
  55
  56 class OSG_DYNAMICS_DLLMAPPING AnimBlender : public AnimBlenderBase
  57 {
  58   protected:
  59
  60     /*==========================  PUBLIC  =================================*/
  61
  62   public:
  63
  64     typedef AnimBlenderBase Inherited;
  65     typedef AnimBlender     Self;
  66
  67     /*---------------------------------------------------------------------*/
  68     /*! \name                      Sync                                    */
  69     /*! \{                                                                 */
  70
  71     virtual void changed(ConstFieldMaskArg whichField,
  72                          UInt32            origin,
  73                          BitVector         details    );
  74
  75     /*! \}                                                                 */
  76     /*---------------------------------------------------------------------*/
  77     /*! \name                       Setup                                  */
  78     /*! \{                                                                 */
  79
  80     virtual void addChannel(      AnimChannel         *channel   ) = 0;
  81     virtual void subChannel(      AnimChannel         *channel   ) = 0;
  82
  83     virtual void connectTo (      AttachmentContainer *container,
  84                             const std::string         &fieldName ) = 0;
  85
  86     /*! \}                                                                 */
  87     /*---------------------------------------------------------------------*/
  88     /*! \name                  Frame Task Interface                        */
  89     /*! \{                                                                 */
  90
  91     virtual Int32 getPriority(void) const;
  92
  93     /*! \}                                                                 */
  94     /*---------------------------------------------------------------------*/
  95     /*! \name                     Output                                   */
  96     /*! \{                                                                 */
  97
  98     virtual void dump(      UInt32     uiIndent = 0,
  99                       const BitVector  bvFlags  = 0) const;
 100
 101     /*! \}                                                                 */
 102     /*=========================  PROTECTED  ===============================*/
 103
 104   protected:
 105
 106     // Variables should all be in AnimBlenderBase.
 107
 108     static Int32 _blendTaskPriority;
 109
 110     /*---------------------------------------------------------------------*/
 111     /*! \name                  Constructors                                */
 112     /*! \{                                                                 */
 113
 114     AnimBlender(void);
 115     AnimBlender(const AnimBlender &source);
 116
 117     /*! \}                                                                 */
 118     /*---------------------------------------------------------------------*/
 119     /*! \name                   Destructors                                */
 120     /*! \{                                                                 */
 121
 122     virtual ~AnimBlender(void);
 123
 124     /*! \}                                                                 */
 125     /*---------------------------------------------------------------------*/
 126     /*! \name                      Init                                    */
 127     /*! \{                                                                 */
 128
 129     static void initMethod(InitPhase ePhase);
 130
 131     /*! \}                                                                 */
 132     /*==========================  PRIVATE  ================================*/
 133
 134   private:
 135
 136     friend class FieldContainer;
 137     friend class AnimBlenderBase;
 138
 139     // prohibit default functions (move to 'public' if you need one)
 140     void operator =(const AnimBlender &source);
 141 };
 142
 143 typedef AnimBlender *AnimBlenderP;
 144
 145 OSG_END_NAMESPACE
 146
 147 #include "OSGAnimBlenderBase.inl"
 148 #include "OSGAnimBlender.inl"
 149
 150 #endif /* _OSGANIMBLENDER_H_ */