lib/EditorGraphicBBS/bbsKernelEditorGraphic/GObjectModel.h

   1 /*
   2 # ---------------------------------------------------------------------
   3 #
   4 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   5 #                        pour la Santé)
   6 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
   7 #
   8 #  This software is governed by the CeCILL-B license under French law and
   9 #  abiding by the rules of distribution of free software. You can  use,
  10 #  modify and/ or redistribute the software under the terms of the CeCILL-B
  11 #  license as circulated by CEA, CNRS and INRIA at the following URL
  12 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  13 #  or in the file LICENSE.txt.
  14 #
  15 #  As a counterpart to the access to the source code and  rights to copy,
  16 #  modify and redistribute granted by the license, users are provided only
  17 #  with a limited warranty  and the software's author,  the holder of the
  18 #  economic rights,  and the successive licensors  have only  limited
  19 #  liability.
  20 #
  21 #  The fact that you are presently reading this means that you have had
  22 #  knowledge of the CeCILL-B license and that you accept its terms.
  23 # ------------------------------------------------------------------------
  24 */
  25
  26 /*=========================================================================
  27 Program:   bbtk
  28 Module:    $RCSfile$
  29 Language:  C++
  30 Date:      $Date$
  31 Version:   $Revision$
  32 =========================================================================*/
  33
  34 /* ---------------------------------------------------------------------
  35
  36  * Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
  37  * Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
  38  *
  39  *  This software is governed by the CeCILL-B license under French law and
  40  *  abiding by the rules of distribution of free software. You can  use,
  41  *  modify and/ or redistribute the software under the terms of the CeCILL-B
  42  *  license as circulated by CEA, CNRS and INRIA at the following URL
  43  *  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  44  *  or in the file LICENSE.txt.
  45  *
  46  *  As a counterpart to the access to the source code and  rights to copy,
  47  *  modify and redistribute granted by the license, users are provided only
  48  *  with a limited warranty  and the software's author,  the holder of the
  49  *  economic rights,  and the successive licensors  have only  limited
  50  *  liability.
  51  *
  52  *  The fact that you are presently reading this means that you have had
  53  *  knowledge of the CeCILL-B license and that you accept its terms.
  54  * ------------------------------------------------------------------------ */
  55
  56
  57
  58 /**
  59  *  \file
  60  *  \brief Class bbtk::GObjectModel : abstract black-box interface.
  61  */
  62
  63 /****
  64  * Design and Developpement of BBTK GEditor
  65  * Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
  66  * RaC - 2010
  67  ****/
  68
  69 #ifndef __GObjectModel_h__
  70 #define __GObjectModel_h__
  71
  72 //Includes same project
  73 #include "GlobalConstants.h"
  74 #include "Observable.h"
  75
  76 //Includes creaMaracasVisu
  77
  78 //Includes std
  79 #include <iostream>
  80
  81 //Includes bbtk
  82 #include <bbtkBlackBoxDescriptor.h>
  83
  84 namespace bbtk {
  85
  86     class GObjectModel : public Observable {
  87     public:
  88
  89         //Constructors
  90         GObjectModel( );
  91         ~ GObjectModel( );
  92
  93         //Public methods
  94
  95         // Method to get the values of Inic or Final point passed as references in the parameters
  96         void getInicPoint( double& x, double& y, double& z );
  97         void getFinalPoint( double& x, double& y, double& z );
  98
  99         // Returns the center of the enclosing rectangle
 100         void getCenter( double& x, double& y, double& z );
 101
 102         // Method to set the values of Inic or Final point
 103         virtual void setInicPoint( double& x, double& y, double& z );
 104         virtual void setFinalPoint( double& x, double& y, double& z );
 105
 106         // Changes the inic(top-left point) point of the rectangle
 107         virtual void move( double xx, double yy, double zz );
 108
 109         // Returns true if (x,y,z) is inside the rectangle
 110         virtual bool isPointInside( double x, double y, double z );
 111
 112         // Get the type of the graphical objects (See the GlobalConstants.h file)
 113         int getGObjectType( );
 114         void setGObjectType( int obtype );
 115
 116         // The type in BBTK, for boxes for example in a BBS line like (new LoadHola abcd), LoadHola is the type
 117         std::string getBBTKType( );
 118         void setBBTKType( std::string obtype );
 119
 120         // The name in BBTK, for boxes for example in a BBS line like (new LoadHola abcd), abcd is the name
 121         std::string getBBTKName( );
 122         void setBBTKName( std::string obname );
 123
 124         // The description in BBTK, for boxes
 125         std::string getBBTKDescription( );
 126         void setBBTKDescription( std::string obdescription );
 127
 128
 129         // Object ID
 130         int getObjectId( );
 131         void setObjectId( int id );
 132
 133         // Status bar message
 134         virtual std::string getStatusText( );
 135
 136         virtual void save( std::string &content );
 137
 138     private:
 139
 140         //Private Attributes
 141
 142         //Private Methods
 143
 144     protected:
 145
 146         //Protected Attributes
 147
 148         double _xInic;
 149         double _yInic;
 150         double _zInic;
 151         double _xFin;
 152         double _yFin;
 153         double _zFin;
 154
 155         int _objectId;
 156
 157         // The type of the graphical objects (See the GlobalConstants.h file)
 158         int _gObjectType;
 159
 160         // The type in BBTK, for boxes for example in a BBS line like (new LoadHola abcd), LoadHola is the type
 161         std::string _bbtkType;
 162
 163         // The name in BBTK, for boxes for example in a BBS line like (new LoadHola abcd), abcd is the name
 164         std::string _bbtkName;
 165
 166         // The description in BBTK, for boxes
 167         std::string _bbtkDescription;
 168
 169         //Protected methods
 170
 171     };
 172
 173
 174 }
 175 // namespace bbtk
 176 #endif
 177