- small updates to scripts and bpython docs, also fixed two warnings;
[blender-staging.git] / source / blender / python / api2_2x / doc / Metaball.py
1 # Blender.Metaball module and the Metaball PyType metaball
2
3 """
4 The Blender.Metaball submodule
5
6 This module provides access to the B{Metaball Data} in Blender.
7
8 Example::
9  import Blender
10
11  ob =  Blender.Object.New("Mball","mb")
12  mb = Blender.Metaball.New()
13  for i in range(20):
14    mb.addMetaelem([0, float(i),1.0,1.0, 2.0,1,2.0,1.0,1.0,1.0])
15  ob.link(mb)
16  sc = Blender.Scene.getCurrent()
17  sc.link(ob)
18 """
19
20
21 def New (name):
22   """
23   Creates a new Metaball.
24   @type name: string
25   @param name: The name of the metaball. If this parameter is not given (or not valid) blender will assign a name to the metaball.
26   @rtype: Blender Metaball
27   @return: The created Metaball.
28   """
29
30 def Get (name):
31   """
32   Get the Metaball from Blender.
33   @type name: string
34   @param name: The name of the requested Metaball.
35   @rtype: Blender Metaball or a list of Blender Metaballs
36   @return: It depends on the 'name' parameter:
37       - (name): The Metaball with the given name;
38       - ():     A list with all Metaballs in the current scene.
39   """
40
41 class Metaball:
42   """
43   The Metaball object
44   ===================
45   This metaball gives access to generic data from all metaballs in Blender.
46   @cvar name: The name of the metaball.
47   @cvar loc: The location of the metaball.
48   @cvar rot: The rotation of the metaball.
49   @cvar size: The size of the metaball.
50   """
51
52   def addMetaelem(paramslist):
53     """
54     Add a new metaelem to this metaball. 'paramslist' must have the
55     following ten elements:
56       - param 1: int - metaelem type:
57         - 0 for a sphere
58         - 1 for a tubex
59         - 2 for a tubey
60         - 3 for a tubez
61         - 4 for a regular tube
62         - 5 for a plane
63         - 6 for an ellipsoid
64         - 7 for a cube
65       - params 2,3,4: floats - the x, y and z coordinates of the metaelem.
66       - param 5: float - the rad value of the metaelem.
67       - param 6: int - the lay value.
68       - param 7: float - the s value of the metaelem.
69       - params 8,9,10: floats - the expx, expy and expz values of the metaelem.
70     @type paramslist: list
71     @param paramslist: the list of the parameters for creating a new metaelem.
72
73     @rtype: None
74     @return:  None
75     """
76     
77   def getName():
78     """
79     Retrieves the name of a metaball object.
80     @rtype: string
81     @return:  the name of a metaball object.
82     """
83
84   
85   def setName(name):
86     """
87     Sets the name of a metaball object.
88     @type name: string
89     @param name : the new name
90     @rtype: None
91     @return:  None
92     """
93
94   
95
96   def getBbox():
97     """
98     Retrieves the bounding box of a metaball object.
99     @rtype: a list of 24 floats(8 points, 3 coordinates)
100     @return:  the bounding box of a metaball object
101     """
102
103   def getNMetaElems():
104     """
105     Retrieves the number of metaelems (elementary spheres or cylinders) of a metaball object.
106     @rtype: int
107     @return: number of metaelems of a metaball object
108     """
109
110   def getLoc():
111     """
112     Retrieves the location of a metaball object.
113     @rtype: a list of 3 floats
114     @return: location of a metaball object
115     """
116
117   def setLoc(newloc):
118     """
119     Sets the location of a metaball object.
120     @type newloc: list of 3 floats
121     @param newloc: the new location
122     @rtype: None
123     @return: None
124     """
125
126   def getRot():
127     """
128     Retrieves the rotation of a metaball object.
129     @rtype: a list of 3 floats
130     @return: rotation of a metaball object
131     """
132
133   def setRot(newrot):
134     """
135     Sets the rotation of a metaball object.
136     @type newrot: list of 3 floats
137     @param newrot: the new rotation
138     @rtype: None
139     @return: None
140     """
141
142   def getSize():
143     """
144     Retrieves the size of a metaball object.
145     @rtype: a list of 3 floats
146     @return: size a metaball object
147     """
148
149   def setSize(newsize):
150     """
151     Sets the size of a metaball object.
152     @type newsize: list of 3 floats
153     @param newsize: the new size
154     @rtype: None
155     @return: None
156     """
157
158   def getWiresize():
159     """
160     Retrieves the wiresize of a metaball object.
161     @rtype: float
162     @return: wire size a metaball object
163     """
164
165   def setWiresize(newsize):
166     """
167     Sets the wire size of a metaball object.
168     @type newsize: float
169     @param newsize: the new size
170     @rtype: None
171     @return: None
172     """
173   def getRendersize():
174     """
175     Retrieves the rendersize of a metaball object.
176     @rtype: float
177     @return: render size a metaball object
178     """
179
180   def setRendersize(newsize):
181     """
182     Sets the render size of a metaball object.
183     @type newsize: float
184     @param newsize: the new size
185     @rtype: None
186     @return: None
187     """
188
189   def getThresh():
190     """
191     Retrieves the threshold of a metaball object.
192     @rtype: float
193     @return: threshold of the metaball object
194     """
195
196   def setThresh(threshold):
197     """
198     Sets the threshold of a metaball object.
199     @type threshold: float
200     @param threshold: the new size
201     @rtype: None
202     @return: None
203     """
204
205   def getMetadata(name,num):
206     """
207     Retrieves the metadata of a metaball object. A metaball is composed of one or several elementary objects, spheres or cylinders, which interact to create the smooth surface everybody knows. The get/set Metadata functions allow users to read/write the parameters of these elementary objects, called metaelements.
208     @type name: string
209     @param name: the name of the property to be read. The accepted values are :"type", "x", "y", "z", "expx", "expy", "expz", "rad", "rad2", "s", "len".
210     @type num: int
211     @param num: the position of the metaelem to be accessed.
212     @rtype: float
213     @return: the metaelement parameter value, generally a float, except for the parameter "type", which returns an int.
214     """
215
216   def setMetadata(name,num,val):
217     """
218     The setMetadata function has the same semantics as getMetadata,   except that it needs  the parameter value, and always returns None.
219     @type name: string
220     @param name: the name of the property to be read. The accepted values are :"type", "x", "y", "z", "expx", "expy", "expz", "rad", "rad2", "s", "len".
221     @type num: int
222     @param num: the position of the metaelem to be accessed.
223     @type val: float, except if name is "type".
224     @param val: the new value of the parameter.
225     @rtype: None
226     @return: None
227     """
228
229   def getMetatype(pos):
230     """
231     Retrieves the type of a metaelem object.
232     @type pos: int
233     @param pos: the position of the metaelement
234     @rtype: int
235     @return: type of the metaelem object
236     """
237
238   def setMetatype(pos,newtype):
239     """
240     Sets the type of a metaelem object.
241     @type pos: int
242     @param pos: the position of the metaelement
243     @type newtype: int
244     @param newtype: the new type
245     @rtype: None
246     @return: None
247     """
248
249   def getMetax(pos):
250     """
251     Retrieves the x parameter of a metaelem object.
252     @type pos: int
253     @param pos: the position of the metaelement
254     @rtype: float
255     @return: x parameter of the metaelem object
256     """
257
258   def setMetax(pos,newx):
259     """
260     Sets the x parameter of a metaelem object.
261     @type pos: int
262     @param pos: the position of the metaelement
263     @type newx: float
264     @param newx: the new x parameter value
265     @rtype: None
266     @return: None
267     """
268
269   def getMetay(pos):
270     """
271     Retrieves the y parameter of a metaelem object.
272     @type pos: int
273     @param pos: the position of the metaelement
274     @rtype: float
275     @return: y parameter of the metaelem object
276     """
277
278   def setMetay(pos,newy):
279     """
280     Sets the y parameter of a metaelem object.
281     @type pos: int
282     @param pos: the position of the metaelement
283     @type newy: float
284     @param newy: the new y parameter value
285     @rtype: None
286     @return: None
287     """
288
289   def getMetaz(pos):
290     """
291     Retrieves the z parameter of a metaelem object.
292     @type pos: int
293     @param pos: the position of the metaelement
294     @rtype: float
295     @return: z parameter of the metaelem object
296     """
297
298   def setMetaz(pos,newz):
299     """
300     Sets the z parameter of a metaelem object.
301     @type pos: int
302     @param pos: the position of the metaelement
303     @type newz: float
304     @param newz: the new z parameter value
305     @rtype: None
306     @return: None
307     """
308
309
310   def getMetas(pos):
311     """
312     Retrieves the s parameter of a metaelem object.
313     @type pos: int
314     @param pos: the position of the metaelement
315     @rtype: float
316     @return: s parameter of the metaelem object
317     """
318
319   def setMetas(pos,news):
320     """
321     Sets the s parameter of a metaelem object.
322     @type pos: int
323     @param pos: the position of the metaelement
324     @type news: float
325     @param news: the new x parameter value
326     @rtype: None
327     @return: None
328     """
329
330   def getMetalen(pos):
331     """
332     Retrieves the len parameter of a metaelem object.
333     @type pos: int
334     @param pos: the position of the metaelement
335     @rtype: float
336     @return: len parameter of the metaelem object
337     """
338
339   def setMetalen(pos,newlen):
340     """
341     Sets the len parameter of a metaelem object.
342     @type pos: int
343     @param pos: the position of the metaelement
344     @type newlen: float
345     @param newlen: the new x parameter value
346     @rtype: None
347     @return: None
348     """