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

Class Ipo


The Ipo object

This object gives access to generic data from all objects in Blender. It has no attributes.
Method Summary
IpoCurve object addCurve(curvename)
Add a new curve to the IPO object.
float EvaluateCurveOn(curvepos, time)
Gets the current value of a curve of the Ipo.
list of 9 floats getBeztriple(curvepos, pointpos)
Gets a beztriple of the Ipo.
int getBlocktype()
Gets the blocktype of the Ipo.
IpoCurve object getCurve(curvename)
Return the IpoCurve with the given name.
  getCurveBP(curvepos)
This method is unsupported.
float getCurveCurval(curvepos)
Gets the current value of a curve of the Ipo.
list of IpoCurves getCurves()
Gets all the IpoCurves of the Ipo.
string getName()
Gets the name of the Ipo.
int getNcurves()
Gets the number of curves of the Ipo.
list of floats getRctf()
Gets the rctf of the Ipo.
None removeCurve(curvename)
Remove a existing curve from the IPO object.
None setBeztriple(curvepos, pointpos, newbeztriple)
Sets the beztriple of the Ipo.
None setBlocktype(newblocktype)
Sets the blocktype of the Ipo.
None setName(newname)
Sets the name of the Ipo.
None setRctf(newrctf)
Sets the rctf of the Ipo.

Method Details

addCurve(curvename)

Add a new curve to the IPO object. The possible values for 'curvename' are:
  1. Camera Ipo: Lens, ClSta, ClEnd, Apert, FDist.
  2. Material Ipo: R, G, B, SpecR, SpecG, SpecB, MirR, MirG, MirB, Ref, Alpha, Emit, Amb, Spec, Hard, SpTra, Ior, Mode, HaSize, Translu, RayMir, FresMir, FresMirI, FresTra, FresTraI, TraGlow, OfsX, OfsY, OfsZ, SizeX, SizeY, SizeZ, texR, texG, texB, DefVar, Col, Nor, Var, Disp.
  3. 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, FFall, Damping, RDamp, Perm.
  4. Lamp Ipo: Energ, R, G, B, Dist, SpoSi, SpoBl, Quad1, Quad2, HaInt.
  5. 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.
  1. World Ipo: HorR, HorG, HorB, ZenR, ZenG, ZenB, Expos, Misi, MisDi, MisSta, MisHi, StarR, StarB, StarG, StarDi, StarSi, OfsX, OfsY, OfsZ,i SizeX, SizeY, SizeZ, texR, texG, texB, DefVar, Col, Nor, Var.
  2. Texture Ipo: NSize, NDepth, NType, Turb, Vnw1, Vnw2, Vnw3, Vnw4, MinkMExp, DistM, ColT, iScale, DistA, MgType, MgH, Lacu, Oct, MgOff, MgGain, NBase1, NBase2.
  3. Curve Ipo: Speed.
  4. Key Ipo: Speed, 'Key 1' - 'Key 63'.
  5. Action Ipo: LocX, LocY, LocZ, SizeX, SizeY, SizeZ, QuatX, QuatY, QuatZ, QuatW.
  6. Sequence Ipo: Fac.
  7. Constraint Ipo: Inf.
Parameters:
curvename
           (type=string)
Returns:
the corresponding IpoCurve, or None.
           (type=IpoCurve object)

EvaluateCurveOn(curvepos, time)

Gets the current value of a curve of the Ipo.
Parameters:
curvepos - the position of the curve in the ipo
           (type=int)
time - the position of the curve in the ipo
           (type=float)
Returns:
the current value of the selected curve of the Ipo at the given time.
           (type=float)

getBeztriple(curvepos, pointpos)

Gets a beztriple of the Ipo.
Parameters:
curvepos - the position of the curve in the ipo
           (type=int)
pointpos - the position of the point in the curve.
           (type=int)
Returns:
the beztriple of the Ipo, or an error is raised.
           (type=list of 9 floats)

getBlocktype()

Gets the blocktype of the Ipo.
Returns:
the blocktype of the Ipo.
           (type=int)

getCurve(curvename)

Return the IpoCurve with the given name. The possible values for 'curvename' are:
  1. Camera Ipo: Lens, ClSta, ClEnd, Apert, FDist.
  2. Material Ipo: R, G, B, SpecR, SpecG, SpecB, MirR, MirG, MirB, Ref, Alpha, Emit, Amb, Spec, Hard, SpTra, Ior, Mode, HaSize, Translu, RayMir, FresMir, FresMirI, FresTra, FresTraI, TraGlow, OfsX, OfsY, OfsZ, SizeX, SizeY, SizeZ, texR, texG, texB, DefVar, Col, Nor, Var, Disp.
  3. 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, FFall, Damping, RDamp, Perm.
  4. Lamp Ipo: Energ, R, G, B, Dist, SpoSi, SpoBl, Quad1, Quad2, HaInt.
  5. 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.
  1. World Ipo: HorR, HorG, HorB, ZenR, ZenG, ZenB, Expos, Misi, MisDi, MisSta, MisHi, StarR, StarB, StarG, StarDi, StarSi, OfsX, OfsY, OfsZ,i SizeX, SizeY, SizeZ, texR, texG, texB, DefVar, Col, Nor, Var.
  2. Texture Ipo: NSize, NDepth, NType, Turb, Vnw1, Vnw2, Vnw3, Vnw4, MinkMExp, DistM, ColT, iScale, DistA, MgType, MgH, Lacu, Oct, MgOff, MgGain, NBase1, NBase2.
  3. Curve Ipo: Speed.
  4. Key Ipo: Speed, 'Key 1' - 'Key 63'.
  5. Action Ipo: LocX, LocY, LocZ, SizeX, SizeY, SizeZ, QuatX, QuatY, QuatZ, QuatW.
  6. Sequence Ipo: Fac.
  7. Constraint Ipo: Inf.
Parameters:
curvename
           (type=string)
Returns:
the corresponding IpoCurve, or None.
           (type=IpoCurve object)

getCurveBP(curvepos)

This method is unsupported. BPoint Ipo curves are not implemented. Calling this method throws a NotImplementedError exception.
Raises:
NotImplementedError - this method always raises an exception

getCurveCurval(curvepos)

Gets the current value of a curve of the Ipo.
Parameters:
curvepos - the position of the curve in the ipo or the name of the curve
           (type=int or string)
Returns:
the current value of the selected curve of the Ipo.
           (type=float)

getCurves()

Gets all the IpoCurves of the Ipo.
Returns:
A list (possibly void) containing all the IpoCurves associated to the Ipo object.
           (type=list of IpoCurves)

getName()

Gets the name of the Ipo.
Returns:
the name of the Ipo.
           (type=string)

getNcurves()

Gets the number of curves of the Ipo.
Returns:
the number of curve of the Ipo.
           (type=int)

getRctf()

Gets the rctf of the Ipo. Kind of bounding box...
Returns:
the rctf of the Ipo.
           (type=list of floats)

removeCurve(curvename)

Remove a existing curve from the IPO object. See addCurve() for possible values for curvename.
Parameters:
curvename
           (type=string)
Returns:
None.
           (type=None)

setBeztriple(curvepos, pointpos, newbeztriple)

Sets the beztriple of the Ipo.
Parameters:
curvepos - the position of the curve in the ipo
           (type=int)
pointpos - the position of the point in the curve.
           (type=int)
newbeztriple - the new value for the point
           (type=list of 9 floats)
Returns:
None
           (type=None)

setBlocktype(newblocktype)

Sets the blocktype of the Ipo.
Parameters:
newblocktype
           (type=int)
Returns:
None
           (type=None)

Warning: 'newblocktype' should not be changed unless you really know what you are doing ...

setName(newname)

Sets the name of the Ipo.
Parameters:
newname
           (type=string)
Returns:
None
           (type=None)

setRctf(newrctf)

Sets the rctf of the Ipo.
Parameters:
newrctf
           (type=four floats.)
Returns:
None
           (type=None)

Warning: rctf should not be changed unless you really know what you are doing ...


Generated by Epydoc 2.1 on Mon Jun 13 15:31:23 2005 http://epydoc.sf.net