Fraxinus  17.12
An IGT application
cxViewportListener.h
Go to the documentation of this file.
1 /*=========================================================================
2 This file is part of CustusX, an Image Guided Therapy Application.
3 
4 Copyright (c) 2008-2014, SINTEF Department of Medical Technology
5 All rights reserved.
6 
7 Redistribution and use in source and binary forms, with or without
8 modification, are permitted provided that the following conditions are met:
9 
10 1. Redistributions of source code must retain the above copyright notice,
11  this list of conditions and the following disclaimer.
12 
13 2. Redistributions in binary form must reproduce the above copyright notice,
14  this list of conditions and the following disclaimer in the documentation
15  and/or other materials provided with the distribution.
16 
17 3. Neither the name of the copyright holder nor the names of its contributors
18  may be used to endorse or promote products derived from this software
19  without specific prior written permission.
20 
21 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 =========================================================================*/
32 #ifndef CXVIEWPORTLISTENER_H_
33 #define CXVIEWPORTLISTENER_H_
34 
35 #include "cxResourceExport.h"
36 
37 #include <boost/function.hpp>
38 #include "vtkForwardDeclarations.h"
39 #include "cxVector3D.h"
40 
41 namespace cx
42 {
43 
44 
52 class cxResource_EXPORT ViewportListenerBase
53 {
54 public:
56  virtual ~ViewportListenerBase();
57 
58  void startListen(vtkRendererPtr renderer);
59  void stopListen();
60  bool isListening() const;
61 
62  void setCallback(boost::function<void ()> func);
63 
64  virtual void callback();
65  double getVpnZoom();
66  double getVpnZoom(Vector3D focalPoint);
67 protected:
68  virtual void addObservers() = 0;
69  virtual void removeObservers() = 0;
70 
71  typedef vtkSmartPointer<class ViewportObserverPrivate> ViewportObserverPrivatePtr;
72  ViewportObserverPrivatePtr mObserver;
74 private:
75  boost::function<void ()> mCallback;
76 };
77 
88 class cxResource_EXPORT ViewportListener : public ViewportListenerBase
89 {
90 public:
92  virtual ~ViewportListener();
93  void setModified();
94 
95 protected:
96  virtual void addObservers();
97  virtual void removeObservers();
98 };
99 
100 typedef boost::shared_ptr<class ViewportListener> ViewportListenerPtr;
101 
112 class cxResource_EXPORT ViewportPreRenderListener : public ViewportListenerBase
113 {
114 public:
116  virtual ~ViewportPreRenderListener();
117  virtual void callback();
118  void setModified();
119 
120 protected:
121  virtual void addObservers();
122  virtual void removeObservers();
123 private:
124  bool mModified;
125 };
126 
127 typedef boost::shared_ptr<class ViewportPreRenderListener> ViewportPreRenderListenerPtr;
128 
129 }
130 
131 #endif /* CXVIEWPORTLISTENER_H_ */
boost::shared_ptr< class ViewportListener > ViewportListenerPtr
ViewportObserverPrivatePtr mObserver
boost::shared_ptr< class ViewportPreRenderListener > ViewportPreRenderListenerPtr
Listens to changes in viewport and camera matrix.
vtkSmartPointer< class vtkRenderer > vtkRendererPtr
Base class for listening to a vtkRenderer.
Eigen::Vector3d Vector3D
Vector3D is a representation of a point or vector in 3D.
Definition: cxVector3D.h:63
Listens to the start render event in a vtkRenderer.
vtkSmartPointer< class ViewportObserverPrivate > ViewportObserverPrivatePtr
Namespace for all CustusX production code.