constraint.h

/********************************************************************
 * Copyright (C) 2015 Liangliang Nan <liangliang.nan@gmail.com>
 * https://3d.bk.tudelft.nl/liangliang/
 *
 * This file is part of Easy3D. If it is useful in your research/work,
 * I would be grateful if you show your appreciation by citing it:
 * ------------------------------------------------------------------
 *      Liangliang Nan.
 *      Easy3D: a lightweight, easy-to-use, and efficient C++ library
 *      for processing and rendering 3D data.
 *      Journal of Open Source Software, 6(64), 3255, 2021.
 * ------------------------------------------------------------------
 *
 * Easy3D is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License Version 3
 * as published by the Free Software Foundation.
 *
 * Easy3D 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 EASY3D_RENDERER_CONSTRAINT_H
#define EASY3D_RENDERER_CONSTRAINT_H
 
#include <easy3d/core/types.h>
 
 
namespace easy3d {
 
 
    class Frame;
    class Camera;
 
    class Constraint
    {
    public:
        virtual ~Constraint() = default;
 
        virtual void constrainTranslation(vec3 &translation, Frame *const frame) {
            (void)translation;
            (void)frame;
        }
        virtual void constrainRotation(quat &rotation, Frame *const frame) {
            (void)(rotation);
            (void)(frame);
        }
    };
 
    class AxisPlaneConstraint : public Constraint {
    public:
        AxisPlaneConstraint();
        ~AxisPlaneConstraint() override = default;
 
        enum Type { FREE, AXIS, PLANE, FORBIDDEN };
 
        void constrainTranslation(vec3 &translation, Frame *const frame) override {
            (void)(translation);
            (void)(frame);
        }
 
        void setTranslationConstraint(Type type, const vec3 &direction);
        void setTranslationConstraintType(Type type) {
            translationConstraintType_ = type;
        };
        void setTranslationConstraintDirection(const vec3 &direction);
 
        Type translationConstraintType() const { return translationConstraintType_; };
        vec3 translationConstraintDirection() const {
            return translationConstraintDir_;
        };
 
        void constrainRotation(quat &rotation, Frame *const frame) override {
            (void)(rotation);
            (void)(frame);
        }
 
        void setRotationConstraint(Type type, const vec3 &direction);
        void setRotationConstraintType(Type type);
        void setRotationConstraintDirection(const vec3 &direction);
 
        Type rotationConstraintType() const { return rotationConstraintType_; };
        vec3 rotationConstraintDirection() const { return rotationConstraintDir_; };
 
    private:
        // int and not Type to allow for overloading and new types definition.
        Type translationConstraintType_;
        Type rotationConstraintType_;
 
        vec3 translationConstraintDir_;
        vec3 rotationConstraintDir_;
    };
 
    class LocalConstraint : public AxisPlaneConstraint {
    public:
        ~LocalConstraint() override = default;
 
        void constrainTranslation(vec3 &translation, Frame *const frame) override;
        void constrainRotation(quat &rotation, Frame *const frame) override;
    };
 
    class WorldConstraint : public AxisPlaneConstraint {
    public:
        ~WorldConstraint() override = default;
 
        void constrainTranslation(vec3 &translation, Frame *const frame) override;
        void constrainRotation(quat &rotation, Frame *const frame) override;
    };
 
    class CameraConstraint : public AxisPlaneConstraint {
    public:
        explicit CameraConstraint(const Camera *const camera);
        ~CameraConstraint() override = default;
 
        void constrainTranslation(vec3 &translation, Frame *const frame) override;
        void constrainRotation(quat &rotation, Frame *const frame) override;
 
        const Camera *camera() const { return camera_; };
 
    private:
        const Camera *const camera_;
    };
 
 
}
 
#endif // EASY3D_RENDERER_CONSTRAINT_H