archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity

Ipo doc update. Contributed by Ken Hughes.

Browse Source
This commit is contained in:
Stephen Swaney
2005-05-21 04:20:57 +00:00
parent 0945b86a63
commit 73c162dfef
2 changed files with 60 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
source/blender/python/api2_2x/doc/API_intro.py
View File

@@ -22,7 +22,7 @@ The Blender Python API Reference
- L{Draw} (*) - L{Draw} (*)
- L{Effect} - L{Effect}
- L{Image} (*) - L{Image} (*)
- L{Ipo} - L{Ipo} (*)
- L{Lamp} - L{Lamp}
- L{Lattice} - L{Lattice}
- L{Library} - L{Library}

99
source/blender/python/api2_2x/doc/Ipo.py
View File

@@ -29,7 +29,7 @@ def New (type, name):
@type name: string @type name: string
@param type: The Ipo's blocktype. Depends on the object the ipo will be @param type: The Ipo's blocktype. Depends on the object the ipo will be
linked to. Currently supported types are Object, Camera, World, linked to. Currently supported types are Object, Camera, World,
Material, Texture, Lamp, Curve, Key. Material, Texture, Lamp, Action, Constraint, Sequence, Curve, Key.
@param name: The name for this Ipo. @param name: The name for this Ipo.
@rtype: Blender Ipo @rtype: Blender Ipo
@return: The created Ipo. @return: The created Ipo.
@@ -73,29 +73,33 @@ class Ipo:
Return the IpoCurve with the given name. The possible values for Return the IpoCurve with the given name. The possible values for
'curvename' are: 'curvename' are:
1. Camera Ipo: Lens, ClSta, ClEnd. 1. Camera Ipo: Lens, ClSta, ClEnd, Apert, FDist.
2. Material Ipo: R, G, B, SpecR, SpecG, SpecB, MirR, MirG, MirB, Ref, 2. Material Ipo: R, G, B, SpecR, SpecG, SpecB, MirR, MirG, MirB, Ref,
Alpha, Emit, Amb, Spec, Hard, SpTra, Ang, Mode, HaSize, Translu, Alpha, Emit, Amb, Spec, Hard, SpTra, Ior, Mode, HaSize, Translu,
RayMir, FresMir, FresMirI, FresTra, FresTraI, TraGlow, OfsX, OfsY, RayMir, FresMir, FresMirI, FresTra, FresTraI, TraGlow, OfsX, OfsY,
OfsZ, SizeX, SizeY, SizeZ, TexR, TexG, TexB, DefVar, Col, Nor, Var. OfsZ, SizeX, SizeY, SizeZ, texR, texG, texB, DefVar, Col, Nor, Var,
Disp.
3. Object Ipo: LocX, LocY, LocZ, dLocX, dLocY, dLocZ, RotX, RotY, RotZ, 3. Object Ipo: LocX, LocY, LocZ, dLocX, dLocY, dLocZ, RotX, RotY, RotZ,
dRotX, dRotY, dRotZ, SizeX, SizeY, SizeZ, dSizeX, dSizeY, dSizeZ, dRotX, dRotY, dRotZ, SizeX, SizeY, SizeZ, dSizeX, dSizeY, dSizeZ,
Layer, Time, ColR, ColG, ColB, ColA, FStreng, FFOff, Damping, Layer, Time, ColR, ColG, ColB, ColA, FStreng, FFall, Damping,
RDamp, Perm. RDamp, Perm.
4. Lamp Ipo: Energ, R, G, B, Dist, SpoSi, SpoBl, Quad1, Quad2, HaIntl. 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, 5. World Ipo: HorR, HorG, HorB, ZenR, ZenG, ZenB, Expos, Misi, MisDi,
MisSta, MisHi, StaR, StaG, StaB, StarDi, StarSi, OfsX, OfsY, OfsZ, MisSta, MisHi, StaR, StaG, StaB, StarDi, StarSi, OfsX, OfsY, OfsZ,
SizeX, SizeY, SizeZ, TexR, TexG, TexB, DefVar, Col, Nor, Var. SizeX, SizeY, SizeZ, TexR, TexG, TexB, DefVar, Col, Nor, Var.
5. 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.
6. Texture Ipo: NSize, NDepth, NType, Turb, Vnw1, Vnw2, Vnw3, Vnw4, 6. Texture Ipo: NSize, NDepth, NType, Turb, Vnw1, Vnw2, Vnw3, Vnw4,
MinkMExp, DistM, ColT, iScale, DistA, MgType, MgH, Lacu, Oct, MinkMExp, DistM, ColT, iScale, DistA, MgType, MgH, Lacu, Oct,
MgOff, MgGan, NBase1, NBase2. MgOff, MgGain, NBase1, NBase2.
7. Curve Ipo: Speed. 7. Curve Ipo: Speed.
8. Key Ipo: Speed, 'Key 1' - 'Key 63'. 8. Key Ipo: Speed, 'Key 1' - 'Key 63'.
9. Action Ipo: LocX, LocY, LocZ, SizeX, SizeY, SizeZ, 9. Action Ipo: LocX, LocY, LocZ, SizeX, SizeY, SizeZ, QuatX, QuatY,
QuatX, QuatY, QuatZ, QuatW. QuatZ, QuatW.
10. Sequence Ipo: Fac. 10. Sequence Ipo: Fac.
11. Constraint Ipo: Inf. 11. Constraint Ipo: Inf.
@type curvename : string @type curvename : string
@rtype: IpoCurve object @rtype: IpoCurve object
@return: the corresponding IpoCurve, or None. @return: the corresponding IpoCurve, or None.
@@ -104,23 +108,33 @@ class Ipo:
def addCurve(curvename): def addCurve(curvename):
""" """
Add a new curve to the IPO object. The possible values for 'curvename' are: Add a new curve to the IPO object. The possible values for 'curvename' are:
1. Object Ipo: LocX, LocY, LocZ, dLocX, dLocY, dLocZ, RotX, RotY, RotZ, 1. Camera Ipo: Lens, ClSta, ClEnd, Apert, FDist.
dRotX, dRotY, dRotZ, SizeX, SizeY, SizeZ, dSizeX, dSizeY, dSizeZ, 2. Material Ipo: R, G, B, SpecR, SpecG, SpecB, MirR, MirG, MirB, Ref,
Layer, Time, ColR, ColG, ColB, ColA, FStreng, FFOff, Damping, RDamp, Alpha, Emit, Amb, Spec, Hard, SpTra, Ior, Mode, HaSize, Translu,
Perm; RayMir, FresMir, FresMirI, FresTra, FresTraI, TraGlow, OfsX, OfsY,
2. Camera Ipo: Lens, ClSta, ClEnd; OfsZ, SizeX, SizeY, SizeZ, texR, texG, texB, DefVar, Col, Nor, Var,
3. Lamp Ipo: Energ, R, G, B, Dist, SpoSi, SpoBl, Quad1, Quad2, HaIntl Disp.
4. Texture Ipo: NSize, NDepth, NType, Turb, Vnw1, Vnw2, Vnw3, Vnw4, 3. Object Ipo: LocX, LocY, LocZ, dLocX, dLocY, dLocZ, RotX, RotY, RotZ,
MinkMExp, DistM, ColT, iScale, DistA, MgType, MgH, Lacu, Oct, dRotX, dRotY, dRotZ, SizeX, SizeY, SizeZ, dSizeX, dSizeY, dSizeZ,
MgOff, MgGan, NBase1, NBase2; 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, 5. World Ipo: HorR, HorG, HorB, ZenR, ZenG, ZenB, Expos, Misi, MisDi,
MisSta, MisHi, StaR, StaG, StaB, StarDi, StarSi, OfsX, OfsY, OfsZ, MisSta, MisHi, StaR, StaG, StaB, StarDi, StarSi, OfsX, OfsY, OfsZ,
SizeX, SizeY, SizeZ, TexR, TexG, TexB, DefVar, Col, Nor, Var; SizeX, SizeY, SizeZ, TexR, TexG, TexB, DefVar, Col, Nor, Var.
6. Material Ipo: R, G, B, SpecR, SpecG, SpecB, MirR, MirG, MirB, Ref, 5. World Ipo: HorR, HorG, HorB, ZenR, ZenG, ZenB, Expos, Misi, MisDi,
Alpha, Emit, Amb, Spec, Hard, SpTra, Ior, Mode, HaSize, Translu, MisSta, MisHi, StarR, StarB, StarG, StarDi, StarSi, OfsX, OfsY, OfsZ,i
RayMir, FresMir, FresMirI, FresTra, FresTraI, TraGlow; SizeX, SizeY, SizeZ, texR, texG, texB, DefVar, Col, Nor, Var.
7. Curve Ipo: Speed; 6. Texture Ipo: NSize, NDepth, NType, Turb, Vnw1, Vnw2, Vnw3, Vnw4,
8. Key Ipo: Speed, 'Key 1' - 'Key 31' MinkMExp, DistM, ColT, iScale, DistA, MgType, MgH, Lacu, Oct,
MgOff, MgGain, NBase1, NBase2.
7. Curve Ipo: Speed.
8. Key Ipo: Speed, 'Key 1' - 'Key 63'.
9. Action Ipo: LocX, LocY, LocZ, SizeX, SizeY, SizeZ, QuatX, QuatY,
QuatZ, QuatW.
10. Sequence Ipo: Fac.
11. Constraint Ipo: Inf.
@type curvename : string @type curvename : string
@rtype: IpoCurve object @rtype: IpoCurve object
@return: the corresponding IpoCurve, or None. @return: the corresponding IpoCurve, or None.
@@ -311,28 +325,33 @@ class IpoCurve:
def getName(): def getName():
""" """
Returns the name of the ipo curve. This name can be: Returns the name of the ipo curve. This name can be:
1. Camera Ipo: Lens, ClSta, ClEnd. 1. Camera Ipo: Lens, ClSta, ClEnd, Apert, FDist.
2. Material Ipo: R, G, B, SpecR, SpecG, SpecB, MirR, MirG, MirB, Ref, 2. Material Ipo: R, G, B, SpecR, SpecG, SpecB, MirR, MirG, MirB, Ref,
Alpha, Emit, Amb, Spec, Hard, SpTra, Ang, Mode, HaSize, Translu, Alpha, Emit, Amb, Spec, Hard, SpTra, Ior, Mode, HaSize, Translu,
RayMir, FresMir, FresMirI, FresTra, FresTraI, TraGlow, OfsX, OfsY, RayMir, FresMir, FresMirI, FresTra, FresTraI, TraGlow, OfsX, OfsY,
OfsZ, SizeX, SizeY, SizeZ, TexR, TexG, TexB, DefVar, Col, Nor, Var; OfsZ, SizeX, SizeY, SizeZ, texR, texG, texB, DefVar, Col, Nor, Var,
Disp.
3. Object Ipo: LocX, LocY, LocZ, dLocX, dLocY, dLocZ, RotX, RotY, RotZ, 3. Object Ipo: LocX, LocY, LocZ, dLocX, dLocY, dLocZ, RotX, RotY, RotZ,
dRotX, dRotY, dRotZ, SizeX, SizeY, SizeZ, dSizeX, dSizeY, dSizeZ, dRotX, dRotY, dRotZ, SizeX, SizeY, SizeZ, dSizeX, dSizeY, dSizeZ,
Layer, Time, ColR, ColG, ColB, ColA, FStreng, FFOff, Damping, Layer, Time, ColR, ColG, ColB, ColA, FStreng, FFall, Damping,
RDamp, Perm; RDamp, Perm.
4. Lamp Ipo: Energ, R, G, B, Dist, SpoSi, SpoBl, Quad1, Quad2, HaIntl; 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, 5. World Ipo: HorR, HorG, HorB, ZenR, ZenG, ZenB, Expos, Misi, MisDi,
MisSta, MisHi, StaR, StaG, StaB, StarDi, StarSi, OfsX, OfsY, OfsZ, MisSta, MisHi, StaR, StaG, StaB, StarDi, StarSi, OfsX, OfsY, OfsZ,
SizeX, SizeY, SizeZ, TexR, TexG, TexB, DefVar, Col, Nor, Var; SizeX, SizeY, SizeZ, TexR, TexG, TexB, DefVar, Col, Nor, Var.
5. 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.
6. Texture Ipo: NSize, NDepth, NType, Turb, Vnw1, Vnw2, Vnw3, Vnw4, 6. Texture Ipo: NSize, NDepth, NType, Turb, Vnw1, Vnw2, Vnw3, Vnw4,
MinkMExp, DistM, ColT, iScale, DistA, MgType, MgH, Lacu, Oct, MinkMExp, DistM, ColT, iScale, DistA, MgType, MgH, Lacu, Oct,
MgOff, MgGan, NBase1, NBase2; MgOff, MgGain, NBase1, NBase2.
7. Curve Ipo: Speed; 7. Curve Ipo: Speed.
8. Key Ipo: Speed, 'Key 1' - 'Key 63'; 8. Key Ipo: Speed, 'Key 1' - 'Key 63'.
9. Action Ipo: LocX, LocY, LocZ, SizeX, SizeY, SizeZ, 9. Action Ipo: LocX, LocY, LocZ, SizeX, SizeY, SizeZ, QuatX, QuatY,
QuatX, QuatY, QuatZ, QuatW; QuatZ, QuatW.
10.Sequence Ipo: Fac; 10. Sequence Ipo: Fac.
11.Constraint Ipo: Inf. 11. Constraint Ipo: Inf.
@rtype: string @rtype: string
@return: the name of the ipo curve. @return: the name of the ipo curve.
""" """