← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/blender/gutsy-security

« back to all changes in this revision

Viewing changes to source/blender/python/api2_2x/doc/Ipo.py

  • Committer: Bazaar Package Importer
  • Author(s): Florian Ernst
  • Date: 2005-11-06 12:40:03 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20051106124003-3pgs7tcg5rox96xg
Tags: 2.37a-1.1
http://bugs.debian.org/333958
* Non-maintainer upload.
* Split out parts of 01_SConstruct_debian.dpatch again: root_build_dir
  really needs to get adjusted before the clean target runs - closes: #333958,
  see #288882 for reference

Show diffs side-by-side

added added

removed removed

Lines of Context:
source/blender/python/api2_2x/doc/Ipo.py
3
3
"""
4
4
The Blender.Ipo submodule
5
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.
 
6
B{New}: Ipo updates to both the program and bpython access.
 
7
 
 
8
This module provides access to the Ipo Data in Blender. An Ipo is composed of
 
9
several IpoCurves.
 
10
 
 
11
A datatype is defined : IpoCurve type. The member functions of this data type
 
12
are given below.
9
13
 
10
14
 
11
15
Example::
12
16
  import Blender
13
 
  ob = Blender.Ipo.Get('ipo')    # retreives an ipo object
 
17
  ob = Blender.Ipo.Get('ipo')    # retrieves an ipo object
14
18
  ob.setName('ipo1')
15
19
  print ob.name
16
20
  print ipo.getRctf()
17
21
  ipo.setRctf(1,2,3,4)
18
 
        
 
22
  
19
23
"""
20
24
 
21
25
def New (type, name):
23
27
  Creates a new Ipo.
24
28
  @type type: string
25
29
  @type name: string
26
 
  @param type: The Ipo's blocktype. Depends on the object the ipo will be linked to. \
27
 
  Currently supported types are Object, Camera, World, Material.
 
30
  @param type: The Ipo's blocktype. Depends on the object the ipo will be
 
31
      linked to. Currently supported types are Object, Camera, World,
 
32
      Material, Texture, Lamp, Action, Constraint, Sequence, Curve, Key.
28
33
  @param name: The name for this Ipo.
29
34
  @rtype: Blender Ipo
30
35
  @return: The created Ipo.
41
46
      - ():     A list with all Ipos in the current scene.
42
47
  """
43
48
 
44
 
 
45
49
class Ipo:
46
50
  """
47
51
  The Ipo object
48
52
  ==============
49
53
  This object gives access to generic data from all objects in Blender.
50
 
  This object has no attribute.
 
54
  It has no attributes.
51
55
  """
52
56
 
53
57
  def getName():
54
58
    """
55
 
                Gets the name of the Ipo.
56
 
                @rtype: string
57
 
                @return: the name of the Ipo.
 
59
    Gets the name of the Ipo.
 
60
    @rtype: string
 
61
    @return: the name of the Ipo.
58
62
    """
 
63
 
59
64
  def getCurves():
60
65
    """
61
 
                Gets all the IpoCurves of the Ipo.
62
 
                @rtype: list of IpoCurves
63
 
                @return: A list (possibly void) containing all the IpoCurves associated to the Ipo object.
 
66
    Gets all the IpoCurves of the Ipo.
 
67
    @rtype: list of IpoCurves
 
68
    @return: A list (possibly void) containing all the IpoCurves associated to the Ipo object.
64
69
    """
 
70
 
65
71
  def getCurve(curvename):
66
72
    """
67
 
                Returns the IpoCurve with the given name.
68
 
                The possible values for curvename are R,G,B,SpecR,SpecG,SpecB,MirR,MirG,MirB,Ref,Alpha,Emit,Amb,Spec,Hard,SpTra,Ang,Mode,HaSize,OfsX,OfsY,OfsZ,SizeX,SizeY,SizeZ,TexR,TexG,TexB,DefVar,Col,Nor,Var(Material Ipo)
69
 
                HorR,HorG,HorB,ZenR,ZenG,ZenB,Expos,Misi,MisDi,MisSta,MisHi,StaR,StaG,StaB,StarDi,StarSi,OfsX,OfsY,OfsZ,SizeX,SizeY,SizeZ,TexR,TexG,TexB,DefVar,Col,Nor,Var (World Ipo)
70
 
                LocX,LocY,LocZ,dLocX,dLocY,dLocZ,RotX,RotY,RotZ,dRotX,dRotY,dRotZ,SizeX,SizeY,SizeZ,dSizeX,dSizeY,dSizeZ,Layer,Time,ColR,ColG,ColB,ColA (Object Ipo)
71
 
                Lens,ClSta,ClEnd (Camera Ipo)
72
 
                @type curvename : string
73
 
                @rtype: IpoCurve object
74
 
                @return: the corresponding IpoCurve, or None.
75
 
    """
 
73
    Return the IpoCurve with the given name. The possible values for
 
74
    'curvename' are:
 
75
    
 
76
      1. Camera Ipo:  Lens, ClSta, ClEnd, Apert, FDist.
 
77
      2. Material Ipo: R, G, B, SpecR, SpecG, SpecB, MirR, MirG, MirB, Ref,
 
78
      Alpha, Emit, Amb, Spec, Hard, SpTra, Ior, Mode, HaSize, Translu,
 
79
      RayMir, FresMir, FresMirI, FresTra, FresTraI, TraGlow, OfsX, OfsY,
 
80
      OfsZ, SizeX, SizeY, SizeZ, texR, texG, texB, DefVar, Col, Nor, Var,
 
81
      Disp.
 
82
      3. Object Ipo: LocX, LocY, LocZ, dLocX, dLocY, dLocZ, RotX, RotY, RotZ,
 
83
      dRotX, dRotY, dRotZ, SizeX, SizeY, SizeZ, dSizeX, dSizeY, dSizeZ,
 
84
      Layer, Time, ColR, ColG, ColB, ColA, FStreng, FFall, Damping,
 
85
      RDamp, Perm.
 
86
      4. Lamp Ipo: Energ, R, G, B, Dist, SpoSi, SpoBl, Quad1, Quad2, HaInt.
 
87
      5. World Ipo: HorR, HorG, HorB, ZenR, ZenG, ZenB, Expos, Misi, MisDi,
 
88
      MisSta, MisHi, StaR, StaG, StaB, StarDi, StarSi, OfsX, OfsY, OfsZ,
 
89
      SizeX, SizeY, SizeZ, TexR, TexG, TexB, DefVar, Col, Nor, Var.
 
90
      5. World Ipo: HorR, HorG, HorB, ZenR, ZenG, ZenB, Expos, Misi, MisDi,
 
91
      MisSta, MisHi, StarR, StarB, StarG, StarDi, StarSi, OfsX, OfsY, OfsZ,i
 
92
      SizeX, SizeY, SizeZ, texR, texG, texB, DefVar, Col, Nor, Var.
 
93
      6. Texture Ipo: NSize, NDepth, NType, Turb, Vnw1, Vnw2, Vnw3, Vnw4,
 
94
      MinkMExp, DistM, ColT, iScale, DistA, MgType, MgH, Lacu, Oct,
 
95
      MgOff, MgGain, NBase1, NBase2.
 
96
      7. Curve Ipo: Speed.
 
97
      8. Key Ipo: Speed, 'Key 1' - 'Key 63'.
 
98
      9. Action Ipo: LocX, LocY, LocZ, SizeX, SizeY, SizeZ, QuatX, QuatY,
 
99
      QuatZ, QuatW.
 
100
      10. Sequence Ipo: Fac.
 
101
      11. Constraint Ipo: Inf.
 
102
 
 
103
    @type curvename : string
 
104
    @rtype: IpoCurve object
 
105
    @return: the corresponding IpoCurve, or None.
 
106
    """
 
107
 
 
108
  def addCurve(curvename):
 
109
    """
 
110
    Add a new curve to the IPO object. The possible values for 'curvename' are:
 
111
      1. Camera Ipo:  Lens, ClSta, ClEnd, Apert, FDist.
 
112
      2. Material Ipo: R, G, B, SpecR, SpecG, SpecB, MirR, MirG, MirB, Ref,
 
113
      Alpha, Emit, Amb, Spec, Hard, SpTra, Ior, Mode, HaSize, Translu,
 
114
      RayMir, FresMir, FresMirI, FresTra, FresTraI, TraGlow, OfsX, OfsY,
 
115
      OfsZ, SizeX, SizeY, SizeZ, texR, texG, texB, DefVar, Col, Nor, Var,
 
116
      Disp.
 
117
      3. Object Ipo: LocX, LocY, LocZ, dLocX, dLocY, dLocZ, RotX, RotY, RotZ,
 
118
      dRotX, dRotY, dRotZ, SizeX, SizeY, SizeZ, dSizeX, dSizeY, dSizeZ,
 
119
      Layer, Time, ColR, ColG, ColB, ColA, FStreng, FFall, Damping,
 
120
      RDamp, Perm.
 
121
      4. Lamp Ipo: Energ, R, G, B, Dist, SpoSi, SpoBl, Quad1, Quad2, HaInt.
 
122
      5. World Ipo: HorR, HorG, HorB, ZenR, ZenG, ZenB, Expos, Misi, MisDi,
 
123
      MisSta, MisHi, StaR, StaG, StaB, StarDi, StarSi, OfsX, OfsY, OfsZ,
 
124
      SizeX, SizeY, SizeZ, TexR, TexG, TexB, DefVar, Col, Nor, Var.
 
125
      5. World Ipo: HorR, HorG, HorB, ZenR, ZenG, ZenB, Expos, Misi, MisDi,
 
126
      MisSta, MisHi, StarR, StarB, StarG, StarDi, StarSi, OfsX, OfsY, OfsZ,i
 
127
      SizeX, SizeY, SizeZ, texR, texG, texB, DefVar, Col, Nor, Var.
 
128
      6. Texture Ipo: NSize, NDepth, NType, Turb, Vnw1, Vnw2, Vnw3, Vnw4,
 
129
      MinkMExp, DistM, ColT, iScale, DistA, MgType, MgH, Lacu, Oct,
 
130
      MgOff, MgGain, NBase1, NBase2.
 
131
      7. Curve Ipo: Speed.
 
132
      8. Key Ipo: Speed, 'Key 1' - 'Key 63'.
 
133
      9. Action Ipo: LocX, LocY, LocZ, SizeX, SizeY, SizeZ, QuatX, QuatY,
 
134
      QuatZ, QuatW.
 
135
      10. Sequence Ipo: Fac.
 
136
      11. Constraint Ipo: Inf.
 
137
 
 
138
    @type curvename : string
 
139
    @rtype: IpoCurve object
 
140
    @return: the corresponding IpoCurve, or None.
 
141
    """
 
142
 
 
143
  def removeCurve(curvename):
 
144
    """
 
145
    Remove a existing curve from the IPO object. See addCurve() for possible values for curvename.
 
146
    @type curvename : string
 
147
    @rtype: None
 
148
    @return: None.
 
149
    """
 
150
 
76
151
  def setName(newname):
77
152
    """
78
 
                Sets the name of the Ipo.
79
 
                @type newname: string
80
 
                @rtype: PyNone
81
 
                @return: PyNone
 
153
    Sets the name of the Ipo.
 
154
    @type newname: string
 
155
    @rtype: None
 
156
    @return: None
82
157
    """
83
158
 
84
159
  def getBlocktype():
85
160
    """
86
 
                Gets the blocktype of the Ipo.
87
 
                @rtype: int
88
 
                @return: the blocktype of the Ipo.
 
161
    Gets the blocktype of the Ipo.
 
162
    @rtype: int
 
163
    @return: the blocktype of the Ipo.
89
164
    """
 
165
 
90
166
  def setBlocktype(newblocktype):
91
167
    """
92
 
                Sets the blocktype of the Ipo.
93
 
                @type newblocktype: int. This value should not be changed, unless you really know what you do...
94
 
                @rtype: PyNone
95
 
                @return: PyNone
 
168
    Sets the blocktype of the Ipo.
 
169
    @type newblocktype: int 
 
170
    @rtype: None
 
171
    @return: None
 
172
    @warn: 'newblocktype' should not be changed unless you really know what
 
173
       you are doing ...
96
174
    """
97
175
 
98
176
  def getRctf():
99
177
    """
100
 
                Gets the rctf of the Ipo.
101
 
                Kind of bounding box...
102
 
                @rtype: list of floats
103
 
                @return: the rctf of the Ipo.
 
178
    Gets the rctf of the Ipo.
 
179
    Kind of bounding box...
 
180
    @rtype: list of floats
 
181
    @return: the rctf of the Ipo.
104
182
    """
 
183
 
105
184
  def setRctf(newrctf):
106
185
    """
107
 
                Sets the rctf of the Ipo.
108
 
                @type newrctf: four floats . This value should not be changed, unless you really know what you do...
109
 
                @rtype: PyNone
110
 
                @return: PyNone
 
186
    Sets the rctf of the Ipo.
 
187
    @type newrctf: four floats.
 
188
    @rtype: None
 
189
    @return: None
 
190
    @warn: rctf should not be changed unless you really know what you are
 
191
       doing ...
111
192
    """
112
193
 
113
194
  def getNcurves():
114
195
    """
115
 
                Gets the number of curves of the Ipo.
116
 
                @rtype: int 
117
 
                @return: the number of curve of the Ipo.
 
196
    Gets the number of curves of the Ipo.
 
197
    @rtype: int 
 
198
    @return: the number of curve of the Ipo.
118
199
    """
119
 
                
 
200
    
120
201
  def getCurveBP(curvepos):
121
202
    """
122
 
                Gets the basepoint of a curve of the ipo.
123
 
                @type curvepos: int
124
 
                @param curvepos: the position of the curve.
125
 
                @rtype: a list of 4 floats
126
 
                @return: the coordinates of the basepoint, or an error is raised.
 
203
    This method is unsupported.  BPoint Ipo curves are not implemented.
 
204
    Calling this method throws a NotImplementedError exception.
 
205
    @raise NotImplementedError: this method B{always} raises an exception
127
206
    """
128
 
                
 
207
 
129
208
  def getBeztriple(curvepos,pointpos):
130
209
    """
131
 
                Gets a beztriple of the Ipo.
132
 
                @type curvepos: int
133
 
                @param curvepos: the position of the curve in the ipo
134
 
                @type pointpos: int
135
 
                @param pointpos: the position of the point in the curve.
136
 
                @rtype: list of 9 floats
137
 
                @return: the beztriple of the Ipo, or an error is raised.
 
210
    Gets a beztriple of the Ipo.
 
211
    @type curvepos: int
 
212
    @param curvepos: the position of the curve in the ipo
 
213
    @type pointpos: int
 
214
    @param pointpos: the position of the point in the curve.
 
215
    @rtype: list of 9 floats
 
216
    @return: the beztriple of the Ipo, or an error is raised.
138
217
    """
 
218
 
139
219
  def setBeztriple(curvepos,pointpos,newbeztriple):
140
220
    """
141
 
                Sets the beztriple of the Ipo.
142
 
                @type curvepos: int
143
 
                @param curvepos: the position of the curve in the ipo
144
 
                @type pointpos: int
145
 
                @param pointpos: the position of the point in the curve.
146
 
                @type newbeztriple: list of 9 floats
147
 
                @param newbeztriple: the new value for the point
148
 
                @rtype: PyNone
149
 
                @return: PyNone
150
 
    """
151
 
                
152
 
  def getCurvecurval(curvepos):
153
 
    """
154
 
                Gets the current value of a curve of the Ipo.
155
 
                @type curvepos: int or string
156
 
                @param curvepos: the position of the curve in the ipo or the name of the curve
157
 
                @rtype: float
158
 
                @return: the current value of the selected curve of the Ipo.
 
221
    Sets the beztriple of the Ipo.
 
222
    @type curvepos: int
 
223
    @param curvepos: the position of the curve in the ipo
 
224
    @type pointpos: int
 
225
    @param pointpos: the position of the point in the curve.
 
226
    @type newbeztriple: list of 9 floats
 
227
    @param newbeztriple: the new value for the point
 
228
    @rtype: None
 
229
    @return: None
 
230
    """
 
231
    
 
232
  def getCurveCurval(curvepos):
 
233
    """
 
234
    Gets the current value of a curve of the Ipo.
 
235
    @type curvepos: int or string
 
236
    @param curvepos: the position of the curve in the ipo or the name of the
 
237
        curve
 
238
    @rtype: float
 
239
    @return: the current value of the selected curve of the Ipo.
159
240
    """
160
241
 
161
242
  def EvaluateCurveOn(curvepos,time):
162
243
    """
163
 
                Gets the current value of a curve of the Ipo.
164
 
                @type curvepos: int
165
 
                @param curvepos: the position of the curve in the ipo
166
 
                @type time: float
167
 
                @param time: the position of the curve in the ipo
168
 
                @rtype: float
169
 
                @return: the current value of the selected curve of the Ipo at the given time.
 
244
    Gets the current value of a curve of the Ipo.
 
245
    @type curvepos: int
 
246
    @param curvepos: the position of the curve in the ipo
 
247
    @type time: float
 
248
    @param time: the position of the curve in the ipo
 
249
    @rtype: float
 
250
    @return: the current value of the selected curve of the Ipo at the given
 
251
        time.
170
252
    """
171
253
 
172
 
 
173
 
 
174
 
 
175
254
class IpoCurve:
176
255
  """
177
256
  The IpoCurve object
179
258
  This object gives access to generic data from all ipocurves objects in Blender.
180
259
 
181
260
  Important Notes for Rotation Curves:\n
182
 
  For the rotation IpoCurves, the y values for points are in units of 10 degrees.  example:  45.0 degrees is stored as 4.50 degrees.  These are the same numbers you see in the Transform Properties pupmenu ( NKey ) in the IPO Curve Editor window.  Positive rotations are in a counter-clockwise direction, just like in math class.
 
261
  For the rotation IpoCurves, the y values for points are in units of 10 degrees.  For example, 45.0 degrees is stored as 4.50 degrees.  These are the same numbers you see in the Transform Properties pupmenu ( NKey ) in the IPO Curve Editor window.  Positive rotations are in a counter-clockwise direction, just like in math class.
183
262
  
184
 
  @cvar name: The Curve Data name.
185
 
  @cvar bezierPoints : The list of the Bezier points.
 
263
  @ivar name: The Curve Data name.
 
264
  @ivar bezierPoints : The list of the Bezier points.
186
265
  """
187
266
 
188
 
  def setExtrapolation(extrapolationtype):
189
 
    """
190
 
                Sets the extrapolation type  of the curve.
191
 
                @type extrapolationtype: string
192
 
                @param extrapolationtype: the extrapolatrion type of the curve. Can be Constant, Extrapolation, Cyclic or Cyclic_extrapolation.
193
 
                @rtype: PyNone
194
 
                @return: PyNone
195
 
    """
 
267
  def setExtrapolation(extendmode):
 
268
    """
 
269
    Sets the extend mode of the curve.
 
270
    @type extendmode: string
 
271
    @param extendmode: the extend mode of the curve.
 
272
        Can be Constant, Extrapolation, Cyclic or Cyclic_extrapolation.
 
273
    @rtype: None
 
274
    @return: None
 
275
    """
 
276
 
196
277
  def getExtrapolation():
197
278
    """
198
 
                Gets the extrapolation type  of the curve.
199
 
                @rtype: string
200
 
                @return: the extrapolation type  of the curve.Can be Constant, Extrapolation, Cyclic or Cyclic_extrapolation.
 
279
    Gets the extend mode of the curve.
 
280
    @rtype: string
 
281
    @return: the extend mode of the curve. Can be Constant, Extrapolation, Cyclic or Cyclic_extrapolation.
201
282
    """
202
 
                
 
283
    
203
284
 
204
285
  def setInterpolation(interpolationtype):
205
286
    """
206
 
                Sets the interpolation type  of the curve.
207
 
                @type interpolationtype: string
208
 
                @param interpolationtype: the interpolatrion type of the curve. Can be Constant, Bezier, or Linear.
209
 
                @rtype: PyNone
210
 
                @return: PyNone
 
287
    Sets the interpolation type of the curve.
 
288
    @type interpolationtype: string
 
289
    @param interpolationtype: the interpolation type of the curve. Can be Constant, Bezier, or Linear.
 
290
    @rtype: None
 
291
    @return: None
211
292
    """
212
293
  def getInterpolation():
213
294
    """
214
 
                Gets the interpolation type  of the curve.
215
 
                @rtype: string
216
 
                @return: the interpolation type  of the curve.Can be Constant, Bezier, or Linear.
 
295
    Gets the interpolation type of the curve.
 
296
    @rtype: string
 
297
    @return: the interpolation type of the curve. Can be Constant, Bezier, or Linear.
217
298
    """
218
 
                
 
299
    
219
300
  def addBezier(coordlist):
220
301
    """
221
 
                Adds a Bezier point to a curve.
222
 
                @type coordlist: tuple of (at least) 2 floats
223
 
                @param coordlist: the x and y coordinates of the new Bezier point.
224
 
                @rtype: PyNone
225
 
                @return: PyNone
 
302
    Adds a Bezier point to a curve.
 
303
    @type coordlist: tuple of (at least) 2 floats
 
304
    @param coordlist: the x and y coordinates of the new Bezier point.
 
305
    @rtype: None
 
306
    @return: None
 
307
    """
 
308
 
 
309
  def delBezier(index):
 
310
    """
 
311
    Deletes a Bezier point from a curve.
 
312
    @type index: integer
 
313
    @param index: the index of the Bezier point.  Negative values index from the end of the list.
 
314
    @rtype: None
 
315
    @return: None
226
316
    """
227
317
 
228
 
  def Recalc():
 
318
  def recalc():
229
319
    """
230
 
                Recomputes the curent value of the curve.
231
 
                @rtype: PyNone
232
 
                @return: PyNone
 
320
    Recomputes the curve after changes to control points.
 
321
    @rtype: None
 
322
    @return: None
233
323
    """
234
324
 
235
325
  def getName():
236
326
    """
237
 
                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,ColA,QuatX,QuatY,QuatZ or QuatW. Currently only works with object and action IPO's..
238
 
                @rtype: string
239
 
                @return: the name of the ipo curve.
 
327
    Returns the name of the ipo curve. This name can be:
 
328
      1. Camera Ipo:  Lens, ClSta, ClEnd, Apert, FDist.
 
329
      2. Material Ipo: R, G, B, SpecR, SpecG, SpecB, MirR, MirG, MirB, Ref,
 
330
      Alpha, Emit, Amb, Spec, Hard, SpTra, Ior, Mode, HaSize, Translu,
 
331
      RayMir, FresMir, FresMirI, FresTra, FresTraI, TraGlow, OfsX, OfsY,
 
332
      OfsZ, SizeX, SizeY, SizeZ, texR, texG, texB, DefVar, Col, Nor, Var,
 
333
      Disp.
 
334
      3. Object Ipo: LocX, LocY, LocZ, dLocX, dLocY, dLocZ, RotX, RotY, RotZ,
 
335
      dRotX, dRotY, dRotZ, SizeX, SizeY, SizeZ, dSizeX, dSizeY, dSizeZ,
 
336
      Layer, Time, ColR, ColG, ColB, ColA, FStreng, FFall, Damping,
 
337
      RDamp, Perm.
 
338
      4. Lamp Ipo: Energ, R, G, B, Dist, SpoSi, SpoBl, Quad1, Quad2, HaInt.
 
339
      5. World Ipo: HorR, HorG, HorB, ZenR, ZenG, ZenB, Expos, Misi, MisDi,
 
340
      MisSta, MisHi, StaR, StaG, StaB, StarDi, StarSi, OfsX, OfsY, OfsZ,
 
341
      SizeX, SizeY, SizeZ, TexR, TexG, TexB, DefVar, Col, Nor, Var.
 
342
      5. World Ipo: HorR, HorG, HorB, ZenR, ZenG, ZenB, Expos, Misi, MisDi,
 
343
      MisSta, MisHi, StarR, StarB, StarG, StarDi, StarSi, OfsX, OfsY, OfsZ,i
 
344
      SizeX, SizeY, SizeZ, texR, texG, texB, DefVar, Col, Nor, Var.
 
345
      6. Texture Ipo: NSize, NDepth, NType, Turb, Vnw1, Vnw2, Vnw3, Vnw4,
 
346
      MinkMExp, DistM, ColT, iScale, DistA, MgType, MgH, Lacu, Oct,
 
347
      MgOff, MgGain, NBase1, NBase2.
 
348
      7. Curve Ipo: Speed.
 
349
      8. Key Ipo: Speed, 'Key 1' - 'Key 63'.
 
350
      9. Action Ipo: LocX, LocY, LocZ, SizeX, SizeY, SizeZ, QuatX, QuatY,
 
351
      QuatZ, QuatW.
 
352
      10. Sequence Ipo: Fac.
 
353
      11. Constraint Ipo: Inf.
 
354
 
 
355
    @rtype: string
 
356
    @return: the name of the ipo curve.
240
357
    """
241
358
 
242
359
  def getPoints():
243
360
    """
244
 
                Returns all the points of the ipo curve.
245
 
                @rtype: list of BezTriples
246
 
                @return: the points of the ipo curve.
 
361
    Returns all the points of the ipo curve.
 
362
    @rtype: list of BezTriples
 
363
    @return: the points of the ipo curve.
247
364
    """
248
365
 
249
366
  def evaluate( time ):
250
367
    """
251
 
                Compute the value of the IpoCurve at a particular time.
252
 
                @type time: float
253
 
                @param time: value along the X axis
254
 
                @rtype: float
255
 
                @return: the Y value of the curve at the given time
 
368
    Compute the value of the IpoCurve at a particular time.
 
369
    @type time: float
 
370
    @param time: value along the X axis
 
371
    @rtype: float
 
372
    @return: the Y value of the curve at the given time
256
373
    """
257
374
 
258
375
 
261
378
  The BezTriple object
262
379
  ====================
263
380
  This object gives access to generic data from all beztriple objects in Blender.  If an attribute is listed as being 'read-only' that means you cannot write to it.  Use the set*() methods instead.
264
 
  @cvar pt : a list of the [x,y] coordinates for knot point of this BezTriple.  read-only.
265
 
  @cvar vec : a list of the 3 points [ handle, knot, handle ] that comprise a BezTriple.  See the getTriple() method for an example of the format.  read-only.
 
381
  @ivar pt : a list of the [x,y] coordinates for knot point of this BezTriple.  read-only.
 
382
  @ivar vec : a list of the 3 points [ handle, knot, handle ] that comprise a BezTriple.  See the getTriple() method for an example of the format.  read-only.
266
383
  """
267
384
 
268
385
  def getPoints():
269
386
    """
270
 
                Returns the xy coordinates of the Bezier knot point.
271
 
                @rtype: list of floats
272
 
                @return: list of the x and y coordinates of the Bezier point.
 
387
    Returns the xy coordinates of the Bezier knot point.
 
388
    @rtype: list of floats
 
389
    @return: list of the x and y coordinates of the Bezier point.
273
390
    """
274
391
 
275
392
  def setPoints(newval):
276
393
    """
277
 
                Sets the point xy coordinates of the Bezier knot point.
278
 
                @type newval: tuple of 2 floats
279
 
                @param newval: the x and y coordinates of the new Bezier point.
280
 
                @rtype: PyNone
281
 
                @return: PyNone
 
394
    Sets the point xy coordinates of the Bezier knot point.
 
395
    @type newval: tuple of 2 floats
 
396
    @param newval: the x and y coordinates of the new Bezier point.
 
397
    @rtype: None
 
398
    @return: None
282
399
    """
283
400
 
284
401
  def getTriple():
285
 
      """
286
 
                Returns the x,y,z coordinates for each of the three points that make up a BezierTriple.
287
 
 
288
 
                The return list looks like this [ [H1x, H1y, H1z], [Px, Py, Pz], [H2x, H2y, H2z] ] .
289
 
 
290
 
                Example::
291
 
                  # where bt is of type BezierTriple
292
 
                  #  and h1, p, and h2 are lists of 3 floats
293
 
                  h1, p, h2 = bt.getTriple()
294
 
                
295
 
                @rtype: list consisting of 3 lists of 3 floats
296
 
                @return: handle1, knot, handle2
297
 
       """
 
402
    """
 
403
    Returns the x,y,z coordinates for each of the three points that make up
 
404
    a BezierTriple.
 
405
 
 
406
    The return list looks like this [ [H1x, H1y, H1z], [Px, Py, Pz],
 
407
    [H2x, H2y, H2z] ] .
 
408
 
 
409
    Example::
 
410
      # where bt is of type BezierTriple
 
411
      #  and h1, p, and h2 are lists of 3 floats
 
412
      h1, p, h2 = bt.getTriple()
 
413
    
 
414
    @rtype: list consisting of 3 lists of 3 floats
 
415
    @return: handle1, knot, handle2
 
416
    """