constraint.h

/****************************************************************************

 Copyright (C) 2002-2013 Gilles Debunne. All rights reserved.

 This file is part of the QGLViewer library version 2.5.2.

 http://www.libqglviewer.com - contact@libqglviewer.com

 This file may be used under the terms of the GNU General Public License 
 versions 2.0 or 3.0 as published by the Free Software Foundation and
 appearing in the LICENSE file included in the packaging of this file.
 In addition, as a special exception, Gilles Debunne gives you certain 
 additional rights, described in the file GPL_EXCEPTION in this package.

 libQGLViewer uses dual licensing. Commercial/proprietary software must
 purchase a libQGLViewer Commercial License.

 This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

*****************************************************************************/

#ifndef QGLVIEWER_CONSTRAINT_H
#define QGLVIEWER_CONSTRAINT_H

#include "vec.h"
#include "quaternion.h"

namespace qglviewer {
class Frame;
class Camera;

class QGLVIEWER_EXPORT Constraint
{
public:
    virtual ~Constraint() {}

    virtual void constrainTranslation(Vec& translation, Frame* const frame) { Q_UNUSED(translation); Q_UNUSED(frame); }
    virtual void constrainRotation(Quaternion& rotation, Frame* const frame) { Q_UNUSED(rotation); Q_UNUSED(frame); }
};

class QGLVIEWER_EXPORT AxisPlaneConstraint : public Constraint
{
public:
    AxisPlaneConstraint();
    virtual ~AxisPlaneConstraint() {}

    enum Type { FREE, AXIS, PLANE, FORBIDDEN };

    virtual void constrainTranslation(Vec& translation, Frame* const frame) { Q_UNUSED(translation); Q_UNUSED(frame); };

    void setTranslationConstraint(Type type, const Vec& direction);
    void setTranslationConstraintType(Type type) { translationConstraintType_ = type; };
    void setTranslationConstraintDirection(const Vec& direction);

    Type translationConstraintType() const { return translationConstraintType_; };
    Vec translationConstraintDirection() const { return translationConstraintDir_; };

    virtual void constrainRotation(Quaternion& rotation, Frame* const frame) { Q_UNUSED(rotation); Q_UNUSED(frame); };

    void setRotationConstraint(Type type, const Vec& direction);
    void setRotationConstraintType(Type type);
    void setRotationConstraintDirection(const Vec& direction);

    Type rotationConstraintType() const { return rotationConstraintType_; };
    Vec rotationConstraintDirection() const { return rotationConstraintDir_; };

private:
    // int and not Type to allow for overloading and new types definition.
    Type translationConstraintType_;
    Type rotationConstraintType_;

    Vec translationConstraintDir_;
    Vec rotationConstraintDir_;
};


class QGLVIEWER_EXPORT LocalConstraint : public AxisPlaneConstraint
{
public:
    virtual ~LocalConstraint() {};

    virtual void constrainTranslation(Vec&     translation, Frame* const frame);
    virtual void constrainRotation   (Quaternion& rotation, Frame* const frame);
};



class QGLVIEWER_EXPORT WorldConstraint : public AxisPlaneConstraint
{
public:
    virtual ~WorldConstraint() {};

    virtual void constrainTranslation(Vec&     translation, Frame* const frame);
    virtual void constrainRotation   (Quaternion& rotation, Frame* const frame);
};



class QGLVIEWER_EXPORT CameraConstraint : public AxisPlaneConstraint
{
public:
    explicit CameraConstraint(const Camera* const camera);
    virtual ~CameraConstraint() {};

    virtual void constrainTranslation(Vec&     translation, Frame* const frame);
    virtual void constrainRotation   (Quaternion& rotation, Frame* const frame);

    const Camera* camera() const { return camera_; };

private:
    const Camera* const camera_;
};

} // namespace qglviewer

#endif // QGLVIEWER_CONSTRAINT_H