Source/System/Dynamics/Base/OSGFrameTaskInterface.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 _OSGFRAMETASKINTERFACE_H_
  40 #define _OSGFRAMETASKINTERFACE_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGDynamicsDef.h"
  46 #include "OSGBaseTypes.h"
  47 #include "OSGTime.h"
  48
  49 OSG_BEGIN_NAMESPACE
  50
  51 /*! \brief FrameTask class. See \ref
  52            PageDynamicsFrameTask for a description.
  53     \ingroup GrpDynamicsBaseObj
  54     \ingroup GrpLibOSGDynamics
  55  */
  56
  57 class OSG_DYNAMICS_DLLMAPPING FrameTaskInterface
  58 {
  59   protected:
  60
  61     /*==========================  PUBLIC  =================================*/
  62
  63   public:
  64
  65     typedef FrameTaskInterface Self;
  66
  67     /*---------------------------------------------------------------------*/
  68     /*! \name                      Sync                                    */
  69     /*! \{                                                                 */
  70
  71     /*! \}                                                                 */
  72     /*---------------------------------------------------------------------*/
  73     /*! \name                     Output                                   */
  74     /*! \{                                                                 */
  75
  76     virtual bool  init       (void                      );
  77     virtual void  frame      (Time oTime, UInt32 uiFrame) = 0;
  78     virtual void  shutdown   (void                      );
  79
  80     virtual Int32 getPriority(void                      ) const;
  81
  82     /*! \}                                                                 */
  83     /*---------------------------------------------------------------------*/
  84     /*! \name                     Output                                   */
  85     /*! \{                                                                 */
  86
  87     /*! \}                                                                 */
  88     /*=========================  PROTECTED  ===============================*/
  89
  90   protected:
  91
  92     // Variables should all be in FrameTaskBase.
  93
  94     /*---------------------------------------------------------------------*/
  95     /*! \name                  Constructors                                */
  96     /*! \{                                                                 */
  97
  98     FrameTaskInterface(void);
  99     FrameTaskInterface(const FrameTaskInterface &source);
 100
 101     /*! \}                                                                 */
 102     /*---------------------------------------------------------------------*/
 103     /*! \name                   Destructors                                */
 104     /*! \{                                                                 */
 105
 106     virtual ~FrameTaskInterface(void);
 107
 108     /*! \}                                                                 */
 109     /*---------------------------------------------------------------------*/
 110     /*! \name                      Init                                    */
 111     /*! \{                                                                 */
 112
 113     /*! \}                                                                 */
 114     /*---------------------------------------------------------------------*/
 115     /*! \name                      Init                                    */
 116     /*! \{                                                                 */
 117
 118     /*! \}                                                                 */
 119     /*==========================  PRIVATE  ================================*/
 120
 121   private:
 122
 123     // prohibit default functions (move to 'public' if you need one)
 124     void operator =(const FrameTaskInterface &source);
 125 };
 126
 127 typedef FrameTaskInterface *FrameTaskInterfaceP;
 128
 129 OSG_END_NAMESPACE
 130
 131 #endif /* _OSGFRAMETASKINTERFACE_H_ */