Link.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2004 by Olivier Stezowski                               *
 *   stezow(AT)ipnl.in2p3.fr                                                  *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
 
#ifndef Gw_Link
#define Gw_Link
#define GW_LINK_H Gw_Link

#ifndef ROOT_TBox
#include <TBox.h>
#endif
#ifndef ROOT_TPolyLine
#include <TPolyLine.h>
#endif
#ifndef ROOT_TSeqCollection
#include <TSeqCollection.h>
#endif

#include "GwLogMessage.h"

#ifndef GW_LEVEL_H
#include "Level.h"
#endif

#ifndef GW_MEASURE_H
#include "Measure.h"
#endif

#define MAX_LINK_LABEL 2

namespace Gw {

class Link : public TPolyLine
{
  
public:

  static Color_t GetDefaultColor()                { return fgDefaultColor; } 
  static Float_t GetDefaultLabelSize()            { return fgDefaultLabelSize; }
  static Color_t GetDefaultLabelColor()           { return fgDefaultLabelColor; }
  
  static void SetDefaultColor(Color_t color)      { fgDefaultColor = color; }
  static void SetDefaultLabelSize(Float_t size)   { fgDefaultLabelSize = size; }
  static void SetDefaultLabelColor(Color_t color) { fgDefaultLabelColor = color; }
  
  static void   EnableMove()  { fgMovable = true; }
  static void   DisableMove() { fgMovable = false; }
  static Bool_t IsMovable()   { return fgMovable == true; }

private:
  static Color_t fgDefaultColor;      // default color (black)
  static Bool_t  fgMovable;           // graphically movable
  
  static Color_t fgDefaultLabelColor; // default text color
  static Float_t fgDefaultLabelSize;  // default text size
  
private:

    Double_t fgMinWidth;        
    Double_t fgMaxArrow;        
    Double_t fgProArrow;        
      

    TString fVisLabel;  // To know if a label should be drawn ok not
    TString fPosLabel;  // To know the position of label 0:left; 1:center; 2:right
    
    TLatex  fLabel0;    // Some labels associated with this link  
    TLatex  fLabel1;    // Some labels associated with this link    
    TLatex  fLabel2;    // Some labels associated with this link     
    TBox    fBox1;      // box underlying label2 onto the link
  
protected:
    Int_t fArrowStyle;  //Define arrowStyle : 0 ==> Def value

    mutable LogMessage fLog; 

    Level *fInitial;            // initial level
    Level *fFinal;                  // final level
  
    Bool_t fIsSelected;     // graphically selected 
        Bool_t fIsVisible;      // flag to know whether the link is visible
        Bool_t fIsModified;     // flag to know whether the link has been modified

    static const Short_t fgkMaxLinkLabel; // max number of labels

protected:
    Measure<Float_t> fStrength; // strength that binds the two levels
    Measure<Float_t> fTau;          // characteritic time to ge from one level to the other one


    Bool_t fIsAmbiguous;     //Flag to know if a link is validated or ambiguous

public:
    Link();
    Link(const Link &);
    Link& operator=(const Link &);
    virtual ~Link();
    
    virtual Int_t GetArrowStyle() {return fArrowStyle;}
    virtual void SetArrowStyle(Int_t style) {fArrowStyle = style; SetPoints(GetX()[0]+(GetX()[2]-(GetX()[0]))/2.,GetX()[5]);} //*MENU*
    virtual void SetVertical(){SetPoints((GetX()[5]+GetX()[1])/2.,(GetX()[5]+GetX()[1])/2.);} //*MENU*
    virtual void SetAmbiguous(Bool_t isambiguous = true); //*MENU*
    virtual Bool_t IsAmbiguous(){return fIsAmbiguous;}
    virtual void RefreshPoints() {SetPoints(GetX()[0]+(GetX()[2]-(GetX()[0]))/2.,GetX()[5]);}

    virtual void SetPoints(); 
    virtual void SetPoints(Double_t xi, Double_t xf);
    virtual void SetBasicStylePoints(Double_t xi, Double_t xf);
    virtual void SetAdvancedStylePoints(Double_t xi, Double_t xf);
  
    virtual void UpdatePoints();
  
    virtual Measure<Float_t> & GetTau() { return fTau; }
    virtual Measure<Float_t> & GetStrength() { return fStrength; }
    
    virtual Level * SetFL(Level *final) { Level *tmp = fFinal; fFinal = final; return tmp; }
    virtual Level * SetIL(Level *initial) { Level *tmp = fInitial; fInitial = initial; return tmp; }
    virtual Level * GetIL() { return fInitial; }  
    virtual Level * GetFL() { return fFinal; }
  
        virtual Level * GetIL() const { return fInitial; }  
        virtual Level * GetFL() const { return fFinal; }  
    

    virtual Int_t DoCascade(TSeqCollection &/*col*/, Option_t */*opt*/ = "")
    {
        return 0;
    }

    virtual void ExecuteEvent(Int_t event, Int_t px, Int_t py);
  
    

    virtual void SetVisLabel(const char *); //*MENU*
    
    virtual void SetLabels(const char *l0, const char *l1, const char *l2) ; // *MENU* *ARGS={l0=>fLabel0,l1=>fLabel1,l2=>fLabel2}
    
    virtual void SetLabelsSize(Float_t size);
    
    virtual void SetLabelsColor(Color_t color);
    
    
    virtual const char * GetVisLabel() { return fVisLabel.Data(); }
    
    virtual TLatex& GetLabel(Int_t);
    
    virtual const char* GetLabel0() { return fLabel0.GetTitle(); }   
    virtual const char* GetLabel1() { return fLabel1.GetTitle(); }   
    virtual const char* GetLabel2() { return fLabel2.GetTitle(); }   
    
    virtual void SetLabel(const char *, Int_t);
    
    virtual void SetDefaultLabels();
  
    virtual void Selected() {fIsSelected = true;}
    
    virtual void DeSelected() {fIsSelected = false;}
  
    virtual Bool_t IsSelected() {return fIsSelected;}
   
    virtual void SetVisible() {fIsVisible = true;}
    
    virtual void SetUnvisible() {fIsVisible = false;}
    
        virtual Bool_t IsVisible() {return fIsVisible;}
        
        virtual void SetModified() {fIsModified = true;}
        
        virtual void SetUnmdified() {fIsModified = false;}
        
        virtual Bool_t IsModified() {return fIsModified;}
  
    virtual void Draw(Option_t* option = "");
    virtual void Paint(Option_t* option = "");

    virtual void ls(Option_t* /*option*/ = "") const { return; }      

    void Delete(const Option_t* /*opt*/ = "") { return; }
  
        Bool_t IsSortable() const { return kTRUE; }
        
        virtual Int_t Compare(const TObject* obj) const;
  
    ClassDef(Link,5); // a Link binds two levels
};
// inline members
}

#endif