RSolidTesselation.hh

Go to the documentation of this file.

//======================================================================
/*! \file RSolidTesselation.hh
 *
 *  Include file for the class RSolidTesselation, and the
 *  related classes RTesselationPoint and RTesselationSegment.
 */
//======================================================================

#ifndef R_SOLID_TESSELATION_HH
#define R_SOLID_TESSELATION_HH

//======================================================================

// GRootTools includes
#include "RBaseFunctions.hh"
#include "RStringFunctions.hh"

// ROOT includes
#include <TVector3.h>
#include <TPolyMarker3D.h>
#include <TPolyLine3D.h>
#include <TList.h>
#include <TMath.h>

class RSolidTesselation;
class RSphereTesselation;

//======================================================================
/*! \class RTesselationPoint
 *
 *  This class defines the information associated to a point in the
 *  tesselation of solids:
 *  - the point position
 *  - the indexes of related neighbours
 */
class RTesselationPoint
{
  //------------------------------------------------------------
  /*! \object_doc{RTesselationPoint} */
  GObject(RTesselationPoint);
  //------------------------------------------------------------

  friend class RSolidTesselation;

  protected:
    TVector3    position;       ///< Position of the point

    int         neighbour_num;    ///< Number of neighbouring points
    int       * neighbour_tab;    ///< Array of index of neighbouring points

  public:

  //------------------------------------------------------------
  /** @name Constructors, affectation, destructor */
  //@{
    RTesselationPoint ( );
    RTesselationPoint ( const RTesselationPoint & original );
    RTesselationPoint & operator = ( const RTesselationPoint & original );
    virtual ~RTesselationPoint ( );

  //@}

  //------------------------------------------------------------
  /** @name Data setting */
  //@{
    virtual void ResetData ( );
    virtual void CopyData  ( const RTesselationPoint & original );

    void  SetPosition      ( const TVector3 & p );    // inline
    void  SetNeighboursNum ( int n );                 // inline
    void  SetNeighbour     ( int i, int ip );         // inline
  //@}

  //------------------------------------------------------------
  /** @name Points information */
  //@{
    const TVector3 & GetPosition ( ) const;  // inline
          TVector3 & GetPosition ( );        // inline
    double           GetX ( )        const;  // inline
    double           GetY ( )        const;  // inline
    double           GetZ ( )        const;  // inline
    double           GetTheta ( bool deg = false ) const;
    double           GetPhi   ( bool deg = false ) const;

    int   GetNeighbourNum   ( ) const;          // inline
    int   GetNeighbourIndex ( int i ) const;    // inline
    const int * GetNeighbourTab ( ) const;      // inline
          int * GetNeighbourTab ( );            // inline
  //@}

  //------------------------------------------------------------
  /** @name ROOT related functions */
  //@{
  /*! For ROOT dictionary.*/
  ClassDef(RTesselationPoint,0);
  //@}
};


//======================================================================
/*! \class RTesselationSegment
 *
 *  This class defines the information associated to a point in the
 *  tesselation of solids:
 *  - the point position
 *  - the angles theta and phi (for convenience)
 *  - the indexes of related neighbours
 */
class RTesselationSegment
{
  //------------------------------------------------------------
  /*! \object_doc{RTesselationSegment} */
  GObject(RTesselationSegment);
  //------------------------------------------------------------

  friend class RSolidTesselation;

  protected:
    int       pt_index[2];    ///< Indexes of segment points

  public:

  //------------------------------------------------------------
  /** @name Constructors, affectation, destructor */
  //@{
    RTesselationSegment ( );
    RTesselationSegment ( const RTesselationSegment & original );
    RTesselationSegment & operator = ( const RTesselationSegment & original );
    virtual ~RTesselationSegment ( );

  //@}

  //------------------------------------------------------------
  /** @name Segment data */
  //@{
    void  SetPindex ( int i0, int i1 );   // inline
    int   GetPindex ( int ip ) const; // inline
    int   GetP0     ( ) const;        // inline
    int   GetP1     ( ) const;        // inline
  //@}

  //------------------------------------------------------------
  /** @name ROOT related functions */
  //@{
  /*! For ROOT dictionary.*/
  ClassDef(RTesselationSegment,0);
  //@}
};


//======================================================================
/*! \class RSolidTesselation
 *
 *  Base class for representation of a volume by a set of points
 *  that are summits of base triangles.
 *
 *  This is an abstract class, and the derived class must provide
 *  an initialization function (InitData) that properly defines
 *  the points for a closed volume.
 */
class RSolidTesselation
{
  //------------------------------------------------------------
  /*! \object_doc{RSolidTesselation} */
  GObjectV(RSolidTesselation);
  //------------------------------------------------------------

  protected:
    u_short subdiv;   ///< Number of subdivisions since initial creation 
    u_int   npts;     ///< Number of points
    u_int   nseg;     ///< Number of segments

    RTesselationPoint   * tab_pts;    ///< Array of points
    RTesselationSegment * tab_seg;    ///< Array of segments

  public:

  //------------------------------------------------------------
  /** @name Constructors, affectation, destructor */
  //@{
    RSolidTesselation ( );
    virtual ~RSolidTesselation ( );
  //@}

  //------------------------------------------------------------
  /** @name Tesselation data */
  //@{
    virtual void  ResetData ( );

    /*! Function setting the initial points before division.*/
    virtual void  InitData  ( ) = 0;

    /*! Function sub-dividing the current discretization of the volume.
     *  The function should return the new number of points.
     */
    virtual int     SubDivide   ( ) = 0;
    virtual u_short GetDivision ( ) const;    // inline

    int   GetNpoints   ( ) const;   // inline
    int   GetNsegments ( ) const;   // inline

    const RTesselationPoint   & GetPoint   ( int ip ) const;    // inline
    const RTesselationSegment & GetSegment ( int is ) const;    // inline
  //@}

  //------------------------------------------------------------
  /** @name ROOT related functions */
  //@{
  TPolyMarker3D * CreatePoints3D  ( ) const;
  TPolyLine3D   * CreateSegment3D ( int is ) const;
  TList         * CreateLines3D   ( const TAttLine latt = TAttLine(kRed+1,2,1 ) ) const;

  /*! For ROOT dictionary.*/
  ClassDef(RSolidTesselation,0);
  //@}
};

//----------------------------------------------------------------------
//  Inline functions
#include "icc/RSolidTesselation.icc"


//======================================================================

#endif