IView.hpp

#pragma once
 
#include <opals/IModuleBase.hpp>
#include <opals/Path.hpp>
#include <opals/Vector.hpp>
 
#if defined(_MSC_VER) && !defined(OPALS_NO_AUTOLINK)
  #if defined _DEBUG && !defined OPALS_NO_DEBUG
    #pragma comment(lib, "opalsView_d.lib")
  #else
    #pragma comment(lib, "opalsView.lib")
  #endif
#endif
 
namespace opals
{
 
  namespace opts
  {
    /// Options of \ref ModuleView
    namespace View
    {
      /// Options of \ref ModuleView
      using Options =
        IGroup< Names::_,
          IValue< Names::inFile, false, Vector<Path>  >,
          IValue< Names::filter, false, String  >
        >;
    }
  }
 
  /// Provides an interactive 3d viewer for points (including arbitrary attributes) and lines.
  /** TODO: 
      More details on opalsView with much more words,
      possibly on several lines. */
  /// \see \ref ModuleView
  class OPALS_API IView : virtual public IModuleBase
  {
 
  public:
    static IView* New();
    static IView* New( IControlObject &controlObject );
    static IView* New( const IModuleBase &parent );
    static IView* New( const IModuleBase &parent, IControlObject &controlObject );
 
    virtual ~IView() {}
 
    /// \name Access to module-specific options.
    ///@{
    using Options = opts::View::Options;
          Options& opts()       override = 0;
    const Options& opts() const override = 0;
    ///@}
 
  };
 
}