diff options
author | Jacques Guignot <guignot@wanadoo.fr> | 2003-10-27 00:22:24 +0300 |
---|---|---|
committer | Jacques Guignot <guignot@wanadoo.fr> | 2003-10-27 00:22:24 +0300 |
commit | cd0e042dbcc5e411a9ac489426d7a28be34d04d8 (patch) | |
tree | 51d73e261977dd7df575074d00acf1cf9e985659 | |
parent | 0311189fb8a8f6fc04ad92fafc355a81324aa7d8 (diff) |
Update of the documentation files for the new IPO functions
-rw-r--r-- | source/blender/python/api2_2x/doc/Camera.py | 7 | ||||
-rw-r--r-- | source/blender/python/api2_2x/doc/Ipo.py | 11 | ||||
-rw-r--r-- | source/blender/python/api2_2x/doc/Material.py | 7 | ||||
-rw-r--r-- | source/blender/python/api2_2x/doc/World.py | 7 |
4 files changed, 32 insertions, 0 deletions
diff --git a/source/blender/python/api2_2x/doc/Camera.py b/source/blender/python/api2_2x/doc/Camera.py index 02b54dbcf43..a9fd6bf7a4b 100644 --- a/source/blender/python/api2_2x/doc/Camera.py +++ b/source/blender/python/api2_2x/doc/Camera.py @@ -64,6 +64,13 @@ class Camera: Get the name of this Camera Data object. @rtype: string """ + def getIpo(): + """ + Retreives the Ipo (if any) of a camera object + @rtype: Ipo object + @return: the Ipo of the camera object. + """ + def setName(name): """ diff --git a/source/blender/python/api2_2x/doc/Ipo.py b/source/blender/python/api2_2x/doc/Ipo.py index 8399207f15e..6a1f563378f 100644 --- a/source/blender/python/api2_2x/doc/Ipo.py +++ b/source/blender/python/api2_2x/doc/Ipo.py @@ -55,6 +55,17 @@ class Ipo: @rtype: string @return: the name of the Ipo. """ + def getCurve(curvename): + """ + Returns the IpoCurve with the given name. + The possible values for curvename are R,G,B,SpecR,SpecG,SpecB,MirR,MirG,MirB,Ref,Alpha,Emit,Amb,Spec,Hard,SpTra,Ang,Mode,HaSize,OfsX,OfsY,OfsZ,SizeX,SizeY,SizeZ,TexR,TexG,TexB,DefVar,Col,Nor,Var(Material 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 (World 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 (Object Ipo) + Lens,ClSta,ClEnd (Camera Ipo) + @type curvename : string + @rtype: IpoCurve object + @return: the corresponding IpoCurve, or None. + """ def setName(newname): """ Sets the name of the Ipo. diff --git a/source/blender/python/api2_2x/doc/Material.py b/source/blender/python/api2_2x/doc/Material.py index 07a5c6fa68c..8ee69c842b9 100644 --- a/source/blender/python/api2_2x/doc/Material.py +++ b/source/blender/python/api2_2x/doc/Material.py @@ -115,6 +115,13 @@ class Material: that range: if val < Min, then val = Min, if val > Max, then val = Max. """ + + def getIpo(): + """ + Retreives the Ipo (if any) of an material object + @rtype: Ipo object + @return: the Ipo of the material object. + """ def getName(): """ Get the name of this Material object. diff --git a/source/blender/python/api2_2x/doc/World.py b/source/blender/python/api2_2x/doc/World.py index 476ddbdb1a4..67a14fb4428 100644 --- a/source/blender/python/api2_2x/doc/World.py +++ b/source/blender/python/api2_2x/doc/World.py @@ -61,6 +61,13 @@ class World: @return: the name of the world object. """ + def getIpo(): + """ + Retreives the Ipo (if any) of an world object + @rtype: Ipo object + @return: the Ipo of the world object. + """ + def setName(name): """ |