Plane3.h

Go to the documentation of this file.

/*************************************************************************
> File Name: Plane3.h
> Project Name: CubbyFlow
> Author: Chan-Ho Chris Ohk
> Purpose: 3-D plane geometry.
> Created Time: 2017/06/18
> Copyright (c) 2018, Chan-Ho Chris Ohk
*************************************************************************/
#ifndef CUBBYFLOW_PLANE3_H
#define CUBBYFLOW_PLANE3_H

#include <Core/Surface/Surface3.h>

namespace CubbyFlow
{
    class Plane3 final : public Surface3
    {
    public:
        class Builder;

        Vector3D normal = Vector3D(0, 1, 0);

        Vector3D point;

        Plane3(const Transform3& transform = Transform3(), bool isNormalFlipped = false);

        Plane3(const Vector3D& normal, const Vector3D& point,
            const Transform3& transform = Transform3(), bool isNormalFlipped = false);

        Plane3(const Vector3D& point0, const Vector3D& point1, const Vector3D& point2,
            const Transform3& transform = Transform3(), bool isNormalFlipped = false);

        Plane3(const Plane3& other);

        static Builder GetBuilder();

    protected:
        Vector3D ClosestPointLocal(const Vector3D& otherPoint) const override;

        bool IntersectsLocal(const Ray3D& ray) const override;

        BoundingBox3D BoundingBoxLocal() const override;

        Vector3D ClosestNormalLocal(const Vector3D& otherPoint) const override;

        SurfaceRayIntersection3 ClosestIntersectionLocal(const Ray3D& ray) const override;
    };

    using Plane3Ptr = std::shared_ptr<Plane3>;
    
    class Plane3::Builder final : public SurfaceBuilderBase3<Plane3::Builder>
    {
    public:
        Builder& WithNormal(const Vector3D& normal);

        Builder& WithPoint(const Vector3D& point);

        Plane3 Build() const;

        Plane3Ptr MakeShared() const;

    private:
        Vector3D m_normal{ 0, 1, 0 };
        Vector3D m_point{ 0, 0, 0 };
    };
}

#endif