COPASI API  4.16.103
CLLinearGradient.h
Go to the documentation of this file.
1 // Begin CVS Header
2 // $Source: /Volumes/Home/Users/shoops/cvs/copasi_dev/copasi/layout/CLLinearGradient.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 CLLinearGradient_H__
15 #define CLLinearGradient_H__
16 
17 #include <string>
18 
21 
22 class CCopasiContainer;
23 class LinearGradient;
24 
26 {
27 private:
28  // prevent the compiler from generating the assignment operator
30 
31 protected:
38 
39 public:
40  /**
41  * Constructor.
42  */
43  CLLinearGradient(CCopasiContainer* pParent = NULL);
44 
45  /**
46  * Copy Constructor
47  */
48  CLLinearGradient(const CLLinearGradient& source, CCopasiContainer* pParent = NULL);
49 
50  /**
51  * Constructor to generate object from the corresponding SBML object.
52  */
53  CLLinearGradient(const LinearGradient& source, CCopasiContainer* pParent = NULL);
54 
55  /**
56  * Sets the 3D coordinates for both points.
57  */
58  void setCoordinates(const CLRelAbsVector& x1, const CLRelAbsVector& y1, const CLRelAbsVector& z1, const CLRelAbsVector& x2, const CLRelAbsVector& y2, const CLRelAbsVector& z2);
59 
60  /**
61  * Sets the 3D coordinates for both points.
62  */
63  void setCoordinates(const CLRelAbsVector& x1, const CLRelAbsVector& y1, const CLRelAbsVector& x2, const CLRelAbsVector& y2);
64 
65  /**
66  * Sets the coordinates for the first point.
67  */
68  void setPoint1(const CLRelAbsVector& x1, const CLRelAbsVector& y1, const CLRelAbsVector& z1 = CLRelAbsVector(0.0, 0.0));
69 
70  /**
71  * Sets the coordinates for the second point.
72  */
73  void setPoint2(const CLRelAbsVector& x1, const CLRelAbsVector& y1, const CLRelAbsVector& z1 = CLRelAbsVector(0.0, 0.0));
74 
75  /**
76  * Returns the x coordinate for the first point.
77  */
78  const CLRelAbsVector& getXPoint1() const;
79 
80  /**
81  * Returns the y coordinate for the first point.
82  */
83  const CLRelAbsVector& getYPoint1() const;
84 
85  /**
86  * Returns the z coordinate for the first point.
87  */
88  const CLRelAbsVector& getZPoint1() const;
89 
90  /**
91  * Returns the x coordinate for the second point.
92  */
93  const CLRelAbsVector& getXPoint2() const;
94 
95  /**
96  * Returns the y coordinate for the second point.
97  */
98  const CLRelAbsVector& getYPoint2() const;
99 
100  /**
101  * Returns the z coordinate for the second point.
102  */
103  const CLRelAbsVector& getZPoint2() const;
104 
105  /**
106  * Returns the x coordinate for the first point.
107  */
109 
110  /**
111  * Returns the y coordinate for the first point.
112  */
114 
115  /**
116  * Returns the z coordinate for the first point.
117  */
119 
120  /**
121  * Returns the x coordinate for the second point.
122  */
124 
125  /**
126  * Returns the y coordinate for the second point.
127  */
129 
130  /**
131  * Returns the z coordinate for the second point.
132  */
134 
135  /**
136  * Converts this object to the corresponding SBML object.
137  */
138  virtual LinearGradient* toSBML(unsigned int level, unsigned int version) const;
139 };
140 
141 #endif /* CLLinearGradient_H__ */
CLRelAbsVector mZ1
const CLRelAbsVector & getYPoint1() const
const CLRelAbsVector & getZPoint1() const
void setCoordinates(const CLRelAbsVector &x1, const CLRelAbsVector &y1, const CLRelAbsVector &z1, const CLRelAbsVector &x2, const CLRelAbsVector &y2, const CLRelAbsVector &z2)
CLLinearGradient & operator=(const CLLinearGradient &source)
CLRelAbsVector mY1
CLRelAbsVector mX2
const CLRelAbsVector & getXPoint2() const
void setPoint1(const CLRelAbsVector &x1, const CLRelAbsVector &y1, const CLRelAbsVector &z1=CLRelAbsVector(0.0, 0.0))
CLRelAbsVector mY2
CLLinearGradient(CCopasiContainer *pParent=NULL)
const CLRelAbsVector & getZPoint2() const
virtual LinearGradient * toSBML(unsigned int level, unsigned int version) const
void setPoint2(const CLRelAbsVector &x1, const CLRelAbsVector &y1, const CLRelAbsVector &z1=CLRelAbsVector(0.0, 0.0))
CLRelAbsVector mZ2
CLRelAbsVector mX1
const CLRelAbsVector & getYPoint2() const
const CLRelAbsVector & getXPoint1() const