RContourBaseCircle.hh

Go to the documentation of this file.

//======================================================================
/*! \file RContourBaseCircle.hh
 *
 *  Include file for class RContourBaseCircle
 */
//======================================================================

#ifndef R_CONTOUR_BASE_CIRCLE_HH
#define R_CONTOUR_BASE_CIRCLE_HH

#include "RContourBase2D.hh"
#include "RContour.hh"

//======================================================================
/*! \class RContourBaseCircle
 *
 *  Class for circle contour parameters.
 */

class RContourBaseCircle : public RContourBase2D
{
  //------------------------------------------------------------
  /*! \object_doc{RContourBaseCircle} */
  GObject(RContourBaseCircle);
  //------------------------------------------------------------

  protected:
    RPoint2D  center;   ///< Circle center
    Double_t  radius;   ///< Circle radius

  //------------------------------------------------------------
  //  Constructors / affectation / destructor
  public:

    RContourBaseCircle ( const Double_t r = 1. );
    RContourBaseCircle ( const RPoint2D ctr, const Double_t r );
    RContourBaseCircle ( const Double_t xc, const Double_t yc, const Double_t r );
    RContourBaseCircle ( const RContourBaseCircle & ct );

    RContourBaseCircle & operator = ( const RContourBaseCircle & ct );

    virtual ~RContourBaseCircle ( );

  //------------------------------------------------------------
    // contour comparison
    virtual bool    Compare ( const RContourBase * ct_ptr ) const;

    // creation of associated ROOT objects list
    virtual TList * CreateObjectList ( ) const;

  //------------------------------------------------------------
  // Read / write functions

    virtual bool WriteData ( ostream &os ) const;
    virtual bool WriteData ( FILE *fptr ) const;

    static RContourBaseCircle * ReadNew ( istream &is );
    static RContourBaseCircle * ReadNew ( FILE *fptr );

  //------------------------------------------------------------
    virtual bool    CheckPoint  ( const Double_t x, const Double_t y ) const;
    virtual bool    CheckPoint  ( const RPoint2D &p ) const;
    virtual Int_t   Type        ( ) const;
    virtual string  TypeName    ( ) const;

    // Retourne une distance normalisée entre le centre et un point
    // (0 au centre, 1 sur le cercle, ...)
    virtual Double_t  NormalisedDistance ( const RPoint2D &p ) const;

    virtual Double_t  GetRadius ( ) const;
    virtual RPoint2D  GetCenter ( ) const;

    virtual void      SetCenter ( const RPoint2D ctr );
    virtual void      SetRadius ( const Double_t r );

  public:
  //------------------------------------------------------------
  /*! For ROOT dictionary.*/
    ClassDef(RContourBaseCircle,0);
};

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

//======================================================================
#endif