COPASI API  4.16.103
CLRenderPoint.h
Go to the documentation of this file.
1 // Begin CVS Header
2 // $Source: /Volumes/Home/Users/shoops/cvs/copasi_dev/copasi/layout/CLRenderPoint.h,v $
3 // $Revision: 1.4 $
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 CLRenderPoint_H__
15 #define CLRenderPoint_H__
16 
17 #include "copasi/layout/CLBase.h"
19 
20 class RenderPoint;
21 
22 class CLRenderPoint : public CLBase
23 {
24 protected:
25 
29 
30 public:
31  /**
32  * Creates a new point with x,y and z set to 0.0.
33  */
34 
35  CLRenderPoint();
36 
37  /**
38  * Copy constructor.
39  */
40  CLRenderPoint(const CLRenderPoint& orig);
41 
42  /**
43  * Creates a new point with the given ccordinates.
44  */
45 
46  CLRenderPoint(const CLRelAbsVector& x, const CLRelAbsVector& y, const CLRelAbsVector& z = CLRelAbsVector(0.0, 0.0));
47 
48  /**
49  * Constructor to generate object from the corresponding SBML object.
50  */
51  CLRenderPoint(const RenderPoint& source);
52 
53  /**
54  * Destructor.
55  */
56 
57  virtual ~CLRenderPoint();
58 
59  /**
60  * Assignment operator
61  */
63 
64  /**
65  * Comparison operator.
66  */
67  bool operator==(const CLRenderPoint& left);
68 
69  /**
70  * Returns the x offset.
71  */
72  const CLRelAbsVector& x() const;
73 
74  /**
75  * Returns the y offset.
76  */
77  const CLRelAbsVector& y() const;
78 
79  /**
80  * Returns the z offset.
81  */
82  const CLRelAbsVector& z() const;
83 
84  /**
85  * Returns the x offset.
86  */
87  const CLRelAbsVector& getXOffset() const;
88 
89  /**
90  * Returns the y offset.
91  */
92  const CLRelAbsVector& getYOffset() const;
93 
94  /**
95  * Returns the z offset.
96  */
97  const CLRelAbsVector& getZOffset() const;
98 
99  /**
100  * Returns the x offset.
101  */
102  CLRelAbsVector& x();
103 
104  /**
105  * Returns the y offset.
106  */
107  CLRelAbsVector& y();
108 
109  /**
110  * Returns the z offset.
111  */
112  CLRelAbsVector& z();
113 
114  /**
115  * Returns the x offset.
116  */
118 
119  /**
120  * Returns the y offset.
121  */
123 
124  /**
125  * Returns the z offset.
126  */
128 
129  /**
130  * Sets the x offset.
131  */
132  void setX(const CLRelAbsVector& x);
133 
134  /**
135  * Sets the y offset.
136  */
137  void setY(const CLRelAbsVector& y);
138 
139  /**
140  * Sets the z offset.
141  */
142  void setZ(const CLRelAbsVector& z);
143 
144  /**
145  * Sets the x offset.
146  */
147  void setXOffset(const CLRelAbsVector& x);
148 
149  /**
150  * Sets the y offset.
151  */
152  void setYOffset(const CLRelAbsVector& y);
153 
154  /**
155  * Sets the z offset.
156  */
157  void setZOffset(const CLRelAbsVector& z);
158 
159  /**
160  * Sets the coordinates to the given values.
161  */
162  void setOffsets(const CLRelAbsVector& x, const CLRelAbsVector& y, const CLRelAbsVector& z = CLRelAbsVector(0.0, 0.0));
163 
164  /**
165  * Sets the Z offset to 0.0.
166  */
167  void initDefaults();
168 
169  /**
170  * Converts this object to the corresponding SBML object.
171  */
172  virtual RenderPoint* toSBML(unsigned int level, unsigned int version) const;
173 
174  /**
175  * Adds the attributes for a render point object to the passed in.
176  * object.
177  */
178  virtual void addSBMLAttributes(RenderPoint* pPoint) const;
179 };
180 
181 #endif /* CLRenderPoint_H__ */
CLRelAbsVector mXOffset
Definition: CLRenderPoint.h:26
CLRenderPoint & operator=(const CLRenderPoint &orig)
void setOffsets(const CLRelAbsVector &x, const CLRelAbsVector &y, const CLRelAbsVector &z=CLRelAbsVector(0.0, 0.0))
void setZ(const CLRelAbsVector &z)
const CLRelAbsVector & z() const
const CLRelAbsVector & getZOffset() const
void setZOffset(const CLRelAbsVector &z)
void setY(const CLRelAbsVector &y)
CLRelAbsVector mZOffset
Definition: CLRenderPoint.h:28
const CLRelAbsVector & y() const
virtual RenderPoint * toSBML(unsigned int level, unsigned int version) const
void setXOffset(const CLRelAbsVector &x)
Definition: CLBase.h:33
const CLRelAbsVector & getXOffset() const
const CLRelAbsVector & getYOffset() const
virtual ~CLRenderPoint()
CLRelAbsVector mYOffset
Definition: CLRenderPoint.h:27
const CLRelAbsVector & x() const
void setYOffset(const CLRelAbsVector &y)
virtual void addSBMLAttributes(RenderPoint *pPoint) const
void setX(const CLRelAbsVector &x)
bool operator==(const CLRenderPoint &left)