Computer Assited Medical Intervention Tool Kit  version 5.0
ActionViewerExtension.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * $CAMITK_LICENCE_BEGIN$
3  *
4  * CamiTK - Computer Assisted Medical Intervention ToolKit
5  * (c) 2001-2021 Univ. Grenoble Alpes, CNRS, Grenoble INP, TIMC, 38000 Grenoble, France
6  *
7  * Visit http://camitk.imag.fr for more information
8  *
9  * This file is part of CamiTK.
10  *
11  * CamiTK is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * CamiTK is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU Lesser General Public License version 3 for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * version 3 along with CamiTK. If not, see <http://www.gnu.org/licenses/>.
22  *
23  * $CAMITK_LICENCE_END$
24  ****************************************************************************/
25 
26 
27 #ifndef ACTIONVIEWEREXTENSION_H
28 #define ACTIONVIEWEREXTENSION_H
29 
30 #include "ActionViewerAPI.h"
31 
32 //-- from CamiTK Core
33 #include <ViewerExtension.h>
34 
42  Q_OBJECT
43  Q_INTERFACES(camitk::ViewerExtension);
44  Q_PLUGIN_METADATA(IID "fr.imag.camitk.sdk.viewer.actionviewerextension")
45 
46 public:
49 
51  virtual ~ActionViewerExtension() = default;
52 
54  virtual QString getName() override {
55  return "Action Viewer Extension";
56  };
57 
59  virtual QString getDescription() override {
60  return "\"Action Viewer\" displays the currently selected action's GUI as well as an action selector";
61  };
62 
64  virtual void init() override;
65 
66 };
67 
68 #endif // ACTIONVIEWEREXTENSION_H
69 
70 
camitk::ViewerExtension::getDescription
virtual QString getDescription()=0
returns the viewer extension small description (to be overriden in the derived class)
registerDefaultViewer
#define registerDefaultViewer(className)
register a new viewer and create a default instance using the name of the class (note that the regula...
Definition: ViewerExtension.h:66
ActionViewerExtension.h
ActionViewer.h
camitk::ViewerExtension::init
virtual void init()=0
this method should just call registerNewViewer(MyViewer) for any MyViewer class you need to register ...
camitk::ViewerExtension::ViewerExtension
ViewerExtension()
constructor
Definition: ViewerExtension.cpp:61
ActionViewerAPI.h
camitk::ViewerExtension::getName
virtual QString getName()=0
returns the viewer extension name (to be overriden in the derived class)
ACTIONVIEWER_API
#define ACTIONVIEWER_API
Definition: ActionViewerAPI.h:54
ViewerExtension.h
ActionViewer
ActionViewer is the viewer used to manage the actions.
Definition: ActionViewer.h:63
ActionViewerExtension::init
virtual void init() override
initialize all the viewers
Definition: ActionViewerExtension.cpp:32
ActionViewerExtension
Manage the ActionViewer viewer, instanciates and register the default "Action Explorer" instance.
Definition: ActionViewerExtension.h:41
camitk::ViewerExtension
This class describes what is a generic Action extension. To add a ActionExtension to CamiTK core,...
Definition: ViewerExtension.h:108