Window.h

Go to the documentation of this file.

/* This software and supporting documentation are distributed by
 *     Institut Federatif de Recherche 49
 *     CEA/NeuroSpin, Batiment 145,
 *     91191 Gif-sur-Yvette cedex
 *     France
 *
 * This software is governed by the CeCILL-B license under
 * French law and abiding by the rules of distribution of free software.
 * You can  use, modify and/or redistribute the software under the
 * terms of the CeCILL-B license as circulated by CEA, CNRS
 * and INRIA at the following URL "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and  rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty  and the software's author,  the holder of the
 * economic rights,  and the successive licensors  have only  limited
 * liability.
 *
 * In this respect, the user's attention is drawn to the risks associated
 * with loading,  using,  modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean  that it is complicated to manipulate,  and  that  also
 * therefore means  that it is reserved for developers  and  experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systems and/or
 * data to be ensured and,  more generally, to use and operate it in the
 * same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-B license and that you accept its terms.
 */


#ifndef ANA_WINDOW_WINDOW_H
#define ANA_WINDOW_WINDOW_H

//--- header files ------------------------------------------------------------

#include <anatomist/observer/Observer.h>
#include <anatomist/config/anatomist_config.h>
#include <aims/vector/vector.h>
#include <aims/rgb/rgb.h>
#include <cartobase/object/object.h>
#include <cartobase/smart/sharedptr.h>


namespace anatomist
{

  class AObject;
  class Referential;
  class Geometry;

  class ANATOMIST_API AWindow : virtual public carto::SharedObject, virtual public Observer
  {
  public:
    enum Type
      {
        CTRL_WINDOW = 100,
        WINDOW_2D = 101,
        WINDOW_3D = 102,
      };

    enum SubType
      {
        AXIAL_WINDOW = 200,
        SAGITTAL_WINDOW = 201,
        CORONAL_WINDOW = 202,
        OBLIQUE_WINDOW = 203,
        OTHER = 299
      };

    enum RecordingState
      {
        OFF,
        ON,
        DISABLED
      };

    virtual ~AWindow();

    void displayTalairach();
    virtual void iconify();
    virtual void unIconify();
    virtual void show();
    virtual void hide();
    virtual bool close() = 0;
    virtual void showToolBars( int state = 2 );
    virtual bool toolBarsVisible() const;
    virtual void setFullScreen( int state = 2 );
    virtual bool isFullScreen() const;
    virtual void setGeometry( int x, int y, unsigned w, unsigned h ) = 0;
    virtual void geometry( int *x, int *y, unsigned *w, unsigned *h ) = 0;
    virtual void Refresh();
    virtual void showReferential();
    virtual void setupWindow() {}

    virtual std::string Title() const;
    //virtual const char* Title_c() const;
    virtual void registerObject( AObject* object,
                                 bool temporaryObject = false,
                                 int position = -1 );
    virtual void unregisterObject( AObject* object );

    void setId(int id);
    void SetRefreshFlag();
    void ResetRefreshFlag();
    bool lookupChanged() const { return( _lookupChanged ); }
    void setLookupChanged( bool flg = true )
    { _lookupChanged = flg; if( flg ) SetRefreshFlag(); }
    int id() const;
    virtual Type type() const = 0;
    virtual SubType subtype() const { return( (SubType) 0 ); }
    bool RefreshFlag() const;
    std::set<AObject*> Objects() const;
    bool hasObject( AObject * obj ) const;
    virtual Point3df getPosition() const;
    float getTime() const;
    virtual std::vector<float> getFullPosition() const;
    virtual void setPosition( const Point3df& position ,
                              const Referential *refdep );
    virtual void setPosition( const std::vector<float> & position,
                              const Referential *refdep = 0 );
    virtual void setTime( float time );
    virtual void setTitle( const std::string & title );
    Referential* getReferential() const { return _referential; }
    virtual void setReferential( Referential* ref );
    Geometry* windowGeometry() const { return _geometry; }
    void setWindowGeometry( Geometry *geom );
    virtual void updateWindowGeometry() {}
    int Group() const { return _group; }
    void setGroup( int group ) { _group = group; }
    void setHasCursor( int hasCursor );
    bool hasCursor() const;
    int hasSelfCursor() const;

    static void setLeftRightDisplay(bool state)
    {
      _leftRightDisplay = state;
    }
    static int leftRightDisplay()
    {
      return _leftRightDisplay;
    }
    static void setLeftRightDisplaySize(int size)
    {
      _leftRightDisplaySize = size;
    }
    static int leftRightDisplaySize()
    {
      return _leftRightDisplaySize;
    }
    static void setDisplayedAnnotations(
      const std::vector<std::string> & annotation_list)
    {
      _displayedAnnotations = annotation_list;
    }
    static std::vector<std::string> displayedAnnotations()
    {
      return _displayedAnnotations;
    }
    static void setGlobalHasCursor(bool hasCursor) { _hasCursor = hasCursor; }
    static int hasGlobalCursor() { return( _hasCursor ); }
    static void setCursorSize(int cursorSize) { _cursorSize = cursorSize; }
    static int cursorSize() { return(_cursorSize); }
    static void setUseDefaultCursorColor( bool state )
    { _useDefaultCursorColor = state; }
    static int useDefaultCursorColor() { return( _useDefaultCursorColor ); }
    static void setCursorColor( const AimsRGB & cursCol );
    static AimsRGB cursorColor();
    static float selectTolerence() { return( _selectTolerence ); }
    static void setSelectTolerence( float tol ) { _selectTolerence = tol; }
    virtual void displayClickPoint() {}
    virtual bool positionFromCursor( int x, int y, Point3df & pos );
    virtual AObject* objectAt( const std::vector<float> & pos );

    virtual void selectObject( const std::vector<float> & pos,
                               int modifier );
    virtual void button3clicked( int x, int y );
    virtual void findObjectsAt( const std::vector<float> & pos,
                                std::set<AObject *> & shown,
                                std::set<AObject *> & hidden );

    virtual void update( const Observable* observable, void* arg );

    static void recordCbk( void* clientdata );
    virtual void recordImages();
    virtual RecordingState recordingState() const { return( DISABLED ); }
    virtual void startRecord();
    virtual void startRecord( const std::string & filename );
    virtual void stopRecord() {}
    virtual void createTitle() {}

    virtual const std::set<unsigned> & typeCount() const;
    virtual std::set<unsigned> & typeCount();
    virtual const std::string & baseTitle() const;
    virtual bool needsRedraw() const { return( false ); }
    bool isTemporary( AObject* o ) const;
    const std::set<AObject *> & temporaryObjects() const
    { return( _tempObjects ); }

  protected:
    AWindow();

    void setWindowTitle();
    virtual void unregisterObservable( Observable* obs );
    void manageAutoReferential();

    int _id;
    bool _refresh;
    bool _lookupChanged;
    std::list<carto::shared_ptr<AObject> > _objects;
    std::set<AObject *>        _sobjects;
    std::set<AObject *>        _tempObjects;
    std::vector<float> _timepos;
    Referential *_referential;
    Geometry *_geometry;
    std::string _title;
    int _instNumber;
    int _group;
    Point3df _position;

  private:
    struct Private;

    Private        *d;
    AWindow(const AWindow& x);
    AWindow& operator=(const AWindow& x);
    static bool _leftRightDisplay;
    static int _leftRightDisplaySize;
    static std::vector<std::string> _displayedAnnotations;
    static bool _hasCursor;
    static int _cursorSize;
    static bool _useDefaultCursorColor;
    static AimsRGB _cursorColor;
    static float _selectTolerence;
  };


  //--- inline methods --------------------------------------------------------

  inline
  void AWindow::setId( int id )
  {
    _id = id;
  }

  inline
  void AWindow::SetRefreshFlag()
  {
    _refresh = true;
  }

  inline
  void AWindow::ResetRefreshFlag()
  {
    _refresh = false;
  }

  inline
  int AWindow::id() const
  {
    return _id;
  }


  inline
  bool AWindow::RefreshFlag() const
  {
    return _refresh;
  }

  inline
  std::set<AObject*> AWindow::Objects() const
  {
    return _sobjects;
  }

  inline
  float AWindow::getTime() const
  {
    return _timepos[0];
  }

  inline
  std::string AWindow::Title() const
  {
    return( _title );
  }

  /*inline
    const char* AWindow::Title_c() const
    {
    return( _title.c_str() );
    }*/


  inline bool AWindow::positionFromCursor( int, int, Point3df & )
  {
    return( false );
  }


  inline void AWindow::startRecord( const std::string & )
  {
  }

}


namespace carto
{
  DECLARE_GENERIC_OBJECT_TYPE( anatomist::AWindow * )
  DECLARE_GENERIC_OBJECT_TYPE( std::set<anatomist::AWindow *> )
  DECLARE_GENERIC_OBJECT_TYPE( std::vector<anatomist::AWindow *> )
  DECLARE_GENERIC_OBJECT_TYPE( std::list<anatomist::AWindow *> )
}


#endif