---

sglAnimation.hpp

/*****************************************************************************
 * SGL: A Scene Graph Library
 *
 * Copyright (C) 1997-2001  Scott McMillan   All Rights Reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *****************************************************************************
 *     File: sglAnimation.hpp
 *  Created: 29 May 2001
 *  Summary: abstract base class for all animation classes.
 *****************************************************************************/

#ifndef __SGL_ANIMATION_HPP
#define __SGL_ANIMATION_HPP

#include <sgl.h>
#include <sglGroup.hpp>

//----------------------------------------------------------------------------

//----------------------------------------------------------------------------

class SGL_DLL_API sglAnimation : public sglGroup
{
public:
   enum ModeEnum
   {
      eCYCLE,
      eSWING
   };

   enum StateEnum
   {
      eSTART,
      ePAUSE,
      eRESUME,
      eSTOP
   };

public:
   sglAnimation();
   virtual ~sglAnimation();

   void setMode(ModeEnum mode) { m_mode = mode; }

   ModeEnum getMode() const { return m_mode; }

   bool setState(StateEnum state);

   StateEnum getState() const { return m_state; }

   void setRange(int first_node = 0, int last_node = -1);

   void getRange(unsigned int &first_node, unsigned int &last_node) const;

   void setSpeed(float speed);

   float getSpeed() const;

   void setNumCycles(unsigned int num_cycles);

   unsigned int getNumCycles() const { return m_num_cycles; }

   // see sglObject::printInfo() for details
   virtual void printInfo(ostream &ostrm, const char *indent_string) const;

protected:
   virtual void computeValues() = 0;

   void copyTo(sglAnimation *dst, unsigned int mode) const;

private:    // not implemented
   sglAnimation(const sglAnimation &);
   sglAnimation &operator=(const sglAnimation &);

protected:
   ModeEnum     m_mode;
   StateEnum    m_state;
   bool         m_state_dirty_flag;  // need separate dirty flag

   bool         m_range_flag;
   unsigned int m_first;
   unsigned int m_last;

   bool         m_reverse_flag;
   float        m_speed;
   unsigned int m_num_cycles;
};

#endif

---