animator.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_animator_h
#define neo_animation_animator_h

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

#if NEO_ENABLE_ANIMATION

#include "../core/array.h"
#include "../core/hashtable.h"
#include "animation.h"
#include "blend.h"
#include "sequence.h"

namespace neo {
namespace animation {

class Keyframe;


class Animator
{
    public:

                                                            Animator();


                                                            Animator( const Animator& animator );
    
    virtual                                                ~Animator();


    void                                                    addAnimation( const std::string& name, const AnimationPtr& p_anim );


    AnimationPtr                                            getAnimation( const std::string& name ) const;
    

    inline const core::HashTable< std::string, AnimationPtr >& getAnimations() const;


    void                                                    addSequence( const std::string& name, const Sequence& sequence );
    

    Sequence*                                               getSequence( const std::string& name );
    

    void                                                    setBlendChainDepth( unsigned int depth );


    inline unsigned int                                     getBlendChainDepth() const;
    

    void                                                    playSequence( const std::string& name );
    

    void                                                    pauseSequence();
    

    void                                                    resumeSequence();
    

    void                                                    stopSequence();


    void                                                    playAnimation( unsigned int stage, const std::string& name, bool loop );


    void                                                    pauseAnimation( unsigned int stage );


    void                                                    resumeAnimation( unsigned int stage );


    void                                                    stopAnimation( unsigned int stage );


    virtual void                                            update( float dt );


    virtual void                                            blend();    


    AnimationInstance*                                      getStageAnimation( unsigned int stage );


    float                                                   getStageWeight( unsigned int stage );


    void                                                    setStageWeight( unsigned int stage, float weight );


    float                                                   getStageTimeScale( unsigned int stage );


    void                                                    setStageTimeScale( unsigned int stage, float scale );


    void                                                    setStageTimeScaleAll( float scale );


    std::string                                             getStageAnimationName( unsigned int stage );


    unsigned int                                            getNumActiveStages() const;


    inline const Keyframe*                                  getAnimationChannel( const core::HashString& channel ) const;
    

    bool                                                    isSequencePlaying() const;
    

    Animator&                                               operator = ( const Animator& animator );
    
    private:

    core::HashTable< std::string, AnimationPtr >            _animations;

    core::Array< BlendStage* >                              _blend;

    core::HashTable< std::string, Keyframe* >               _keyframes;

    bool                                                    _dirtyBlend;
    
    core::HashTable< std::string, Sequence >                _sequences;
    
    Sequence*                                               _p_sequence;
    
    bool                                                    _sequencePaused;
    
    bool                                                    _initSequenceAction;
    
    bool                                                    _isSequenceProcess;
};

#include "animator.inl"

}
}

#endif

#endif

---