channel.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2004-2007 by Reality Rift Studios                       *
 *   http://www.realityrift.com  -  mattias@realityrift.com                *
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 *   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.             *
 ***************************************************************************/

#ifndef neo_animation_channel_h
#define neo_animation_channel_h

#include "../core/platform.h"

#if NEO_ENABLE_ANIMATION

#include "../core/hashstring.h"
#include "keyframe.h"

namespace neo {
namespace animation {


class Channel
{
    public:


                                                            Channel( const std::string& name );
    
    virtual                                                ~Channel();


    virtual unsigned int                                    getKeyframeIndex( float time, unsigned int last = 0 ) = 0;


    virtual void                                            interpolate( Keyframe* p_dst, float time, unsigned int lastKeyframe ) = 0;


    virtual void                                            blend( Keyframe* p_dst, float weight, float time, unsigned int lastKeyframe ) = 0;


    virtual Keyframe*                                       allocateKeyframe() const = 0;


    virtual void                                            setNumKeyframes( unsigned int num ) = 0;
    

    virtual unsigned int                                    getNumKeyframes() const = 0;
    

    inline const core::HashString&                          getName() const;
    
    protected:
    
    core::HashString                                        _name;
};

class TransformChannel : public Channel
{
    public:
    

                                                            TransformChannel( const std::string& name );

    virtual                                                ~TransformChannel();
    virtual unsigned int                                    getKeyframeIndex( float time, unsigned int last );
    virtual void                                            interpolate( Keyframe* p_dst, float time, unsigned int lastKeyframe );
    virtual void                                            blend( Keyframe* p_dst, float weight, float time, unsigned int lastKeyframe );
    virtual Keyframe*                                       allocateKeyframe() const;
    virtual void                                            setNumKeyframes( unsigned int num );
    virtual unsigned int                                    getNumKeyframes() const;


    inline const core::Array< TransformKeyframe >&          getKeyframes() const;


    inline TransformKeyframe*                               getKeyframe( unsigned int keyframe );
    
    protected:
    
    core::Array< TransformKeyframe >                        _keyframes;
};

class VectorChannel : public Channel
{
    public:
    

                                                            VectorChannel( const std::string& name, unsigned int num = 3 );
    
    virtual                                                ~VectorChannel();
    virtual unsigned int                                    getKeyframeIndex( float time, unsigned int last );
    virtual void                                            interpolate( Keyframe* p_dst, float time, unsigned int lastKeyframe );
    virtual void                                            blend( Keyframe* p_dst, float weight, float time, unsigned int lastKeyframe );
    virtual Keyframe*                                       allocateKeyframe() const;
    virtual void                                            setNumKeyframes( unsigned int num );
    virtual unsigned int                                    getNumKeyframes() const;
    

    void                                                    setNumValues( unsigned int num );
    

    inline unsigned int                                     getNumValues() const;


    inline const core::Array< VectorKeyframe >&             getKeyframes() const;
    

    inline VectorKeyframe*                                  getKeyframe( unsigned int keyframe );
    
    protected:
        
    unsigned int                                            _numValues;
        
    core::Array< VectorKeyframe >                           _keyframes;
};

#include "channel.inl"

}
}

#endif

#endif

---