---

c:/home/kevn/src/animaniac/ani/KeyFrame/Key.h

Go to the documentation of this file.

/*************** <auto-copyright.pl BEGIN do not edit this line> **************
 *
 * Animaniac is (C) Copyright 2000,2001 Kevin Meinert
 *
 * Original Authors:
 *   Kevin Meinert
 *
 *
 *
 * 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., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * -----------------------------------------------------------------
 * File:          $RCSfile: Key.h,v $
 * Date modified: $Date: 2001/03/05 23:23:15 $
 * Version:       $Revision: 1.2 $
 * -----------------------------------------------------------------
 *
 *************** <auto-copyright.pl END do not edit this line> ***************/


// NOTE: for best results, read this file using an editor that supports
// color syntax highlighting.  (i.e. nedit, gvim, visual studio, visual 
// slick edit)

#ifndef ANIMANIAC_KEY
#define ANIMANIAC_KEY

#include <assert.h>

namespace ani
{
   //: One Key for the KeyFramer
   class Key
   {
   public:
      Key() : mTime( 0 )
      {
      }
      // copy constructor
      Key( const Key& key )
      {
         this->setTime( key.time() );
      }
      
      // time constructor
      Key( const float& timeVal )
      {
         this->setTime( timeVal );
      }
      
      inline const float&    time() const { return mTime; }
      inline float&           time() { return mTime; }
      inline void            setTime( const float& t ) 
      { 
         mTime = t; 
      }
      
      //: set this key to the interpolated value of key0 to key1
      //  interp is a number from key0.time() to key1.time(), 
      // 
      // where: 
      //  interp == key0.time()              sets the Key to key0
      //  key0.time() < interp < key1.time() sets the Key to interpolated 
      //                                         value of key0 to key1
      //  interp == key1.time()              sets the Key to key1
      //
      //virtual void setInterpolate( float interp, const Key& key0, const Key& key1 ) = 0;

   private:
      float mTime;
   };
   
};

#endif

---