diff options
author | Stephen Swaney <sswaney@centurytel.net> | 2005-05-21 08:20:57 +0400 |
---|---|---|
committer | Stephen Swaney <sswaney@centurytel.net> | 2005-05-21 08:20:57 +0400 |
commit | 73c162dfef74ee2eaef2f86380175ba5c4e4fa55 (patch) | |
tree | ab5b901c47183269e64e22edd35849c3e6724b31 /source/blender | |
parent | 0945b86a636f68306d7e4480c187eb323c6aceb9 (diff) |
Ipo doc update. Contributed by Ken Hughes.
Diffstat (limited to 'source/blender')
-rw-r--r-- | source/blender/python/api2_2x/doc/API_intro.py | 2 | ||||
-rw-r--r-- | source/blender/python/api2_2x/doc/Ipo.py | 99 |
2 files changed, 60 insertions, 41 deletions
diff --git a/source/blender/python/api2_2x/doc/API_intro.py b/source/blender/python/api2_2x/doc/API_intro.py index e75f63d9923..813770a1b65 100644 --- a/source/blender/python/api2_2x/doc/API_intro.py +++ b/source/blender/python/api2_2x/doc/API_intro.py @@ -22,7 +22,7 @@ The Blender Python API Reference - L{Draw} (*) - L{Effect} - L{Image} (*) - - L{Ipo} + - L{Ipo} (*) - L{Lamp} - L{Lattice} - L{Library} diff --git a/source/blender/python/api2_2x/doc/Ipo.py b/source/blender/python/api2_2x/doc/Ipo.py index ae11208b4ac..b0b269db6cd 100644 --- a/source/blender/python/api2_2x/doc/Ipo.py +++ b/source/blender/python/api2_2x/doc/Ipo.py @@ -29,7 +29,7 @@ def New (type, name): @type name: string @param type: The Ipo's blocktype. Depends on the object the ipo will be 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. @rtype: Blender Ipo @return: The created Ipo. @@ -73,29 +73,33 @@ class Ipo: Return the IpoCurve with the given name. The possible values for '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, - 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, - 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, 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. - 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, MisSta, MisHi, StaR, StaG, StaB, StarDi, StarSi, OfsX, OfsY, OfsZ, 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, MinkMExp, DistM, ColT, iScale, DistA, MgType, MgH, Lacu, Oct, - MgOff, MgGan, NBase1, NBase2. + 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. + 9. Action Ipo: LocX, LocY, LocZ, SizeX, SizeY, SizeZ, QuatX, QuatY, + QuatZ, QuatW. 10. Sequence Ipo: Fac. 11. Constraint Ipo: Inf. - + @type curvename : string @rtype: IpoCurve object @return: the corresponding IpoCurve, or None. @@ -104,23 +108,33 @@ class Ipo: def addCurve(curvename): """ 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, - dRotX, dRotY, dRotZ, SizeX, SizeY, SizeZ, dSizeX, dSizeY, dSizeZ, - Layer, Time, ColR, ColG, ColB, ColA, FStreng, FFOff, Damping, RDamp, - Perm; - 2. Camera Ipo: Lens, ClSta, ClEnd; - 3. Lamp Ipo: Energ, R, G, B, Dist, SpoSi, SpoBl, Quad1, Quad2, HaIntl - 4. Texture Ipo: NSize, NDepth, NType, Turb, Vnw1, Vnw2, Vnw3, Vnw4, - MinkMExp, DistM, ColT, iScale, DistA, MgType, MgH, Lacu, Oct, - MgOff, MgGan, NBase1, NBase2; + 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; - 6. 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; - 7. Curve Ipo: Speed; - 8. Key Ipo: Speed, 'Key 1' - 'Key 31' + MisSta, MisHi, StaR, StaG, StaB, StarDi, StarSi, OfsX, OfsY, OfsZ, + 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, + 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 @rtype: IpoCurve object @return: the corresponding IpoCurve, or None. @@ -311,28 +325,33 @@ class IpoCurve: def getName(): """ 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, - 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, - 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, dRotX, dRotY, dRotZ, SizeX, SizeY, SizeZ, dSizeX, dSizeY, dSizeZ, - Layer, Time, ColR, ColG, ColB, ColA, FStreng, FFOff, Damping, - RDamp, Perm; - 4. Lamp Ipo: Energ, R, G, B, Dist, SpoSi, SpoBl, Quad1, Quad2, HaIntl; + 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; + 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, MinkMExp, DistM, ColT, iScale, DistA, MgType, MgH, Lacu, Oct, - MgOff, MgGan, 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. + 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. + @rtype: string @return: the name of the ipo curve. """ |