COPASI API  4.16.103
CLRectangle.h
Go to the documentation of this file.
1 // Begin CVS Header
2 // $Source: /Volumes/Home/Users/shoops/cvs/copasi_dev/copasi/layout/CLRectangle.h,v $
3 // $Revision: 1.5 $
4 // $Name: $
5 // $Author: shoops $
6 // $Date: 2011/09/30 16:35:20 $
7 // End CVS Header
8 
9 // Copyright (C) 2011 - 2010 by Pedro Mendes, Virginia Tech Intellectual
10 // Properties, Inc., University of Heidelberg, and The University
11 // of Manchester.
12 // All rights reserved.
13 
14 #ifndef CLRectangle_H__
15 #define CLRectangle_H__
16 
20 
21 class CCopasiContainer;
22 class sbmlRectangle;
23 
25 {
26 private:
27  // prevent the compiler from generating the assignment operator
28  CLRectangle& operator=(const CLRectangle& source);
29 
30 protected:
38 
39  /**
40  * key for the object.
41  */
42  std::string mKey;
43 
44 public:
45  /**
46  * Constructor.
47  */
48  CLRectangle(CCopasiContainer* pParent = NULL);
49 
50  /**
51  * Copy Constructor.
52  */
53  CLRectangle(const CLRectangle& source, CCopasiContainer* pParent = NULL);
54 
55  /**
56  * Constructor that takes x, y and z coordinate values, the width and the
57  * height.
58  */
59  CLRectangle(const CLRelAbsVector& x, const CLRelAbsVector& y, const CLRelAbsVector& z, const CLRelAbsVector& w, const CLRelAbsVector& h, CCopasiContainer* pParent = NULL);
60 
61  /**
62  * Constructor that takes x and y coordinate values, the width and the
63  * height.
64  */
65  CLRectangle(const CLRelAbsVector& x, const CLRelAbsVector& y, const CLRelAbsVector& w, const CLRelAbsVector& h, CCopasiContainer* pParent = NULL);
66 
67  /**
68  * Constructor to generate object from the corresponding SBML object.
69  */
70  CLRectangle(const sbmlRectangle& source, CCopasiContainer* pParent = NULL);
71 
72  /**
73  * Destructor.
74  */
75  ~CLRectangle();
76 
77  /**
78  * Sets the position, the width and the height.
79  */
80  void setCoordinatesAndSize(const CLRelAbsVector& x, const CLRelAbsVector& y, const CLRelAbsVector& z, const CLRelAbsVector& w, const CLRelAbsVector& h);
81 
82  /**
83  * Sets the position.
84  */
85  void setCoordinates(const CLRelAbsVector& x, const CLRelAbsVector& y, const CLRelAbsVector& z);
86 
87  /**
88  * Sets the size.
89  */
90  void setSize(const CLRelAbsVector& w, const CLRelAbsVector& h);
91 
92  /**
93  * Sets the width.
94  */
95  void setWidth(const CLRelAbsVector& w);
96 
97  /**
98  * Sets the height.
99  */
100  void setHeight(const CLRelAbsVector& h);
101 
102  /**
103  * Sets the corner radii.
104  */
105  void setRadii(const CLRelAbsVector& rx, const CLRelAbsVector& ry);
106 
107  /**
108  * Sets the x radius for the corners.
109  */
110  void setRadiusX(const CLRelAbsVector& rx);
111 
112  /**
113  * Sets the y radius for the corners.
114  */
115  void setRadiusY(const CLRelAbsVector& ry);
116 
117  /**
118  * Sets the x position.
119  */
120  void setX(const CLRelAbsVector& x);
121 
122  /**
123  * Sets the y position.
124  */
125  void setY(const CLRelAbsVector& y);
126 
127  /**
128  * Sets the z position.
129  */
130  void setZ(const CLRelAbsVector& z);
131 
132  /**
133  * Returns the x coordinate.
134  */
135  const CLRelAbsVector& getX() const;
136 
137  /**
138  * Returns the y coordinate.
139  */
140  const CLRelAbsVector& getY() const;
141 
142  /**
143  * Returns the z coordinate.
144  */
145  const CLRelAbsVector& getZ() const;
146 
147  /**
148  * Returns the width.
149  */
150  const CLRelAbsVector& getWidth() const;
151 
152  /**
153  * Returns the height.
154  */
155  const CLRelAbsVector& getHeight() const;
156 
157  /**
158  * Returns the corner radius along th x axis.
159  */
160  const CLRelAbsVector& getRadiusX() const;
161 
162  /**
163  * Returns the corner radius along the y axis.
164  */
165  const CLRelAbsVector& getRadiusY() const;
166 
167  /**
168  * Returns the x coordinate.
169  */
170  CLRelAbsVector& getX();
171 
172  /**
173  * Returns the y coordinate.
174  */
175  CLRelAbsVector& getY();
176 
177  /**
178  * Returns the z coordinate.
179  */
180  CLRelAbsVector& getZ();
181 
182  /**
183  * Returns the width.
184  */
186 
187  /**
188  * Returns the height.
189  */
191 
192  /**
193  * Returns the corner radius along th x axis.
194  */
196 
197  /**
198  * Returns the corner radius along the y axis.
199  */
201 
202  /**
203  * Returns the key string of the object.
204  */
205  const std::string& getKey() const;
206 
207  /**
208  * Converts this object to the corresponding SBML object.
209  */
210  sbmlRectangle* toSBML(unsigned int level, unsigned int version) const;
211 };
212 
213 #endif /* CLRectangle_H__ */
void setSize(const CLRelAbsVector &w, const CLRelAbsVector &h)
const std::string & getKey() const
void setRadiusX(const CLRelAbsVector &rx)
CLRelAbsVector mRY
Definition: CLRectangle.h:37
CLRelAbsVector mY
Definition: CLRectangle.h:32
const CLRelAbsVector & getRadiusY() const
const CLRelAbsVector & getWidth() const
CLRelAbsVector mZ
Definition: CLRectangle.h:33
void setRadiusY(const CLRelAbsVector &ry)
void setCoordinates(const CLRelAbsVector &x, const CLRelAbsVector &y, const CLRelAbsVector &z)
sbmlRectangle * toSBML(unsigned int level, unsigned int version) const
#define sbmlRectangle
Definition: CLGroup.cpp:23
CLRelAbsVector mWidth
Definition: CLRectangle.h:34
void setX(const CLRelAbsVector &x)
const CLRelAbsVector & getX() const
void setY(const CLRelAbsVector &y)
const CLRelAbsVector & getY() const
const CLRelAbsVector & getRadiusX() const
CLRelAbsVector mX
Definition: CLRectangle.h:31
const CLRelAbsVector & getHeight() const
CLRelAbsVector mRX
Definition: CLRectangle.h:36
void setCoordinatesAndSize(const CLRelAbsVector &x, const CLRelAbsVector &y, const CLRelAbsVector &z, const CLRelAbsVector &w, const CLRelAbsVector &h)
std::string mKey
Definition: CLRectangle.h:42
CLRelAbsVector mHeight
Definition: CLRectangle.h:35
CLRectangle(CCopasiContainer *pParent=NULL)
Definition: CLRectangle.cpp:25
void setZ(const CLRelAbsVector &z)
void setRadii(const CLRelAbsVector &rx, const CLRelAbsVector &ry)
void setHeight(const CLRelAbsVector &h)
const CLRelAbsVector & getZ() const
CLRectangle & operator=(const CLRectangle &source)
void setWidth(const CLRelAbsVector &w)