Home       Trees       Index       Help   

Blender

Module Ipo :: Class IpoCurve
[frames | no frames]

Class IpoCurve

The IpoCurve object

This object gives access to generic data from all ipocurves objects in Blender.

Important Notes for Rotation Curves:

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.
Method Summary
PyNone addBezier(coordlist)
Adds a Bezier point to a curve.
float evaluate(time)
Compute the value of the IpoCurve at a particular time.
string getExtrapolation()
Gets the extrapolation type of the curve.
string getInterpolation()
Gets the interpolation type of the curve.
string getName()
Returns the name of the ipo curve.
list of BezTriples getPoints()
Returns all the points of the ipo curve.
PyNone Recalc()
Recomputes the curent value of the curve.
PyNone setExtrapolation(extrapolationtype)
Sets the extrapolation type of the curve.
PyNone setInterpolation(interpolationtype)
Sets the interpolation type of the curve.

Class Variable Summary
  bezierPoints : The list of the Bezier points.
  name: The Curve Data name.

Method Details

addBezier(coordlist)

Adds a Bezier point to a curve.
Parameters:
coordlist - the x and y coordinates of the new Bezier point.
           (type=tuple of (at least) 2 floats)
Returns:
PyNone
           (type=PyNone)

evaluate(time)

Compute the value of the IpoCurve at a particular time.
Parameters:
time - value along the X axis
           (type=float)
Returns:
the Y value of the curve at the given time
           (type=float)

getExtrapolation()

Gets the extrapolation type of the curve.
Returns:
the extrapolation type of the curve.Can be Constant, Extrapolation, Cyclic or Cyclic_extrapolation.
           (type=string)

getInterpolation()

Gets the interpolation type of the curve.
Returns:
the interpolation type of the curve.Can be Constant, Bezier, or Linear.
           (type=string)

getName()

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..
Returns:
the name of the ipo curve.
           (type=string)

getPoints()

Returns all the points of the ipo curve.
Returns:
the points of the ipo curve.
           (type=list of BezTriples)

Recalc()

Recomputes the curent value of the curve.
Returns:
PyNone
           (type=PyNone)

setExtrapolation(extrapolationtype)

Sets the extrapolation type of the curve.
Parameters:
extrapolationtype - the extrapolatrion type of the curve. Can be Constant, Extrapolation, Cyclic or Cyclic_extrapolation.
           (type=string)
Returns:
PyNone
           (type=PyNone)

setInterpolation(interpolationtype)

Sets the interpolation type of the curve.
Parameters:
interpolationtype - the interpolatrion type of the curve. Can be Constant, Bezier, or Linear.
           (type=string)
Returns:
PyNone
           (type=PyNone)

Class Variable Details

bezierPoints

The list of the Bezier points.

name

The Curve Data name.

   Home       Trees       Index       Help   

Blender

Generated by Epydoc 2.0 on Wed May 12 22:11:02 2004 http://epydoc.sf.net