COPASI API  4.16.103
CLRadialGradient.h
Go to the documentation of this file.
1 // Begin CVS Header
2 // $Source: /Volumes/Home/Users/shoops/cvs/copasi_dev/copasi/layout/CLRadialGradient.h,v $
3 // $Revision: 1.4 $
4 // $Name: $
5 // $Author: shoops $
6 // $Date: 2011/09/30 16:35:21 $
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 #include <string>
15 
16 #ifndef CLRadialGradient_H__
17 #define CLRadialGradient_H__
18 
21 
22 class CCopasiContainer;
23 class RadialGradient;
24 
26 {
27 private:
28  // prevent the compiler from generating the assignment operator
30 
31 protected:
39 
40 public:
41  /**
42  * Constructor.
43  */
44  CLRadialGradient(CCopasiContainer* pParent = NULL);
45 
46  /**
47  * Copy Constructor.
48  */
49  CLRadialGradient(const CLRadialGradient& source, CCopasiContainer* pParent = NULL);
50 
51  /**
52  * Constructor to generate object from the corresponding SBML object.
53  */
54  CLRadialGradient(const RadialGradient& source, CCopasiContainer* pParent = NULL);
55 
56  /**
57  * Sets the 3D coordinates for the center and the focal
58  * point as well as the radius.
59  */
60  void setCoordinates(const CLRelAbsVector& x, const CLRelAbsVector& y, const CLRelAbsVector& z, const CLRelAbsVector& r, const CLRelAbsVector& fx, const CLRelAbsVector& fy, const CLRelAbsVector& fz);
61 
62  /**
63  * Sets the 2D coordinates for center and the focal point as well as
64  * the radius.
65  */
66  void setCoordinates(const CLRelAbsVector& x, const CLRelAbsVector& y, const CLRelAbsVector& r, const CLRelAbsVector& fx, const CLRelAbsVector& fy);
67 
68  /**
69  * Sets the coordinates for the first point.
70  */
71  void setCenter(const CLRelAbsVector& x, const CLRelAbsVector& y, const CLRelAbsVector& z = CLRelAbsVector(0.0, 0.0));
72 
73  /**
74  * Sets the coordinates for the second point.
75  */
76  void setFocalPoint(const CLRelAbsVector& x, const CLRelAbsVector& y, const CLRelAbsVector& z = CLRelAbsVector(0.0, 0.0));
77 
78  /**
79  * Sets the radius.
80  */
81  void setRadius(const CLRelAbsVector& r);
82 
83  /**
84  * Returns the x coordinate for the center point.
85  */
86  const CLRelAbsVector& getCenterX() const;
87 
88  /**
89  * Returns the y coordinate for the center point.
90  */
91  const CLRelAbsVector& getCenterY() const;
92 
93  /**
94  * Returns the z coordinate for the center point.
95  */
96  const CLRelAbsVector& getCenterZ() const;
97 
98  /**
99  * Returns the x coordinate for the focal point.
100  */
101  const CLRelAbsVector& getFocalPointX() const;
102 
103  /**
104  * Returns the x coordinate for the focal point.
105  */
106  const CLRelAbsVector& getFocalPointY() const;
107 
108  /**
109  * Returns the x coordinate for the focal point.
110  */
111  const CLRelAbsVector& getFocalPointZ() const;
112 
113  /**
114  * Returns the radius.
115  */
116  const CLRelAbsVector& getRadius() const;
117 
118  /**
119  * Returns the x coordinate for the center point.
120  */
122 
123  /**
124  * Returns the y coordinate for the center point.
125  */
127 
128  /**
129  * Returns the z coordinate for the center point.
130  */
132 
133  /**
134  * Returns the x coordinate for the focal point.
135  */
137 
138  /**
139  * Returns the x coordinate for the focal point.
140  */
142 
143  /**
144  * Returns the x coordinate for the focal point.
145  */
147 
148  /**
149  * Returns the radius.
150  */
152 
153  /**
154  * Converts this object to the corresponding SBML object.
155  */
156  virtual RadialGradient* toSBML(unsigned int level, unsigned int version) const;
157 };
158 
159 #endif /* CLRadialGradient_H__ */
const CLRelAbsVector & getRadius() const
void setRadius(const CLRelAbsVector &r)
const CLRelAbsVector & getCenterY() const
const CLRelAbsVector & getCenterX() const
void setCenter(const CLRelAbsVector &x, const CLRelAbsVector &y, const CLRelAbsVector &z=CLRelAbsVector(0.0, 0.0))
CLRadialGradient(CCopasiContainer *pParent=NULL)
CLRelAbsVector mFY
void setCoordinates(const CLRelAbsVector &x, const CLRelAbsVector &y, const CLRelAbsVector &z, const CLRelAbsVector &r, const CLRelAbsVector &fx, const CLRelAbsVector &fy, const CLRelAbsVector &fz)
CLRelAbsVector mFZ
virtual RadialGradient * toSBML(unsigned int level, unsigned int version) const
CLRadialGradient & operator=(const CLRadialGradient &source)
const CLRelAbsVector & getCenterZ() const
CLRelAbsVector mCZ
CLRelAbsVector mFX
CLRelAbsVector mRadius
const CLRelAbsVector & getFocalPointY() const
const CLRelAbsVector & getFocalPointX() const
CLRelAbsVector mCY
void setFocalPoint(const CLRelAbsVector &x, const CLRelAbsVector &y, const CLRelAbsVector &z=CLRelAbsVector(0.0, 0.0))
CLRelAbsVector mCX
const CLRelAbsVector & getFocalPointZ() const