Fraxinus  16.5.0-fx-rc5
An IGT application
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
cxSliceComputer.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 
33 #ifndef CXSLICECOMPUTER_H_
34 #define CXSLICECOMPUTER_H_
35 
36 #include "cxResourceExport.h"
37 
38 #include "cxTransform3D.h"
39 #include "cxDefinitions.h"
40 
41 namespace cx
42 {
43 
49 class cxResource_EXPORT SlicePlane
50 {
51 public:
53  SlicePlane(const Vector3D& c, const Vector3D& i, const Vector3D& j);
57 };
58 
59 cxResource_EXPORT std::ostream& operator<<(std::ostream& s, const SlicePlane& val);
60 cxResource_EXPORT bool similar(const SlicePlane& a, const SlicePlane& b);
61 
62 
74 class cxResource_EXPORT SliceComputer
75 {
76 public:
77  SliceComputer();
78  ~SliceComputer();
79  void setToolPosition(const Transform3D& rMt);
80  void setOrientationType(ORIENTATION_TYPE val);
81  void setPlaneType(PLANE_TYPE val);
82  void setFixedCenter(const Vector3D& center);
83  void setFollowType(FOLLOW_TYPE val);
84  void setGravity(bool use, const Vector3D& dir);
85  void setToolOffset(double val);
86  void setToolViewOffset(bool use, double viewportHeight, double viewOffset, bool useConstrainedViewOffset = false);
87  void setToolViewportHeight(double viewportHeight);
88  void setClinicalApplication(CLINICAL_VIEW application);
89  SlicePlane getPlane() const;
90 
91  void initializeFromPlane(PLANE_TYPE plane, bool useGravity, const Vector3D& gravityDir, bool useViewOffset, double viewportHeight, double toolViewOffset, CLINICAL_VIEW application, bool useConstrainedViewOffset = false);
92  ORIENTATION_TYPE getOrientationType() const;
93  PLANE_TYPE getPlaneType() const;
94  Transform3D getToolPosition() const;
95 
96 private:
97  std::pair<Vector3D,Vector3D> generateBasisVectors() const;
98  Vector3D generateFixedIJCenter(const Vector3D& center_r, const Vector3D& cross_r, const Vector3D& i, const Vector3D& j) const;
99  SlicePlane orientToGravity(const SlicePlane& base) const;
100  SlicePlane applyViewOffset(const SlicePlane& base) const;
101  double getViewOffsetAbsoluteFromCenter() const;
102 
103  std::pair<Vector3D,Vector3D> generateBasisVectorsNeurology() const;
104  std::pair<Vector3D,Vector3D> generateBasisVectorsRadiology() const;
105 
106 private:
107  CLINICAL_VIEW mClinicalApplication;
108  ORIENTATION_TYPE mOrientType;
109  PLANE_TYPE mPlaneType;
110  FOLLOW_TYPE mFollowType;
111  Vector3D mFixedCenter;
112 
113  Transform3D m_rMt;
114  double mToolOffset;
115 
116  bool mUseGravity;
117  Vector3D mGravityDirection;
118 
119  bool mUseViewOffset;
120  double mViewportHeight;
121  double mViewOffset;
122  bool mUseConstrainedViewOffset;
123 };
124 
125 } // namespace cx
126 
127 #endif /*CXSLICECOMPUTER_H_*/
Vector3D j
defines the second axis of the plane. unit vector
A 2D slice plane in 3D. i,j are perpendicular unit vectors.
Transform3D Transform3D
Transform3D is a representation of an affine 3D transform.
bool similar(const DoubleBoundingBox3D &a, const DoubleBoundingBox3D &b, double tol)
Vector3D c
defines the center of the plane
std::ostream & operator<<(std::ostream &s, const IntBoundingBox3D &data)
Eigen::Vector3d Vector3D
Vector3D is a representation of a point or vector in 3D.
Definition: cxVector3D.h:63
Vector3D i
defines the first axis of the plane. unit vector
Calculates a slice plane given a definition.