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