Source/System/Dynamics/Skeleton/OSGSkinningAlgorithm.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 _OSGSKINNINGALGORITHM_H_
  40 #define _OSGSKINNINGALGORITHM_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGSkinningAlgorithmBase.h"
  46 #include "OSGSkinnedGeometry.h"
  47 #include "OSGVolume.h"
  48
  49 OSG_BEGIN_NAMESPACE
  50
  51 /*! \brief SkinningAlgorithm class. See \ref
  52            PageDynamicsSkinningAlgorithm for a description.
  53 */
  54
  55 class OSG_DYNAMICS_DLLMAPPING SkinningAlgorithm : public SkinningAlgorithmBase
  56 {
  57   protected:
  58
  59     /*==========================  PUBLIC  =================================*/
  60
  61   public:
  62
  63     typedef SkinningAlgorithmBase         Inherited;
  64     typedef SkinningAlgorithm             Self;
  65
  66     typedef SkinnedGeometry::RenderModeE  RenderModeE;
  67
  68     /*---------------------------------------------------------------------*/
  69     /*! \name Execute                                                      */
  70     /*! \{                                                                 */
  71
  72     virtual void adjustVolume(Volume  &volume ) = 0;
  73
  74     virtual void execute     (DrawEnv *drawEnv);
  75
  76     virtual Action::ResultE intersectEnter(Action *action) = 0;
  77
  78     /*! \}                                                                 */
  79     /*---------------------------------------------------------------------*/
  80     /*! \name Access                                                       */
  81     /*! \{                                                                 */
  82
  83             SkinnedGeometry *getSkin      (void) const;
  84     virtual RenderModeE      getRenderMode(void) const = 0;
  85
  86     /*---------------------------------------------------------------------*/
  87     /*! \name  Sync                                                        */
  88     /*! \{                                                                 */
  89
  90     virtual void changed(ConstFieldMaskArg whichField,
  91                          UInt32            origin,
  92                          BitVector         details    );
  93
  94     /*! \}                                                                 */
  95     /*---------------------------------------------------------------------*/
  96     /*! \name Output                                                       */
  97     /*! \{                                                                 */
  98
  99     virtual void dump(      UInt32     uiIndent = 0,
 100                       const BitVector  bvFlags  = 0) const;
 101
 102     /*! \}                                                                 */
 103     /*=========================  PROTECTED  ===============================*/
 104
 105   protected:
 106
 107     // Variables should all be in SkinningAlgorithmBase.
 108
 109     /*---------------------------------------------------------------------*/
 110     /*! \name                  Constructors                                */
 111     /*! \{                                                                 */
 112
 113     SkinningAlgorithm(void);
 114     SkinningAlgorithm(const SkinningAlgorithm &source);
 115
 116     /*! \}                                                                 */
 117     /*---------------------------------------------------------------------*/
 118     /*! \name                   Destructors                                */
 119     /*! \{                                                                 */
 120
 121     virtual ~SkinningAlgorithm(void);
 122
 123     /*! \}                                                                 */
 124     /*---------------------------------------------------------------------*/
 125     /*! \name                      Init                                    */
 126     /*! \{                                                                 */
 127
 128     static void initMethod(InitPhase ePhase);
 129
 130     /*! \}                                                                 */
 131     /*==========================  PRIVATE  ================================*/
 132
 133   private:
 134
 135     friend class FieldContainer;
 136     friend class SkinningAlgorithmBase;
 137
 138     // prohibit default functions (move to 'public' if you need one)
 139     void operator =(const SkinningAlgorithm &source);
 140 };
 141
 142 typedef SkinningAlgorithm *SkinningAlgorithmP;
 143
 144 OSG_END_NAMESPACE
 145
 146 #include "OSGSkinningAlgorithmBase.inl"
 147 #include "OSGSkinningAlgorithm.inl"
 148
 149 #endif /* _OSGSKINNINGALGORITHM_H_ */