ISegmentManager.hpp

#ifndef OPALS_ISEGMENTMANAGER_HPP_INCLUDED
#define OPALS_ISEGMENTMANAGER_HPP_INCLUDED

#include "DM/IPoint.hpp"
#include "DM/IBox.hpp"
#include "DM/IPolyline.hpp"
#include "opals/Vector.hpp"
#include "opals/SegmentationMethod.hpp"
#include "opals/ObjectBase.hpp"

#ifdef _MSC_VER
  #pragma once
#endif


namespace opals
{
  /** \brief  Segment interface

    A segment objects provides an objects representation of the segments that have been created by ModuleSegmentation. Plane parameters and plane moments 
    are only available if the plane extraction mode was applied. Alpha shape objects additionally required the alphaRadius parameter being set.

    \author MPOECHTR, JO
    \date   29.01.2019
  */
  class ISegment
  {                                                                                                                                                                                                                                   
  public:
    /// returns id of segment
    virtual unsigned getID() const = 0;

    /// number of points that have been assigned to segment
    virtual size_t sizePoints() const = 0;
    /// get point id at index position of the point vector
    virtual int64_t getPoint(int64_t index) const = 0;
    /// get point id vector of segment
    virtual opals::Vector<int64_t> getPoints() const = 0;

    /// get center of gravity of segment points
    virtual const DM::PointHandle & getCoG() const = 0;
    /// get bounding box of segment points
    virtual const DM::BoxHandle & getBBox() const = 0;
    
    /// get plane parameters (a,b,c,d and sigma0) of the extracted plane (in plane extraction mode only. plane equation: a*x + b*y + c*z + d == 0) 
    virtual const opals::Vector<double> & getPlaneParams() const = 0;
    /// get plane moments (Mxx, Myy, Mzz, Mxy, Mxz, Myz) of the extracted plane (in plane extraction mode only)
    virtual const opals::Vector<double> & getPlaneMoments() const = 0;
    
    /// get alpha shape of segment (only available in plane extraction mode and set alpha radius)
    virtual const DM::PolylineHandle & getAlphaShape() const = 0;
  };


  /** \brief  Segment manager interface

    A segment manager objects stored all segments that have been created by an ModuleSegmentation run.

    \author MPOECHTR, JO
    \date   29.01.2019
  */
  class ISegmentManager : public ObjectBase
  {
  public:
    /// get number of segments
    virtual int64_t sizeSegments() const = 0;
    
    /// \brief get vector of all segments. 
    /// the lifetime of the segments is attached to the manager. Hence, if the ISegmentManager is deleted, the segment objects are deleted too
    virtual opals::Vector<opals::ISegment*> getSegments() const = 0;
    
    /// get a segement by ids id
    virtual opals::ISegment* getSegment(unsigned seg_id) const = 0;
  };
}

#endif