Cylinder3.hpp

Go to the documentation of this file.

// This code is based on Jet framework.
// Copyright (c) 2018 Doyub Kim
// CubbyFlow is voxel-based fluid simulation engine for computer games.
// Copyright (c) 2020 CubbyFlow Team
// Core Part: Chris Ohk, Junwoo Hwang, Jihong Sin, Seungwoo Yoo
// AI Part: Dongheon Cho, Minseo Kim
// We are making my contributions/submissions to this project solely in our
// personal capacity and are not conveying any rights to any intellectual
// property of any third parties.

#ifndef CUBBYFLOW_CYLINDER3_HPP
#define CUBBYFLOW_CYLINDER3_HPP

#include <Core/Geometry/Surface.hpp>

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

    Cylinder3(const Transform3& _transform = Transform3{},
              bool _isNormalFlipped = false);

    Cylinder3(Vector3D _center, double _radius, double _height,
              const Transform3& _transform = Transform3{},
              bool _isNormalFlipped = false);

    Cylinder3(const Cylinder3&) = default;

    Cylinder3(Cylinder3&&) noexcept = default;

    ~Cylinder3() override = default;

    Cylinder3& operator=(const Cylinder3&) = default;

    Cylinder3& operator=(Cylinder3&&) noexcept = default;

    [[nodiscard]] static Builder GetBuilder();

    Vector3D center;

    double radius = 1.0;

    double height = 1.0;

 protected:
    [[nodiscard]] Vector3D ClosestPointLocal(
        const Vector3D& otherPoint) const override;

    [[nodiscard]] double ClosestDistanceLocal(
        const Vector3D& otherPoint) const override;

    [[nodiscard]] bool IntersectsLocal(const Ray3D& ray) const override;

    [[nodiscard]] BoundingBox3D BoundingBoxLocal() const override;

    [[nodiscard]] Vector3D ClosestNormalLocal(
        const Vector3D& otherPoint) const override;

    [[nodiscard]] SurfaceRayIntersection3 ClosestIntersectionLocal(
        const Ray3D& ray) const override;
};

using Cylinder3Ptr = std::shared_ptr<Cylinder3>;

class Cylinder3::Builder final : public SurfaceBuilderBase3<Builder>
{
 public:
    [[nodiscard]] Builder& WithCenter(const Vector3D& _center);

    [[nodiscard]] Builder& WithRadius(double _radius);

    [[nodiscard]] Builder& WithHeight(double _height);

    [[nodiscard]] Cylinder3 Build() const;

    [[nodiscard]] Cylinder3Ptr MakeShared() const;

 private:
    Vector3D m_center{ 0, 0, 0 };
    double m_radius = 1.0;
    double m_height = 1.0;
};
}  // namespace CubbyFlow

#endif