removed unuseful function calls in BezTriple.[ch]
[blender.git] / source / blender / python / api2_2x / doc / Ipo.py
1 # Blender.Ipo module and the Ipo PyType object
2
3 """
4 The Blender.Ipo submodule
5
6 This module provides access to the Ipo Data in Blender. An Ipo is composed of several Ipocurves.
7
8 A datatype is defined : IpoCurve type. The member functions of this data type are given below.
9
10
11 Example::
12   import Blender
13   ob = Blender.Ipo.Get('ipo')    # retreives an ipo object
14   ob.setName('ipo1')
15   print ob.name
16   print ipo.getRctf()
17   ipo.setRctf(1,2,3,4)
18         
19 """
20
21 def New (name,idcode):
22   """
23   Creates a new Ipo.
24   @type name: string
25   @type idcode: int
26   @param name: The Ipo's name
27   @param idcode: The Ipo's blocktype. Depends to the object the ipo will be linked.
28   @rtype: Blender Ipo
29   @return: The created Ipo.
30   """
31
32 def Get (name = None):
33   """
34   Get the Ipo from Blender.
35   @type name: string
36   @param name: The name of the requested Ipo, or nothing.
37   @rtype: Blender Ipo or a list of Blender Ipos
38   @return: It depends on the 'name' parameter:
39       - (name): The Ipo with the given name;
40       - ():     A list with all Ipos in the current scene.
41   """
42
43
44 class Ipo:
45   """
46   The Ipo object
47   ==============
48   This object gives access to generic data from all objects in Blender.
49   This object has no attribute.
50   """
51
52   def getName():
53     """
54                 Gets the name of the Ipo.
55                 @rtype: string
56                 @return: the name of the Ipo.
57     """
58   def setName(newname):
59     """
60                 Sets the name of the Ipo.
61                 @type newname: string
62                 @rtype: PyNone
63                 @return: PyNone
64     """
65
66   def getBlocktype():
67     """
68                 Gets the blocktype of the Ipo.
69                 @rtype: int
70                 @return: the blocktype of the Ipo.
71     """
72   def setBlocktype(newblocktype):
73     """
74                 Sets the blocktype of the Ipo.
75                 @type newblocktype: int. This value should not be changed, unless you really know what you do...
76                 @rtype: PyNone
77                 @return: PyNone
78     """
79
80   def getRctf():
81     """
82                 Gets the rctf of the Ipo.
83                 Kind of bounding box...
84                 @rtype: list of floats
85                 @return: the rctf of the Ipo.
86     """
87   def setRctf(newrctf):
88     """
89                 Sets the rctf of the Ipo.
90                 @type newrctf: four floats . This value should not be changed, unless you really know what you do...
91                 @rtype: PyNone
92                 @return: PyNone
93     """
94
95   def getNcurves():
96     """
97                 Gets the number of curves of the Ipo.
98                 @rtype: int 
99                 @return: the number of curve of the Ipo.
100     """
101                 
102   def getCurveBP(curvepos):
103     """
104                 Gets the basepoint of a curve of the ipo.
105                 @type curvepos: int
106                 @param curvepos: the position of the curve.
107                 @rtype: a list of 4 floats
108                 @return: the coordinates of the basepoint, or an error is raised.
109     """
110                 
111   def getBeztriple(curvepos,pointpos):
112     """
113                 Gets a beztriple of the Ipo.
114                 @type curvepos: int
115                 @param curvepos: the position of the curve in the ipo
116                 @type pointpos: int
117                 @param pointpos: the position of the point in the curve.
118                 @rtype: list of 9 floats
119                 @return: the beztriple of the Ipo, or an error is raised.
120     """
121   def setBeztriple(curvepos,pointpos,newbeztriple):
122     """
123                 Sets the beztriple of the Ipo.
124                 @type curvepos: int
125                 @param curvepos: the position of the curve in the ipo
126                 @type pointpos: int
127                 @param pointpos: the position of the point in the curve.
128                 @type newbeztriple: list of 9 floats
129                 @param newbeztriple: the new value for the point
130                 @rtype: PyNone
131                 @return: PyNone
132     """
133                 
134   def getCurvecurval(curvepos):
135     """
136                 Gets the current value of a curve of the Ipo.
137                 @type curvepos: int
138                 @param curvepos: the position of the curve in the ipo
139                 @rtype: float
140                 @return: the current value of the selected curve of the Ipo.
141     """
142
143   def EvaluateCurveOn(curvepos,time):
144     """
145                 Gets the current value of a curve of the Ipo.
146                 @type curvepos: int
147                 @param curvepos: the position of the curve in the ipo
148                 @type time: float
149                 @param time: the position of the curve in the ipo
150                 @rtype: float
151                 @return: the current value of the selected curve of the Ipo at the given time.
152     """
153
154
155
156
157 class IpoCurve:
158   """
159   The IpoCurve object
160   ===================
161   This object gives access to generic data from all ipocurves objects in Blender.
162   @cvar name: The Curve Data name.
163   @cvar bezierPoints : The list of the Bezier points.
164   """
165
166   def setExtrapolation(extrapolationtype):
167     """
168                 Sets the extrapolation type  of the curve.
169                 @type extrapolationtype: string
170                 @param extrapolationtype: the extrapolatrion type of the curve. Can be Constant, Extrapolation, Cyclic or Cyclic_extrapolation.
171                 @rtype: PyNone
172                 @return: PyNone
173     """
174   def getExtrapolation():
175     """
176                 Gets the extrapolation type  of the curve.
177                 @rtype: string
178                 @return: the extrapolation type  of the curve.Can be Constant, Extrapolation, Cyclic or Cyclic_extrapolation.
179     """
180                 
181
182   def setInterpolation(interpolationtype):
183     """
184                 Sets the interpolation type  of the curve.
185                 @type interpolationtype: string
186                 @param interpolationtype: the interpolatrion type of the curve. Can be Constant, Bezier, or Linear.
187                 @rtype: PyNone
188                 @return: PyNone
189     """
190   def getInterpolation():
191     """
192                 Gets the interpolation type  of the curve.
193                 @rtype: string
194                 @return: the interpolation type  of the curve.Can be Constant, Bezier, or Linear.
195     """
196                 
197   def addBezier(coordlist):
198     """
199                 Adds a Bezier point to a curve.
200                 @type coordlist: tuple of (at least) 2 floats
201                 @param coordlist: the x and y coordinates of the new Bezier point.
202                 @rtype: PyNone
203                 @return: PyNone
204     """
205
206   def Recalc():
207     """
208                 Recomputes the curent value of the curve.
209                 @rtype: PyNone
210                 @return: PyNone
211     """
212
213   def getName():
214     """
215                 Returns the name of the ipo curve.This name can be : LocX,LocY,LocZ,dLocX,dLocY,dLocZ,RotX,RotY,RotZ,dRotX,dRotY,dRotZ,SizeX,SizeY,SizeZ,dSizeX,dSizeY,dSizeZ,Layer,Time,ColR,ColG,ColB, or ColA.
216                 @rtype: string
217                 @return: the name of the ipo curve.
218     """
219
220   def getPoints():
221     """
222                 Returns all the points of the ipo curve.
223                 @rtype: list
224                 @return: the points of the ipo curve.
225     """
226
227
228 class BezTriple:
229   """
230   The BezTriple object
231   ====================
232   This object gives access to generic data from all beztriple objects in Blender.
233   @cvar name: The Curve Data name.
234   @cvar bezierPoints : The list of the Bezier points.
235   """
236
237   def getPoints():
238     """
239                 Returns the xy coordinates of the Bezier point.
240                 @rtype: list
241                 @return: list of the coordinates of the Bezier point.
242     """
243
244   def setPoints(newval):
245     """
246                 Sets the point xy coordinates.
247                 @type newval: tuple of (at least) 2 floats
248                 @param newval: the x and y coordinates of the new Bezier point.
249                 @rtype: PyNone
250                 @return: PyNone
251     """