motion_control.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 TITANIC_MOTION_CONTROL_H
#define TITANIC_MOTION_CONTROL_H

#include "titanic/star_control/fmatrix.h"

namespace Titanic {

class CCamera;
class CErrorCode;
class FMatrix;
class FVector;
class SimpleFile;

struct CNavigationInfo {
    double _initialVelocity;
    double _minVelocity;
    double _maxVelocity;
    double _velocity;
    double _acceleration;
    double _rotationX;
    double _rotationY;
    double _rotationZ;
};

class CCallbackHandler {
private:
    CCamera *_owner;
    FVector _vector;
public:
    CCallbackHandler(CCamera *owner, const FVector &v) : _owner(owner), _vector(v) {
    }

    void apply();
};

class CMotionControl {
protected:
    double _currVelocity;
    double _incVelocity;
    double _incAcceleration;
    double _minVelocity;
    double _maxVelocity;
    double _rotationX;
    double _rotationY;
    double _rotationZ;
public:
    int _lockCounter;
    CCallbackHandler *_callback;
public:
    CMotionControl(const CNavigationInfo *src);
    virtual ~CMotionControl();

    virtual void setMotion(const CNavigationInfo *src);
    virtual void getMotion(CNavigationInfo *dest);

    virtual void clear();
    virtual void reset();

    virtual void setCallback(CCallbackHandler *callback);
    virtual void accelerate();

    virtual void deccelerate();

    virtual void fullSpeed();

    virtual void stop();

    virtual void transitionBetweenPosOrients(const FVector &oldPos, const FVector &newPos,
        const FMatrix &oldOrientation, const FMatrix &newOrientation) {}

    virtual void moveTo(const FVector &srcV, const FVector &destV, const FMatrix &orientation) {}

    virtual void transitionBetweenOrientations(const FVector &v1, const FVector &v2, const FVector &v3, const FMatrix &m) {}

    virtual void updatePosition(CErrorCode &errorCode, FVector &pos, FMatrix &orientation) {}

    virtual void load(SimpleFile *file, int version = 0);

    virtual void save(SimpleFile *file, int indent);

    void incLockCount();

    void decLockCount();

    bool isLocked() const { return _lockCounter > 0; }
};

} // End of namespace Titanic

#endif /* TITANIC_MOTION_CONTROL_H */