Source/System/Dynamics/Skeleton/OSGSkeletonSkinningAlgorithm.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 _OSGSKELETONSKINNINGALGORITHM_H_
  40 #define _OSGSKELETONSKINNINGALGORITHM_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGSkeletonSkinningAlgorithmBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 /*! \brief SkeletonSkinningAlgorithm class. See \ref
  50            PageDynamicsSkeletonSkinningAlgorithm for a description.
  51 */
  52
  53 class OSG_DYNAMICS_DLLMAPPING SkeletonSkinningAlgorithm : public SkeletonSkinningAlgorithmBase
  54 {
  55   protected:
  56
  57     /*==========================  PUBLIC  =================================*/
  58
  59   public:
  60
  61     typedef SkeletonSkinningAlgorithmBase Inherited;
  62     typedef SkeletonSkinningAlgorithm     Self;
  63
  64     typedef SkinnedGeometry::RenderModeE  RenderModeE;
  65
  66     /*---------------------------------------------------------------------*/
  67     /*! \name                      Execute                                 */
  68     /*! \{                                                                 */
  69
  70     virtual void            adjustVolume  (Volume &volume);
  71
  72     virtual Action::ResultE renderEnter   (Action *action);
  73     virtual Action::ResultE renderLeave   (Action *action);
  74
  75     virtual Action::ResultE intersectEnter(Action *action);
  76
  77     /*! \}                                                                 */
  78     /*---------------------------------------------------------------------*/
  79     /*! \name Access                                                       */
  80     /*! \{                                                                 */
  81
  82     virtual RenderModeE getRenderMode(void) const;
  83
  84     /*! \}                                                                 */
  85     /*---------------------------------------------------------------------*/
  86     /*! \name                      Sync                                    */
  87     /*! \{                                                                 */
  88
  89     virtual void changed(ConstFieldMaskArg whichField,
  90                          UInt32            origin,
  91                          BitVector         details    );
  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 SkeletonSkinningAlgorithmBase.
 107
 108     /*---------------------------------------------------------------------*/
 109     /*! \name                  Constructors                                */
 110     /*! \{                                                                 */
 111
 112     SkeletonSkinningAlgorithm(void);
 113     SkeletonSkinningAlgorithm(const SkeletonSkinningAlgorithm &source);
 114
 115     /*! \}                                                                 */
 116     /*---------------------------------------------------------------------*/
 117     /*! \name                   Destructors                                */
 118     /*! \{                                                                 */
 119
 120     virtual ~SkeletonSkinningAlgorithm(void);
 121
 122     /*! \}                                                                 */
 123     /*---------------------------------------------------------------------*/
 124     /*! \name                      Init                                    */
 125     /*! \{                                                                 */
 126
 127     static void initMethod(InitPhase ePhase);
 128
 129     /*! \}                                                                 */
 130     /*---------------------------------------------------------------------*/
 131     /*! \name                      Render                                  */
 132     /*! \{                                                                 */
 133
 134     ActionBase::ResultE drawFunc(DrawEnv *drawEnv);
 135
 136     /*! \}                                                                 */
 137     /*==========================  PRIVATE  ================================*/
 138
 139   private:
 140
 141     friend class FieldContainer;
 142     friend class SkeletonSkinningAlgorithmBase;
 143
 144     // prohibit default functions (move to 'public' if you need one)
 145     void operator =(const SkeletonSkinningAlgorithm &source);
 146 };
 147
 148 typedef SkeletonSkinningAlgorithm *SkeletonSkinningAlgorithmP;
 149
 150 OSG_END_NAMESPACE
 151
 152 #include "OSGSkeletonSkinningAlgorithmBase.inl"
 153 #include "OSGSkeletonSkinningAlgorithm.inl"
 154
 155 #endif /* _OSGSKELETONSKINNINGALGORITHM_H_ */