Source/System/Dynamics/Base/OSGFrameTaskMixin.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *           Copyright (C) 2003 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 _OSGFRAMETASKMIXIN_H_
  40 #define _OSGFRAMETASKMIXIN_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGFrameHandler.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 /*! \ingroup GrpDynamicsBaseObj
  50     \ingroup GrpLibOSGDynamics
  51  */
  52 template <class ParentT>
  53 class FrameTaskMixin  : public ParentT, public FrameTaskInterface
  54 {
  55     /*==========================  PRIVATE  ================================*/
  56
  57   private:
  58
  59     typedef ParentT            Inherited;
  60     typedef FrameTaskInterface Interface;
  61
  62     /*==========================  PUBLIC  =================================*/
  63
  64   public:
  65
  66     typedef          FrameTaskMixin<ParentT>           Self;
  67
  68     typedef typename ParentT::Desc                     Desc;
  69     typedef typename Desc::TypeObject                  TypeObject;
  70
  71     /*---------------------------------------------------------------------*/
  72     /*! \name                      dcast                                   */
  73     /*! \{                                                                 */
  74
  75     /*! \}                                                                 */
  76     /*---------------------------------------------------------------------*/
  77     /*! \name        General Fieldcontainer Declaration                    */
  78     /*! \{                                                                 */
  79
  80     /*! \}                                                                 */
  81     /*---------------------------------------------------------------------*/
  82     /*! \name                   Constructors                               */
  83     /*! \{                                                                 */
  84
  85     /*! \}                                                                 */
  86     /*---------------------------------------------------------------------*/
  87     /*! \name                   Destructor                                 */
  88     /*! \{                                                                 */
  89
  90     /*! \}                                                                 */
  91     /*---------------------------------------------------------------------*/
  92     /*! \name                    Helper                                    */
  93     /*! \{                                                                 */
  94
  95     /*! \}                                                                 */
  96     /*---------------------------------------------------------------------*/
  97     /*! \name                      Get                                     */
  98     /*! \{                                                                 */
  99
 100     /*! \}                                                                 */
 101     /*---------------------------------------------------------------------*/
 102     /*! \name                      Set                                     */
 103     /*! \{                                                                 */
 104     /*! \}                                                                 */
 105     /*---------------------------------------------------------------------*/
 106     /*! \name                 Container Access                             */
 107     /*! \{                                                                 */
 108
 109     /*! \}                                                                 */
 110     /*---------------------------------------------------------------------*/
 111     /*! \name                   Binary Access                              */
 112     /*! \{                                                                 */
 113
 114     /*! \}                                                                 */
 115     /*---------------------------------------------------------------------*/
 116     /*! \name                   your_operators                             */
 117     /*! \{                                                                 */
 118
 119     /*! \}                                                                 */
 120     /*---------------------------------------------------------------------*/
 121     /*! \name                    Comparison                                */
 122     /*! \{                                                                 */
 123
 124     /*! \}                                                                 */
 125     /*---------------------------------------------------------------------*/
 126     /*! \name                        Dump                                  */
 127     /*! \{                                                                 */
 128
 129     virtual void dump(      UInt32    uiIndent = 0,
 130                       const BitVector bvFlags  = 0) const;
 131
 132     /*! \}                                                                 */
 133     /*=========================  PROTECTED  ===============================*/
 134
 135   protected:
 136
 137     bool _bNoFrameFunction;
 138
 139     /*---------------------------------------------------------------------*/
 140     /*! \name                  Type information                            */
 141     /*! \{                                                                 */
 142
 143     /*! \}                                                                 */
 144     /*---------------------------------------------------------------------*/
 145     /*! \name                      Fields                                  */
 146     /*! \{                                                                 */
 147
 148     /*! \}                                                                 */
 149     /*---------------------------------------------------------------------*/
 150     /*! \name                      Member                                  */
 151     /*! \{                                                                 */
 152
 153     FrameTaskMixin(void);
 154     FrameTaskMixin(const FrameTaskMixin &source);
 155
 156     virtual ~FrameTaskMixin(void);
 157
 158     /*! \}                                                                 */
 159     /*---------------------------------------------------------------------*/
 160     /*! \name                      Changed                                 */
 161     /*! \{                                                                 */
 162
 163     /*! \}                                                                 */
 164     /*---------------------------------------------------------------------*/
 165     /*! \name                       Edit                                   */
 166     /*! \{                                                                 */
 167
 168     /*! \}                                                                 */
 169     /*---------------------------------------------------------------------*/
 170     /*! \name                       Sync                                   */
 171     /*! \{                                                                 */
 172
 173             void onCreateAspect (const Self   *createAspect,
 174                                  const Self   *source       = NULL);
 175     virtual void onDestroyAspect(      UInt32  uiContainerId,
 176                                        UInt32  uiAspect           );
 177
 178     /*! \}                                                                 */
 179     /*==========================  PRIVATE  ================================*/
 180
 181   private:
 182
 183     /*!\brief prohibit default function (move to 'public' if needed) */
 184     void operator =(const FrameTaskMixin &source);
 185 };
 186
 187 OSG_END_NAMESPACE
 188
 189 #include "OSGFrameTaskMixin.inl"
 190
 191 #endif /* _OSGFRAMETASKMIXIN_H_ */