Fraxinus  16.5.0-fx-rc9
An IGT application
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
cxVector3DProperty.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 CXVECTOR3DPROPERTY_H_
34 #define CXVECTOR3DPROPERTY_H_
35 
36 #include "cxResourceExport.h"
37 
38 #include <QDomElement>
39 #include <QStringList>
40 #include "cxDoubleRange.h"
41 #include "cxVector3DPropertyBase.h"
42 #include "cxXmlOptionItem.h"
43 
44 namespace cx
45 {
46 
47 typedef boost::shared_ptr<class Vector3DProperty> Vector3DPropertyPtr;
48 
60 class cxResource_EXPORT Vector3DProperty: public Vector3DPropertyBase
61 {
62 Q_OBJECT
63 public:
67  static Vector3DPropertyPtr initialize(const QString& uid, QString name, QString help, Vector3D value,
68  DoubleRange range, int decimals, QDomNode root = QDomNode());
69  void setInternal2Display(double factor);
70 
71 public:
72  // inherited interface
73  virtual QString getDisplayName() const;
74  virtual QString getUid() const;
75  virtual bool setValue(const Vector3D& value);
76  virtual Vector3D getValue() const;
77  virtual QString getHelp() const;
78  virtual DoubleRange getValueRange() const;
79  virtual void setValueRange(DoubleRange range);
80  virtual int getValueDecimals() const;
81  virtual double convertInternal2Display(double internal)
82  {
83  return mFactor * internal;
84  }
85  virtual double convertDisplay2Internal(double display)
86  {
87  return display / mFactor;
88  }
89 
90 
91 signals:
92  void valueWasSet();
93 
94 private:
96  QString mName;
97  QString mUid;
98  QString mHelp;
99  Vector3D mValue;
100  double mDecimals;
101  DoubleRange mRange;
102  XmlOptionItem mStore;
103  double mFactor;
104 };
105 
106 } // namespace cx
107 
108 #endif /* CXVECTOR3DPROPERTY_H_ */
Utility class for describing a bounded numeric range.
Definition: cxDoubleRange.h:53
Helper class for storing one string value in an xml document.
Abstract interface for interaction with internal Vector3D-valued data.
Eigen::Vector3d Vector3D
Vector3D is a representation of a point or vector in 3D.
Definition: cxVector3D.h:63
boost::shared_ptr< class Vector3DProperty > Vector3DPropertyPtr
virtual double convertDisplay2Internal(double display)
conversion from internal value to display value
virtual double convertInternal2Display(double internal)
conversion from internal value to display value (for example between 0..1 and percent) ...
Represents one option of the double type.