removed a wrong parameter name
[blender.git] / source / blender / python / api2_2x / doc / Ipo.py
1 # Blender.Ipo module and the Ipo PyType object
2
3 """
4 The Blender.Ipo submodule
5
6 This module provides access to the Ipo Data in Blender.
7
8
9 Example::
10
11   import Blender
12   ob = Blender.Ipo.Get('ipo')    # retreives an ipo object
13         ob.setName('ipo1')
14         print ob.name
15         print ipo.getRctf()
16         ipo.setRctf(1,2,3,4)
17         
18 """
19
20 def New (name,idcode):
21   """
22   Creates a new Ipo.
23   @type name: string
24   @type idcode: int
25   @param name: The Ipo's name
26   @param idcode: The Ipo's blocktype. Depends to the object the ipo will be linked.
27   @rtype: Blender Ipo
28   @return: The created Ipo.
29   """
30
31 def Get (name = None):
32   """
33   Get the Ipo from Blender.
34   @type name: string
35   @param name: The name of the requested Ipo, or nothing.
36   @rtype: Blender Ipo or a list of Blender Ipos
37   @return: It depends on the 'name' parameter:
38       - (name): The Ipo with the given name;
39       - ():     A list with all Ipos in the current scene.
40   """
41
42
43 class Ipo:
44   """
45   The Ipo object
46   ==============
47   This object gives access to generic data from all objects in Blender.
48   This object has no attribute.
49   """
50
51   def getName():
52     """
53                 Gets the name of the Ipo.
54                 @rtype: string
55                 @return: the name of the Ipo.
56     """
57   def setName(newname):
58     """
59                 Sets the name of the Ipo.
60                 @type newname: string
61                 @rtype: PyNone
62                 @return: PyNone
63     """
64
65   def getBlocktype():
66     """
67                 Gets the blocktype of the Ipo.
68                 @rtype: int
69                 @return: the blocktype of the Ipo.
70     """
71   def setBlocktype(newblocktype):
72     """
73                 Sets the blocktype of the Ipo.
74                 @type newblocktype: int. This value should not be changed, unless you really know what you do...
75                 @rtype: PyNone
76                 @return: PyNone
77     """
78
79   def getRctf():
80     """
81                 Gets the rctf of the Ipo.
82                 Kind of bounding box...
83                 @rtype: list of floats
84                 @return: the rctf of the Ipo.
85     """
86   def setRctf(newrctf):
87     """
88                 Sets the rctf of the Ipo.
89                 @type newrctf: four floats . This value should not be changed, unless you really know what you do...
90                 @rtype: PyNone
91                 @return: PyNone
92     """
93
94   def getNcurves():
95     """
96                 Gets the number of curves of the Ipo.
97                 @rtype: int 
98                 @return: the number of curve of the Ipo.
99     """
100                 
101   def getCurveBP(curvepos):
102     """
103                 Gets the basepoint of a curve of the ipo.
104                 @type curvepos: int
105                 @param curvepos: the position of the curve.
106                 @rtype: a list of 4 floats
107                 @return: the coordinates of the basepoint, or an error is raised.
108     """
109                 
110   def getBeztriple(curvepos,pointpos):
111     """
112                 Gets a beztriple of the Ipo.
113                 @type curvepos: int
114                 @param curvepos: the position of the curve in the ipo
115                 @type pointpos: int
116                 @param pointpos: the position of the point in the curve.
117                 @rtype: list of 9 floats
118                 @return: the beztriple of the Ipo, or an error is raised.
119     """
120   def setBeztriple(curvepos,pointpos,newbeztriple):
121     """
122                 Sets the beztriple of the Ipo.
123                 @type curvepos: int
124                 @param curvepos: the position of the curve in the ipo
125                 @type pointpos: int
126                 @param pointpos: the position of the point in the curve.
127                 @type newbeztriple: list of 9 floats
128                 @param newbeztriple: the new value for the point
129                 @rtype: PyNone
130                 @return: PyNone
131     """
132                 
133   def getCurvecurval(curvepos):
134     """
135                 Gets the current value of a curve of the Ipo.
136                 @type curvepos: int
137                 @param curvepos: the position of the curve in the ipo
138                 @rtype: float
139                 @return: the current value of the selected curve of the Ipo.
140     """