Module Ipo :: Class IpoCurve

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
None	`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.
None	`Recalc()` Recomputes the curent value of the curve.
None	`setExtrapolation(extrapolationtype)` Sets the extrapolation type of the curve.
None	`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:: None
(type=None)

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:

Camera Ipo: Lens, ClSta, ClEnd.
Material Ipo: R, G, B, SpecR, SpecG, SpecB, MirR, MirG, MirB, Ref, Alpha, Emit, Amb, Spec, Hard, SpTra, Ang, Mode, HaSize, Translu, RayMir, FresMir, FresMirI, FresTra, FresTraI, TraGlow, OfsX, OfsY, OfsZ, SizeX, SizeY, SizeZ, TexR, TexG, TexB, DefVar, Col, Nor, Var;
Object Ipo: LocX, LocY, LocZ, dLocX, dLocY, dLocZ, RotX, RotY, RotZ, dRotX, dRotY, dRotZ, SizeX, SizeY, SizeZ, dSizeX, dSizeY, dSizeZ, Layer, Time, ColR, ColG, ColB, ColA, FStreng, FFOff, Damping, RDamp, Perm;
Lamp Ipo: Energ, R, G, B, Dist, SpoSi, SpoBl, Quad1, Quad2, HaIntl;
World Ipo: 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;
Texture Ipo: NSize, NDepth, NType, Turb, Vnw1, Vnw2, Vnw3, Vnw4, MinkMExp, DistM, ColT, iScale, DistA, MgType, MgH, Lacu, Oct, MgOff, MgGan, NBase1, NBase2;
Curve Ipo: Speed;
Key Ipo: Speed, 'Key 1' - 'Key 31';
Action Ipo: LocX, LocY, LocZ, SizeX, SizeY, SizeZ, QuatX, QuatY, QuatZ, QuatW; 10.Sequence Ipo: Fac; 11.Constraint Ipo: Inf.

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:: None
(type=None)

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:: None
(type=None)

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:: None
(type=None)

Class Variable Details

bezierPoints

The list of the Bezier points.

name

The Curve Data name.

Generated by Epydoc 2.1 on Tue Jan 4 13:43:06 2005

http://epydoc.sf.net