anatomist  5.1.2
3D neuroimaging data viewer
clippedobject.h
Go to the documentation of this file.
1 /* This software and supporting documentation are distributed by
2  * Institut Federatif de Recherche 49
3  * CEA/NeuroSpin, Batiment 145,
4  * 91191 Gif-sur-Yvette cedex
5  * France
6  *
7  * This software is governed by the CeCILL-B license under
8  * French law and abiding by the rules of distribution of free software.
9  * You can use, modify and/or redistribute the software under the
10  * terms of the CeCILL-B license as circulated by CEA, CNRS
11  * and INRIA at the following URL "http://www.cecill.info".
12  *
13  * As a counterpart to the access to the source code and rights to copy,
14  * modify and redistribute granted by the license, users are provided only
15  * with a limited warranty and the software's author, the holder of the
16  * economic rights, and the successive licensors have only limited
17  * liability.
18  *
19  * In this respect, the user's attention is drawn to the risks associated
20  * with loading, using, modifying and/or developing or reproducing the
21  * software by the user in light of its specific status of free software,
22  * that may mean that it is complicated to manipulate, and that also
23  * therefore means that it is reserved for developers and experienced
24  * professionals having in-depth computer knowledge. Users are therefore
25  * encouraged to load and test the software's suitability as regards their
26  * requirements in conditions enabling the security of their systems and/or
27  * data to be ensured and, more generally, to use and operate it in the
28  * same conditions as regards security.
29  *
30  * The fact that you are presently reading this means that you have had
31  * knowledge of the CeCILL-B license and that you accept its terms.
32  */
33 
34 
35 #ifndef ANA_OBJECT_CLIPPEDOBJECT_H
36 #define ANA_OBJECT_CLIPPEDOBJECT_H
37 
40 
41 
42 namespace anatomist
43 {
44 
45  class ClippedObject : public ObjectVector, public SelfSliceable
46  {
47  public:
48  ClippedObject( const std::vector<AObject *> & );
49  virtual ~ClippedObject();
50 
51  virtual int MType() const { return( type() ); }
52  static int classType();
53  virtual bool CanRemove( AObject* obj );
54 
55  virtual bool render( PrimList &, const ViewState & );
56  virtual bool Is2DObject() { return( false ); }
57  virtual bool Is3DObject() { return( true ); }
58 
59  virtual Material & GetMaterial();
60  virtual void SetMaterial( const Material & mat );
61  virtual const AObjectPalette* palette() const;
62  virtual AObjectPalette* palette();
63  virtual void setPalette( const AObjectPalette & palette );
64 
65  virtual void update( const Observable *observable, void *arg );
66 
67  virtual Tree* optionTree() const;
68 
69  virtual void sliceChanged();
70  int clipID() const;
72  virtual void setProperties( carto::Object options );
73 
74  private:
76  static int registerClass();
77 
78  struct Private;
79  Private *d;
80  };
81 
83  {
84  return false;
85  }
86 
87 }
88 
89 #endif
90 
Base Anatomist object (abstract)
Definition: Object.h:96
int type() const
Object type identifier.
Definition: Object.h:158
virtual void setProperties(carto::Object options)
Same as setHeaderOptions() and used by it, allows passing a dictionary.
virtual int MType() const
Precise type of multi-object.
Definition: clippedobject.h:51
virtual const AObjectPalette * palette() const
virtual carto::Object makeHeaderOptions() const
get object properties into a generic object, such as material, palette etc before saving the object
virtual bool CanRemove(AObject *obj)
Definition: clippedobject.h:82
ClippedObject(const std::vector< AObject * > &)
virtual bool render(PrimList &, const ViewState &)
rendering (generally 2D or 3D using OpenGL).
virtual Tree * optionTree() const
Menu tree for new options, see object/optionMatcher.h.
virtual void SetMaterial(const Material &mat)
virtual void update(const Observable *observable, void *arg)
This class is an Observer of each of the AObject it groups.
virtual AObjectPalette * palette()
Normally, getOrCreatePalette() should be used instead of this function in most cases.
virtual void sliceChanged()
called when the slice definition has changed
virtual bool Is2DObject()
Can be display in 2D windows.
Definition: clippedobject.h:56
virtual void setPalette(const AObjectPalette &palette)
virtual bool Is3DObject()
Can be display in 3D windows.
Definition: clippedobject.h:57
virtual Material & GetMaterial()
This class has to be rewritten, it's really really a shame.......
Definition: Material.h:48
it's a list, in fact...
Definition: objectVector.h:212
This class can be subclassed to represent an object that the programmer wants to have observed.
Definition: Observable.h:68
Self sliceable objects contain a plane (slice) information: slice position and orientation only depen...
Definition: selfsliceable.h:47
std::list< carto::rc_ptr< GLItem > > PrimList
Definition: Object.h:72
ViewState holds information about how a view wants to see an object.
Definition: viewstate.h:67