point_of_interest.h

Go to the documentation of this file.

/* Author(s) :    Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2014-11-21
 * Last modified: 2014-11-24
 *
 * License:
 *
 * Description:
 *
 *   A point of interest in the geometry
 *
 */

#ifndef MCTOOLS_BIASING_POINT_OF_INTEREST_H
#define MCTOOLS_BIASING_POINT_OF_INTEREST_H 1

// Standard library:
#include <string>

// Third party:
// - Bayeux/datatools:
#include <datatools/i_tree_dump.h>
// - Bayeux/geomtools:
#include <geomtools/utils.h>
// #include <geomtools/placement.h>
// #include <geomtools/blur_spot.h>

namespace datatools {
  // Forward declaration:
  class properties;
}

namespace geomtools {
  // Forward declaration:
  class manager;
}

namespace mctools {

  namespace biasing {


    class point_of_interest
      : public datatools::i_tree_dumpable
    {
    public:

      enum attractive_shape_type {
        ATTRACTIVE_SHAPE_INVALID = 0,
        ATTRACTIVE_SHAPE_SPHERE  = 1,
        ATTRACTIVE_SHAPE_DISC    = 2
      };

      point_of_interest();

      void set_name(const std::string &);

      const std::string & get_name() const;

      void set_position(const geomtools::vector_3d &);

      const geomtools::vector_3d & get_position() const;

      geomtools::vector_3d & grab_position();

      void set_orientation(const geomtools::vector_3d &);

      const geomtools::vector_3d & get_orientation() const;

      void set_attractivity(double);

      double get_attractivity() const;

      bool has_attractivity() const;

      bool is_attractive() const;

      bool is_repulsive() const;

      bool is_neutral() const;

      void set_radius(double);

      double get_radius() const;

      bool is_valid() const;

      void invalidate();

      void initialize(const datatools::properties & config_, const geomtools::manager * geomgr_ = 0);

      virtual void tree_dump(std::ostream & out_         = std::clog,
                             const std::string & title_  = "",
                             const std::string & indent_ = "",
                             bool inherit_               = false) const;

      bool hit(const geomtools::vector_3d & source_, const geomtools::vector_3d & direction_) const;

    protected:

      void _set_default();

    private:

      std::string          _name_;         
      // geomtools::placement _placement_; //!< Placement of the spot
      // geomtools::blur_spot _spot_;      //!< Spot
      geomtools::vector_3d _position_;     
      attractive_shape_type _attractive_shape_ = ATTRACTIVE_SHAPE_INVALID;  
      geomtools::vector_3d _orientation_;  
      double               _radius_;       
      double               _attractivity_; 
      bool                 _skip_check_inside_ = false;
      
    };

  } // namespace biasing

} // namespace mctools

#endif // MCTOOLS_BIASING_POINT_OF_INTEREST_H

// Local Variables: --
// mode: c++ --
// c-file-style: "gnu" --
// tab-width: 2 --
// End: --