Logo Search packages:      
Sourcecode: blender version File versions

GHOST_TimerTask.h

Go to the documentation of this file.
/**
 * $Id: GHOST_TimerTask.h,v 1.6 2002/12/28 22:26:45 maarten Exp $
 * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version. The Blender
 * Foundation also sells licenses for use in proprietary software under
 * the Blender License.  See http://www.blender.org/BL/ for information
 * about this.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL/BL DUAL LICENSE BLOCK *****
 */
/**
 * @file    GHOST_TimerTask.h
 * Declaration of GHOST_TimerTask class.
 */

#ifndef _GHOST_TIMER_TASK_H_
#define _GHOST_TIMER_TASK_H_

#include "GHOST_ITimerTask.h"


/**
 * Implementation of a timer task.
 * @author  Maarten Gribnau
 * @date    May 28, 2001
 */
00047 class GHOST_TimerTask : public GHOST_ITimerTask
{
public:
      /**
       * Constructor.
       * @param start         The timer start time.
       * @param interval      The interval between calls to the timerProc
       * @param timerProc     The callbak invoked when the interval expires.
       * @param data          The timer user data.
       */
00057       GHOST_TimerTask(GHOST_TUns64 start, GHOST_TUns64 interval, GHOST_TimerProcPtr timerProc, GHOST_TUserDataPtr userData = 0)
            : m_start(start), m_interval(interval), m_next(start), m_timerProc(timerProc), m_userData(userData), m_auxData(0)
      {
      }

      /**
       * Returns the timer start time.
       * @return The timer start time.
       */
00066       inline virtual GHOST_TUns64 getStart() const
      {
            return m_start;
      }

      /**
       * Changes the timer start time.
       * @param start The timer start time.
       */
00075       virtual void setStart(GHOST_TUns64 start)
      { 
            m_start = start;
      }

      /**
       * Returns the timer interval.
       * @return The timer interval.
       */
00084       inline virtual GHOST_TUns64 getInterval() const
      {
            return m_interval;
      }

      /**
       * Changes the timer interval.
       * @param interval The timer interval.
       */
00093       virtual void setInterval(GHOST_TUns64 interval)
      { 
            m_interval = interval;
      }

      /**
       * Returns the time the timerProc will be called.
       * @return The time the timerProc will be called.
       */
00102       inline virtual GHOST_TUns64 getNext() const
      {
            return m_next;
      }

      /**
       * Changes the time the timerProc will be called.
       * @param next The time the timerProc will be called.
       */
00111       virtual void setNext(GHOST_TUns64 next)
      { 
            m_next = next;
      }

      /**
       * Returns the timer callback.
       * @return the timer callback.
       */
00120       inline virtual GHOST_TimerProcPtr getTimerProc() const
      {
            return m_timerProc;
      }

      /**
       * Changes the timer callback.
       * @param The timer callback.
       */
00129       inline virtual void setTimerProc(const GHOST_TimerProcPtr timerProc)
      {
            m_timerProc = timerProc;
      }

      /**
       * Returns the timer user data.
       * @return The timer user data.
       */
00138       inline virtual GHOST_TUserDataPtr getUserData() const
      {
            return m_userData;
      }
      
      /**
       * Changes the time user data.
       * @param data The timer user data.
       */
00147       virtual void setUserData(const GHOST_TUserDataPtr userData)
      {
            m_userData = userData;
      }

      /**
       * Returns the auxiliary storage room.
       * @return The auxiliary storage room.
       */
00156       inline virtual GHOST_TUns32 getAuxData() const
      {
            return m_auxData;
      }

      /**
       * Changes the auxiliary storage room.
       * @param auxData The auxiliary storage room.
       */
00165       virtual void setAuxData(GHOST_TUns32 auxData)
      { 
            m_auxData = auxData;
      }

protected:
      /** The time the timer task was started. */
00172       GHOST_TUns64 m_start;

      /** The interval between calls. */
00175       GHOST_TUns64 m_interval;

      /** The time the timerProc will be called. */
00178       GHOST_TUns64 m_next;

      /** The callback invoked when the timer expires. */
00181       GHOST_TimerProcPtr m_timerProc;

      /** The timer task user data. */
00184       GHOST_TUserDataPtr m_userData;

      /** Auxiliary storage room. */
00187       GHOST_TUns32 m_auxData;
};

#endif // _GHOST_TIMER_TASK_H_


Generated by  Doxygen 1.6.0   Back to index