fvector.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_FVECTOR_H
#define TITANIC_FVECTOR_H

#include "titanic/star_control/fpoint.h"

namespace Titanic {

enum Axis { X_AXIS, Y_AXIS, Z_AXIS };

class FPose;

class FVector {
public:
    float _x, _y, _z;
public:
    FVector() : _x(0), _y(0), _z(0) {}
    FVector(float x, float y, float z) : _x(x), _y(y), _z(z) {}

    void clear() {
        _x = _y = _z = 0.0;
    }

    FVector swapComponents() const;

    FVector crossProduct(const FVector &src) const;

    void rotVectAxisY(float angleDeg);

    bool normalize(float &hyp);

    void normalize() {
        float hyp;
        bool result = normalize(hyp);
        assert(result);
    }

    FVector half(const FVector &v) const;

    FVector getPolarCoord() const;

    float getDistance(const FVector &src) const;

    FVector matProdRowVect(const FPose &pose) const;

    FPose getFrameTransform(const FVector &v);

    FPose formRotXY() const;

    bool operator==(const FVector &src) const {
        return _x == src._x && _y == src._y && _z == src._z;
    }

    bool operator!=(const FVector &src) const {
        return _x != src._x || _y != src._y || _z != src._z;
    }

    FVector operator+(const FVector &delta) const {
        return FVector(_x + delta._x, _y + delta._y, _z + delta._z);
    }

    FVector operator-(const FVector &delta) const {
        return FVector(_x - delta._x, _y - delta._y, _z - delta._z);
    }

    const FVector operator*(float right) const {
        return FVector(_x * right, _y * right, _z * right);
    }

    const FVector operator*(const FVector &right) const {
        return FVector(_x * right._x, _y * right._y, _z * right._z);
    }

    void operator+=(const FVector &delta) {
        _x += delta._x;
        _y += delta._y;
        _z += delta._z;
    }

    void operator-=(const FVector &delta) {
        _x -= delta._x;
        _y -= delta._y;
        _z -= delta._z;
    }

    void operator+=(const FPoint &delta) {
        _x += delta._x;
        _y += delta._y;
    }

    void operator-=(const FPoint &delta) {
        _x -= delta._x;
        _y -= delta._y;
    }

    Common::String toString() const;
};

} // End of namespace Titanic

#endif /* TITANIC_FVECTOR_H */