Source/System/Dynamics/Skeleton/OSGSkeletonOgreJoint.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 _OSGSKELETONOGREJOINT_H_
  40 #define _OSGSKELETONOGREJOINT_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGSkeletonOgreJointBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 /*! \brief SkeletonOgreJoint class. See \ref
  50            PageDynamicsSkeletonOgreJoint for a description.
  51 */
  52
  53 class OSG_DYNAMICS_DLLMAPPING SkeletonOgreJoint : public SkeletonOgreJointBase
  54 {
  55   protected:
  56
  57     /*==========================  PUBLIC  =================================*/
  58
  59   public:
  60
  61     typedef SkeletonOgreJointBase Inherited;
  62     typedef SkeletonOgreJoint     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                     Actions                                  */
  75     /*! \{                                                                 */
  76
  77     virtual Action::ResultE jointUpdateEnter(JointTraverser *jt);
  78     virtual Action::ResultE jointUpdateLeave(JointTraverser *jt);
  79
  80     Action::ResultE animBindEnter(Action *action);
  81
  82     /*! \}                                                                 */
  83     /*---------------------------------------------------------------------*/
  84     /*! \name                   Transformation                             */
  85     /*! \{                                                                 */
  86
  87     virtual void accumulateMatrix(Matrix &result);
  88
  89     /*! \}                                                                 */
  90     /*---------------------------------------------------------------------*/
  91     /*! \name                      Volume                                  */
  92     /*! \{                                                                 */
  93
  94     virtual void adjustVolume    (Volume &volume);
  95
  96     /*! \}                                                                 */
  97     /*---------------------------------------------------------------------*/
  98     /*! \name                     Output                                   */
  99     /*! \{                                                                 */
 100
 101     virtual void dump(      UInt32     uiIndent = 0,
 102                       const BitVector  bvFlags  = 0) const;
 103
 104     /*! \}                                                                 */
 105     /*=========================  PROTECTED  ===============================*/
 106
 107   protected:
 108
 109     // Variables should all be in SkeletonOgreJointBase.
 110     Vec3f      _accumTranslate;
 111     Vec3f      _accumScale;
 112     Quaternion _accumRotate;
 113
 114     /*---------------------------------------------------------------------*/
 115     /*! \name                  Constructors                                */
 116     /*! \{                                                                 */
 117
 118     SkeletonOgreJoint(void);
 119     SkeletonOgreJoint(const SkeletonOgreJoint &source);
 120
 121     /*! \}                                                                 */
 122     /*---------------------------------------------------------------------*/
 123     /*! \name                   Destructors                                */
 124     /*! \{                                                                 */
 125
 126     virtual ~SkeletonOgreJoint(void);
 127
 128     /*! \}                                                                 */
 129     /*---------------------------------------------------------------------*/
 130     /*! \name                      Init                                    */
 131     /*! \{                                                                 */
 132
 133     static void initMethod(InitPhase ePhase);
 134
 135     /*! \}                                                                 */
 136     /*==========================  PRIVATE  ================================*/
 137
 138   private:
 139
 140     friend class FieldContainer;
 141     friend class SkeletonOgreJointBase;
 142
 143     // prohibit default functions (move to 'public' if you need one)
 144     void operator =(const SkeletonOgreJoint &source);
 145 };
 146
 147 typedef SkeletonOgreJoint *SkeletonOgreJointP;
 148
 149 OSG_END_NAMESPACE
 150
 151 #include "OSGSkeletonOgreJointBase.inl"
 152 #include "OSGSkeletonOgreJoint.inl"
 153
 154 #endif /* _OSGSKELETONOGREJOINT_H_ */