animation_tracker.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef WORLD_ACTORS_ANIMATIONTRACKER_H
#define WORLD_ACTORS_ANIMATIONTRACKER_H

#include "ultima/ultima8/misc/common_types.h"
#include "ultima/ultima8/misc/point3.h"
#include "ultima/ultima8/world/actors/animation.h"
#include "ultima/ultima8/world/actors/pathfinder.h"

namespace Ultima {
namespace Ultima8 {

class Actor;
class AnimAction;
struct AnimFrame;

class AnimationTracker {
public:
    AnimationTracker();
    ~AnimationTracker();

    bool init(const Actor *actor, Animation::Sequence action, Direction dir,
              const PathfindingState *state = 0);

    void evaluateMaxAnimTravel(int32 &max_endx, int32 &max_endy, Direction dir);

    bool step();

    bool stepFrom(const Point3 &pt);

    void updateState(PathfindingState &state);

    void updateActorFlags();

    Point3 getPosition() const {
        return _curr;
    }

    Point3 getInterpolatedPosition(int fc) const;

    void getSpeed(int32 &dx, int32 &dy, int32 &dz) const;

    uint32 getFrame() const {
        return _shapeFrame;
    }

    const AnimAction *getAnimAction() const {
        return _animAction;
    }

    const AnimFrame *getAnimFrame() const;

    void setTargetedMode(const Point3 &pt);

    bool isDone() const {
        return _done;
    }
    bool isBlocked() const {
        return _blocked;
    }
    bool isUnsupported() const {
        return _unsupported;
    }
    ObjId hitSomething() const {
        return _hitObject;
    }

    bool load(Common::ReadStream *rs, uint32 version);
    void save(Common::WriteStream *ods);

private:
    enum Mode {
        NormalMode = 0,
        TargetMode
    };

    unsigned int getNextFrame(unsigned int frame) const;
    void checkWeaponHit();

    unsigned int _startFrame, _endFrame;
    bool _firstFrame;
    unsigned int _currentFrame;

    ObjId _actor;
    Direction _dir;

    const AnimAction *_animAction;

    // actor state
    Point3 _prev;
    Point3 _curr;
    Point3 _start;
    int32 _targetDx, _targetDy, _targetDz;
    int32 _targetOffGroundLeft;
    bool _firstStep, _flipped;
    uint32 _shapeFrame;

    // status flags
    bool _done;
    bool _blocked;
    bool _unsupported;
    ObjId _hitObject;

    Mode _mode;
};

} // End of namespace Ultima8
} // End of namespace Ultima

#endif