RContour.hh

Go to the documentation of this file.

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

#ifndef R_CONTOUR_HH
#define R_CONTOUR_HH

#include "RContourBase.hh"
#include "GNamed.hh"

#include <TAttLine.h>
#include <TList.h>

#define RCONTOUR_ID     "CONTOUR: "   ///< Contour identifier in file
#define RCONTOUR_NONAME "unnamed "    ///< Default contour name

//======================================================================
/*! \class RContour
 *
 *  This class defines contour via a pointer to contour properties.
 */
class RContour: virtual public GNamed
{
  //------------------------------------------------------------
  /*! \object_doc{RContour} */
  GObject(RContour);
  //------------------------------------------------------------

  public:

    ///< Contour types identifiers
    enum CTypes
      {
        typeGate      =  0,
        typeEllipse   = 10,
        typeCircle    = 11,
        typePolygon   = 20,
        typeUndefined = -1
      };

  protected:
    RContourBase  * contour_ptr;    ///< Pointer to contour properties
    u_int           status_flag;    ///< Status bit pattern

    TList         * object_list;    ///< Pointer to ROOT graphical objects for display
    TAttLine        line_att;       ///< Line attributes for display

  //------------------------------------------------------------
  //  Constructors / affectation / destructor
  public:
    RContour ( const string   & ct_name = RCONTOUR_NONAME );
    RContour ( const string   & ct_name, const RContourBase & ct_base );
    RContour ( const string   & ct_name, RContourBase       * ct_base );
    RContour ( const RContour & ct,      const string &ct_name );
    RContour ( const RContour & ct );

    RContour & operator = ( const RContour     & ct );
    RContour & operator = ( const RContourBase & ct_base );

    virtual ~RContour ( );

  //------------------------------------------------------------
  //  Static contour creation functions

    // functions allocating a new contour
    static  RContour *  NewContourGate    ( const string & ct_name, const Double_t x1, const Double_t x2 );

    static  RContour *  NewContourPolygon ( const string & ct_name, const UInt_t n, const RPoint2D *pts );
    static  RContour *  NewContourPolygon ( const string & ct_name, const UInt_t n, const Double_t x[], const Double_t y[] );

    static  RContour *  NewContourCircle  ( const string & ct_name, const RPoint2D ctr, const Double_t r );
    static  RContour *  NewContourCircle  ( const string & ct_name, const Double_t xc, const Double_t yc, const Double_t r );

    static  RContour *  NewContourEllipse ( const string & ct_name, const Double_t a, const Double_t b );
    static  RContour *  NewContourEllipse ( const string & ct_name, const RPoint2D ctr, const Double_t a, const Double_t b );
    static  RContour *  NewContourEllipse ( const string & ct_name, const Double_t a, const Double_t b, const Double_t angle );
    static  RContour *  NewContourEllipse ( const string & ct_name, const RPoint2D ctr, const Double_t a, const Double_t b, const Double_t angle );
    static  RContour *  NewContourEllipse ( const string & ct_name, const RPoint2D ctr, const RVector2D xa, const RVector2D yb );

    // functions defining a contour (for affectation)
    static  RContour    ContourGate    ( const string & ct_name, const Double_t x1, const Double_t x2 );

    static  RContour    ContourPolygon ( const string & ct_name, const UInt_t n, const RPoint2D *pts );
    static  RContour    ContourPolygon ( const string & ct_name, const UInt_t n, const Double_t x[], const Double_t y[] );

    static  RContour    ContourCircle  ( const string & ct_name, const RPoint2D ctr, const Double_t r );
    static  RContour    ContourCircle  ( const string & ct_name, const Double_t xc, const Double_t yc, const Double_t r );

    static  RContour    ContourEllipse ( const string & ct_name, const Double_t a, const Double_t b );
    static  RContour    ContourEllipse ( const string & ct_name, const RPoint2D ctr, const Double_t a, const Double_t b );
    static  RContour    ContourEllipse ( const string & ct_name, const Double_t a, const Double_t b, const Double_t angle );
    static  RContour    ContourEllipse ( const string & ct_name, const RPoint2D ctr, const Double_t a, const Double_t b, const Double_t angle );
    static  RContour    ContourEllipse ( const string & ct_name, const RPoint2D ctr, const RVector2D xa, const RVector2D yb );

  //------------------------------------------------------------
    virtual u_int GetStatusFlag ( ) const;                            // inline
    virtual u_int GetStatusBits ( u_int flags ) const;                // inline
    virtual void  SetStatusBits ( u_int flags, bool status = true );  // inline

  //------------------------------------------------------------
  // Functions from contour parameters classes
    virtual bool    CheckPoint  ( const RPoint2D &p ) const;  // inline
    virtual bool    CheckValue  ( const Double_t val ) const; // inline
    virtual Int_t   Dimension   ( ) const; // inline
    virtual Int_t   Type        ( ) const; // inline
    virtual string  TypeName    ( ) const; // inline

    virtual void    Rename      ( const string & ct_name ); // inline

  //------------------------------------------------------------
    virtual void      SetFlipAxis ( const bool flip = true ); // inline
    virtual bool      GetFlipAxis ( ) const;                  // inline

    virtual TAttLine  GetLineAtt ( ) const;                   // inline
    virtual void      SetLineAtt ( const TAttLine l_att );
    virtual void      SetLineAtt ( Color_t c, Style_t s = 1, Width_t w = 1 );  // inline
    virtual void      Draw     ( );
    virtual void      DrawCopy ( );

    // objects for display
    virtual void      DeleteObjectList ( );
    virtual void      CreateObjectList ( );
    virtual TList   * GetObjectList ( ) const;
    virtual Int_t     GetObjectNum  ( ) const;
    virtual TObject * GetObject     ( const Int_t n ) const;

    const RContourBase    * ContourBase ( ) const;
          RContourBase    * ContourBase ( );

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

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

    virtual bool Read ( istream &is );
    virtual bool Read ( FILE *fptr );


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

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

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