Program Listing for File plane.hxx

↰ Return to documentation for file (src/acme/plane.hxx)

/*
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 *                                                                     *
 * The ACME project                                                    *
 *                                                                     *
 * Copyright (c) 2020, Davide Stocco and Enrico Bertolazzi.            *
 *                                                                     *
 * The ACME project and its components are supplied under the terms of *
 * the open source BSD 2-Clause License. The contents of the ACME      *
 * project and its components may not be copied or disclosed except in *
 * accordance with the terms of the BSD 2-Clause License.              *
 *                                                                     *
 * URL: https://opensource.org/licenses/BSD-2-Clause                   *
 *                                                                     *
 *    Davide Stocco                                                    *
 *    Department of Industrial Engineering                             *
 *    University of Trento                                             *
 *    e-mail: davide.stocco@unitn.it                                   *
 *                                                                     *
 *    Enrico Bertolazzi                                                *
 *    Department of Industrial Engineering                             *
 *    University of Trento                                             *
 *    e-mail: enrico.bertolazzi@unitn.it                               *
 *                                                                     *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*/


#pragma once
#ifndef INCLUDE_ACME_PLANE_HXX
#define INCLUDE_ACME_PLANE_HXX

#include "point.hxx"

namespace acme
{

  /*\
   |         _
   |   _ __ | | __ _ _ __   ___
   |  | '_ \| |/ _` | '_ \ / _ \
   |  | |_) | | (_| | | | |  __/
   |  | .__/|_|\__,_|_| |_|\___|
   |  |_|
  \*/


  class plane : public entity
  {
  private:
    point m_origin = NAN_POINT;
    vec3  m_normal = NAN_VEC3;

  public:
    plane(plane const &) = default;

    plane(plane &&) = default;

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

    plane & operator=(plane &&) = default;

    ~plane(void) override = default;

    plane(void);

    plane(
      real origin_x,
      real origin_y,
      real origin_z,
      real normal_x,
      real normal_y,
      real normal_z
    );

    plane(
      point const & origin,
      vec3  const & normal
    );

    bool
    isApprox(
      plane const & plane_in,
      real          tolerance = EPSILON
    ) const;

    point const &
    origin(void)
    const;

    point &
    origin(void);

    vec3 const &
    normal(void)
    const;

    vec3 &
    normal(void);

    vec3
    unitNormal(void)
    const;

    void
    normalize(void);

    real
    d(void)
    const;

    real
    distance(
      point const & point_in
    ) const;

    real
    squaredDistance(
      point const & point_in
    ) const;

    real
    signedDistance(
      point const & point_in
    ) const;

    void
    reverse(void);

    void
    translate(
      vec3 const & vector_in
    ) override;

    void
    transform(
      affine const & affine_in
    ) override;

    bool
    isInside(
      point const & point_in,
      real          tolerance = EPSILON
    ) const;

    bool
    isDegenerated(
      real tolerance = EPSILON
    ) const override;

    inline
    integer
    level(void)
      const override
    {
      return integer(5);
    }

    inline
    std::string
    type(void)
      const override
    {
      return "plane";
    }

    inline
    bool
    isNone(void)
      const override
    {
      return false;
    }

    inline
    bool
    isPoint(void)
      const override
    {
      return false;
    }

    inline
    bool
    isLine(void)
      const override
    {
      return false;
    }

    inline
    bool
    isRay(void)
      const override
    {
      return false;
    }

    inline
    bool
    isPlane(void)
      const override
    {
      return true;
    }

    inline
    bool
    isSegment(void)
      const override
    {
      return false;
    }

    inline
    bool
    isTriangle(void)
      const override
    {
      return false;
    }

    inline
    bool
    isDisk(void)
      const override
    {
      return false;
    }

    inline
    bool
    isBall(void)
      const override
    {
      return false;
    }

    inline
    bool
    isClampable(void)
      const override
    {
      return false;
    }

    bool
    isNonClampable(void)
      const override
    {
      return true;
    }

    bool
    clamp(
      vec3 & min,
      vec3 & max
    ) const override;

    bool
    clamp(
      real & min_x,
      real & min_y,
      real & min_z,
      real & max_x,
      real & max_y,
      real & max_z
    ) const override;

  }; // class plane

  static plane const & NAN_PLANE   = * new plane(NAN_POINT, NAN_VEC3);
  static plane       & DUMMY_PLANE = * new plane(NAN_POINT, NAN_VEC3);

} // namespace acme

#endif