Program Listing for File ball.hxx

Return to documentation for file (src/acme/ball.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_BALL_HXX
#define INCLUDE_ACME_BALL_HXX

#include "aabb.hxx"
#include "point.hxx"

namespace acme
{

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


  class ball : public entity
  {
  private:
    real  m_radius = QUIET_NAN;
    point m_center = NAN_POINT;

  public:
    ball(ball const &) = default;

    ball(ball &&) = default;

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

    ball & operator=(ball &&) = default;

    ~ball(void) override = default;

    ball(void);

    ball(
      real radius,
      real center_x,
      real center_y,
      real center_z
    );

    ball(
      real          radius,
      point const & center
    );

    bool
    isApprox(
      ball const & ball_in,
      real         tolerance = EPSILON
    ) const;

    real const &
    radius(void)
    const;

    real &
    radius(void);

    point const &
    center(void)
    const;

    point &
    center(void);

    real
    area(void)
    const;

    real
    volume(void)
    const;

    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(9);
    }

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

    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 false;
    }

    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 true;
    }

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

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

    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 ball

  static ball const & NAN_BALL   = * new ball(QUIET_NAN, NAN_POINT);
  static ball       & DUMMY_BALL = * new ball(NAN_BALL);

} // namespace acme

#endif