i_object_3d.h

Go to the documentation of this file.

/* Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2008-05-23
 * Last modified: 2015-04-25
 *
 * License:
 *
 * Description:
 *
 *  Interface for object than can be described in a 3D reference frame
 *  and possibly drawn with some graphics renderer.
 *
 * History:
 *
 */

#ifndef GEOMTOOLS_I_OBJECT_3D_H
#define GEOMTOOLS_I_OBJECT_3D_H 1

#include <string>
#include <iostream>
#include <sstream>
#include <map>

// Third party:
// - Bayeux/datatools:
#include <datatools/ocd_macros.h>
#include <datatools/handle.h>
#include <datatools/i_tree_dump.h>
#include <datatools/i_serializable.h>
#include <datatools/logger.h>

// This project:
#include <geomtools/utils.h>
#include <geomtools/i_wires_3d_rendering.h>

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

namespace geomtools {

  // Forward declaration:
  class box;

  class i_object_3d :
    public datatools::i_serializable,
    public datatools::i_tree_dumpable
  {
  public:

    enum dimensional_type {
      DIMENSIONAL_0 = 0, 
      DIMENSIONAL_1 = 1, 
      DIMENSIONAL_2 = 2, 
      DIMENSIONAL_3 = 3  
    };

    typedef datatools::handle<i_object_3d> handle_type;

    class object_entry
    {
    public:

      object_entry();

      ~object_entry();

      void reset();

      void set_name(const std::string &);

      const std::string & get_name() const;

      void set_type_id(const std::string & type_id_);

      const std::string & get_type_id() const;

      void set_status(uint32_t);

      uint32_t get_status() const;

      const datatools::properties & get_config() const;

      datatools::properties & grab_config();

      bool has_object() const;

      const i_object_3d & get_object() const;

      void set_object(i_object_3d *);

    private:

      std::string           _name_;    
      std::string           _type_id_; 
      uint32_t              _status_;  
      datatools::properties _config_;  
      handle_type           _hobject_; 

    };

    typedef std::map<std::string, object_entry> handle_dict_type;

    virtual int get_dimensional() const = 0;

    virtual std::string get_shape_name() const = 0;

    virtual bool is_valid() const = 0;

    datatools::logger::priority get_logging_priority() const;

    void set_logging_priority(datatools::logger::priority);

    bool has_wires_drawer() const;

    void set_wires_drawer(i_wires_3d_rendering & wires_drawer_);

    void reset_wires_drawer();

    i_wires_3d_rendering & grab_wires_drawer();

    const i_wires_3d_rendering & get_wires_drawer() const;

    double compute_tolerance(double tolerance_) const;

    double compute_angular_tolerance(double angular_tolerance_) const;

    double get_tolerance() const;

    void set_tolerance(double tolerance_);

    double get_angular_tolerance() const;

    void set_angular_tolerance(double tolerance_);

    virtual bool is_composite() const;

    i_object_3d();

    i_object_3d(double tolerance_);

    i_object_3d(double tolerance_, double angular_tolerance_);

    i_object_3d(const i_object_3d &);

    i_object_3d & operator=(const i_object_3d &);

    virtual ~i_object_3d();

    void initialize_simple();

    virtual void initialize(const datatools::properties &, const handle_dict_type * = 0);

    virtual void reset();

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

    static void init_ocd(datatools::object_configuration_description &);

  protected:

    void _set_defaults();

    void _initialize(const datatools::properties &, const handle_dict_type * = 0);

    void _reset();

  private:

    // Parameters:
    datatools::logger::priority _logging_priority_; 
    double _tolerance_;         
    double _angular_tolerance_; 

    // Work:
    i_wires_3d_rendering * _wires_drawer_; 

    // Serialization interface
    DATATOOLS_SERIALIZATION_DECLARATION()

    // Factory stuff :
    DATATOOLS_FACTORY_SYSTEM_REGISTER_INTERFACE(i_object_3d)

  public:

    class i_getter
    {
    public:

      virtual ~i_getter();

      virtual const i_object_3d * get(const std::string & name_,
                                      const datatools::properties & params_) = 0;

      const i_object_3d * get(const std::string & name_);

    };

  };

} // end of namespace geomtools

#define GEOMTOOLS_OBJECT_3D_REGISTRATION_INTERFACE(ModelClassName)      \
  private:                                                              \
  DATATOOLS_FACTORY_SYSTEM_AUTO_REGISTRATION_INTERFACE(::geomtools::i_object_3d,ModelClassName) \
  

#define GEOMTOOLS_OBJECT_3D_REGISTRATION_IMPLEMENT(ModelClassName,ModelClassId) \
  DATATOOLS_FACTORY_SYSTEM_AUTO_REGISTRATION_IMPLEMENTATION(::geomtools::i_object_3d,ModelClassName,ModelClassId) \
  

/*
// Class version:
#include <boost/serialization/version.hpp>
BOOST_CLASS_VERSION(geomtools::i_object_3d, 0)
*/

#endif // GEOMTOOLS_I_OBJECT_3D_H

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