SpherePatch3D.h

Go to the documentation of this file.

/**
 *  \file IMP/algebra/SpherePatch3D.h   \brief Simple 3D sphere patch class.
 *
 *  Copyright 2007-2022 IMP Inventors. All rights reserved.
 *
 */

#ifndef IMPALGEBRA_SPHERE_PATCH_3D_H
#define IMPALGEBRA_SPHERE_PATCH_3D_H

#include "Sphere3D.h"
#include "Plane3D.h"
#include "GeometricPrimitiveD.h"
#include <boost/serialization/access.hpp>

IMPALGEBRA_BEGIN_NAMESPACE

//! A sphere patch is defined as all points above the plane and on the sphere.
class IMPALGEBRAEXPORT SpherePatch3D : public GeometricPrimitiveD<3> {
 public:
  SpherePatch3D() {}
  //! Constructor
  /**
      \param[in] sph            the sphere to cut a patch from
      \param[in] crossing_plane the plane that crosses the sphere
  */
  SpherePatch3D(const Sphere3D &sph, const Plane3D &crossing_plane);
  //! Return true if the point is contained in the patch
  /** Note that the point must be on the sphere (this is not necessarily
      checked).
   */
  bool get_contains(const Vector3D &p) const;
  Plane3D get_plane() const { return crossing_plane_; }
  Sphere3D get_sphere() const { return Sphere3D(sph_); }
  IMP_SHOWABLE_INLINE(SpherePatch3D, {
    sph_.show(out);
    crossing_plane_.show(out);
  });
  //! Get a point which is on the boundary of the patch
  Vector3D get_boundary_point() const;

 private:
  Sphere3D sph_;
  Plane3D crossing_plane_;

  friend class boost::serialization::access;

  template<class Archive> void serialize(Archive &ar, const unsigned int) {
    ar & sph_ & crossing_plane_;
  }
};

IMP_AREA_GEOMETRY_METHODS(SpherePatch3D, sphere_patch_3d, IMP_UNUSED(g);
                          IMP_NOT_IMPLEMENTED;
                          , { return get_bounding_box(g.get_sphere()); });

IMPALGEBRA_END_NAMESPACE

#endif /* IMPALGEBRA_SPHERE_PATCH_3D_H */