animator.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2004 by Rick L. Vinyard, Jr.                            *
 *   rvinyard@cs.nmsu.edu                                                  *
 *                                                                         *
 *   This file is part of the papyrus library.                             *
 *                                                                         *
 *   papyrus is free software; you can redistribute it and/or modify       *
 *   it under the terms of the GNU Lesser General Public License           *
 *   version 3.0 as published by the Free Software Foundation.             *
 *                                                                         *
 *   papyrus 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 Lesser General Public License version 3.0 for more details.       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with the papyrus library. If not, see                   *
 *   <http://www.gnu.org/licenses/>.                                       *
 ***************************************************************************/
#ifndef PAPYRUSANIMATOR_H
#define PAPYRUSANIMATOR_H

#include <glib.h>

#include <papyrus/controller.h>

namespace Papyrus
{

  class Animator : public Controller
  {
    protected:
      Animator(const Glib::ustring& id);

    public:
      typedef PapyrusPointer<Animator> pointer;

      virtual ~Animator();

      virtual int advance ( int n=1 );

      virtual int reverse ( int n=1 );

      virtual void set_interval ( unsigned int interval_ms );

      virtual unsigned int interval( );

      virtual double frame_rate( );

      virtual void set_frame_rate ( unsigned int frames_per_second );

      virtual void start();

      virtual void start ( unsigned int interval_ms );

      virtual void stop();

      virtual bool is_started();

      int bounce_frames();

      int bounce_direction();

      void set_bounce_frames ( int frames );

      sigc::signal<void, int> signal_advanced();

    protected:
      unsigned int m_interval;
      int m_bounce_frames;
      int m_bounce_direction;
      int m_bounce_position;
      guint m_timeout_source_id;

      sigc::signal<void, int> m_signal_advanced;

      bool timeout_handler();

      virtual int animate ( int n ) = 0;

    private:
      static gboolean timeout_handler_proxy ( gpointer data );
  };

}

#endif