diff options
author | Willian Padovani Germano <wpgermano@gmail.com> | 2004-06-10 19:14:49 +0400 |
---|---|---|
committer | Willian Padovani Germano <wpgermano@gmail.com> | 2004-06-10 19:14:49 +0400 |
commit | a23c6a71da4feea2e036928d260630cb26854ab1 (patch) | |
tree | 21d3f9037043436de8b8d00d2d3ec561d69f4c7c /source/blender/python/api2_2x/doc/Metaball.py | |
parent | a6d077bae243eef5f8826b2c7b27bd297428d7d4 (diff) |
- small updates to scripts and bpython docs, also fixed two warnings;
- added function Blender.sys.exists(path) to check if a given file exists;
- forgot to mention: in my previous commit the blender.html file was also updated slightly.
Diffstat (limited to 'source/blender/python/api2_2x/doc/Metaball.py')
-rw-r--r-- | source/blender/python/api2_2x/doc/Metaball.py | 220 |
1 files changed, 110 insertions, 110 deletions
diff --git a/source/blender/python/api2_2x/doc/Metaball.py b/source/blender/python/api2_2x/doc/Metaball.py index bd772d7cd31..e4d87195134 100644 --- a/source/blender/python/api2_2x/doc/Metaball.py +++ b/source/blender/python/api2_2x/doc/Metaball.py @@ -5,16 +5,16 @@ The Blender.Metaball submodule This module provides access to the B{Metaball Data} in Blender. -Example: -import Blender - -ob = Blender.Object.New("Mball","mb") -mb = Blender.Metaball.New() -for i in range(20): - mb.addMetaelem([0, float(i),1.0,1.0, 2.0,1,2.0,1.0,1.0,1.0]) -ob.link(mb) -sc = Blender.Scene.getCurrent() -sc.link(ob) +Example:: + import Blender + + ob = Blender.Object.New("Mball","mb") + mb = Blender.Metaball.New() + for i in range(20): + mb.addMetaelem([0, float(i),1.0,1.0, 2.0,1,2.0,1.0,1.0,1.0]) + ob.link(mb) + sc = Blender.Scene.getCurrent() + sc.link(ob) """ @@ -38,7 +38,6 @@ def Get (name): - (): A list with all Metaballs in the current scene. """ - class Metaball: """ The Metaball object @@ -49,157 +48,158 @@ class Metaball: @cvar rot: The rotation of the metaball. @cvar size: The size of the metaball. """ - def addMetaelem(paramslist): - """ - Sets the name of a metaball object - @type name: list - @param name : the list of the parameters for creating a new metaelem - This list has ten elements : - param 1 : int : metaelem type - 0 for a sphere - 1 for a tubex - 2 for a tubey - 3 for a tubez - 4 for a regular tube - 5 for a plane - 6 for an ellipsoid - 7 for a cube - params 2,3,4 : floats, the x, y and z coordinates of the metaelem - param 5 : float, the rad value of the metaelem - param 6 : int, the lay value. - param 7 : float the s value of the metaelem - params 8,9,10 : the expx, expy and expz values of the metaelem. - - @rtype: PyNone - @return: PyNone - """ - + + def addMetaelem(paramslist): + """ + Add a new metaelem to this metaball. 'paramslist' must have the + following ten elements: + - param 1: int - metaelem type: + - 0 for a sphere + - 1 for a tubex + - 2 for a tubey + - 3 for a tubez + - 4 for a regular tube + - 5 for a plane + - 6 for an ellipsoid + - 7 for a cube + - params 2,3,4: floats - the x, y and z coordinates of the metaelem. + - param 5: float - the rad value of the metaelem. + - param 6: int - the lay value. + - param 7: float - the s value of the metaelem. + - params 8,9,10: floats - the expx, expy and expz values of the metaelem. + @type paramslist: list + @param paramslist: the list of the parameters for creating a new metaelem. + + @rtype: None + @return: None + """ + def getName(): """ - Retreives the name of a metaball object + Retrieves the name of a metaball object. @rtype: string - @return: the name of a metaball object + @return: the name of a metaball object. """ - + def setName(name): """ - Sets the name of a metaball object + Sets the name of a metaball object. @type name: string @param name : the new name - @rtype: PyNone - @return: PyNone + @rtype: None + @return: None """ - + def getBbox(): """ - Retreives the bounding box of a metaball object + Retrieves the bounding box of a metaball object. @rtype: a list of 24 floats(8 points, 3 coordinates) @return: the bounding box of a metaball object """ def getNMetaElems(): """ - Retreives the number of metaelems (elementary spheres or cylinders) of a metaball object + Retrieves the number of metaelems (elementary spheres or cylinders) of a metaball object. @rtype: int @return: number of metaelems of a metaball object """ def getLoc(): """ - Retreives the location of a metaball object + Retrieves the location of a metaball object. @rtype: a list of 3 floats - @return: locationof a metaball object + @return: location of a metaball object """ def setLoc(newloc): """ - Sets the location of a metaball object + Sets the location of a metaball object. @type newloc: list of 3 floats @param newloc: the new location - @rtype: PyNone - @return: PyNone + @rtype: None + @return: None """ def getRot(): """ - Retreives the rotation of a metaball object + Retrieves the rotation of a metaball object. @rtype: a list of 3 floats - @return: rotationof a metaball object + @return: rotation of a metaball object """ def setRot(newrot): """ - Sets the rotation of a metaball object + Sets the rotation of a metaball object. @type newrot: list of 3 floats @param newrot: the new rotation - @rtype: PyNone - @return: PyNone + @rtype: None + @return: None """ def getSize(): """ - Retreives the size of a metaball object + Retrieves the size of a metaball object. @rtype: a list of 3 floats @return: size a metaball object """ def setSize(newsize): """ - Sets the size of a metaball object + Sets the size of a metaball object. @type newsize: list of 3 floats @param newsize: the new size - @rtype: PyNone - @return: PyNone + @rtype: None + @return: None """ def getWiresize(): """ - Retreives the wiresize of a metaball object + Retrieves the wiresize of a metaball object. @rtype: float @return: wire size a metaball object """ def setWiresize(newsize): """ - Sets the wire size of a metaball object + Sets the wire size of a metaball object. @type newsize: float @param newsize: the new size - @rtype: PyNone - @return: PyNone + @rtype: None + @return: None """ def getRendersize(): """ - Retreives the rendersize of a metaball object + Retrieves the rendersize of a metaball object. @rtype: float @return: render size a metaball object """ def setRendersize(newsize): """ - Sets the render size of a metaball object + Sets the render size of a metaball object. @type newsize: float @param newsize: the new size - @rtype: PyNone - @return: PyNone + @rtype: None + @return: None """ def getThresh(): """ - Retreives the threshold of a metaball object + Retrieves the threshold of a metaball object. @rtype: float @return: threshold of the metaball object """ def setThresh(threshold): """ - Sets the threshold of a metaball object + Sets the threshold of a metaball object. @type threshold: float @param threshold: the new size - @rtype: PyNone - @return: PyNone + @rtype: None + @return: None """ def getMetadata(name,num): @@ -215,134 +215,134 @@ class Metaball: def setMetadata(name,num,val): """ - The setMetadata function has the same semantics as getMetadata, except that it needs the parameter value, and always returns PyNone. + The setMetadata function has the same semantics as getMetadata, except that it needs the parameter value, and always returns None. @type name: string @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". @type num: int @param num: the position of the metaelem to be accessed. @type val: float, except if name is "type". @param val: the new value of the parameter. - @rtype: PyNone - @return: PyNone + @rtype: None + @return: None """ def getMetatype(pos): """ - Retreives the type of a metaelem object + Retrieves the type of a metaelem object. @type pos: int - @param : the position of the metaelement + @param pos: the position of the metaelement @rtype: int @return: type of the metaelem object """ def setMetatype(pos,newtype): """ - Sets the type of a metaelem object + Sets the type of a metaelem object. @type pos: int - @param : the position of the metaelement + @param pos: the position of the metaelement @type newtype: int @param newtype: the new type - @rtype: PyNone - @return: PyNone + @rtype: None + @return: None """ def getMetax(pos): """ - Retreives the x parameter of a metaelem object + Retrieves the x parameter of a metaelem object. @type pos: int - @param : the position of the metaelement + @param pos: the position of the metaelement @rtype: float @return: x parameter of the metaelem object """ def setMetax(pos,newx): """ - Sets the x parameter of a metaelem object + Sets the x parameter of a metaelem object. @type pos: int - @param : the position of the metaelement + @param pos: the position of the metaelement @type newx: float @param newx: the new x parameter value - @rtype: PyNone - @return: PyNone + @rtype: None + @return: None """ def getMetay(pos): """ - Retreives the y parameter of a metaelem object + Retrieves the y parameter of a metaelem object. @type pos: int - @param : the position of the metaelement + @param pos: the position of the metaelement @rtype: float @return: y parameter of the metaelem object """ def setMetay(pos,newy): """ - Sets the y parameter of a metaelem object + Sets the y parameter of a metaelem object. @type pos: int - @param : the position of the metaelement + @param pos: the position of the metaelement @type newy: float @param newy: the new y parameter value - @rtype: PyNone - @return: PyNone + @rtype: None + @return: None """ def getMetaz(pos): """ - Retreives the z parameter of a metaelem object + Retrieves the z parameter of a metaelem object. @type pos: int - @param : the position of the metaelement + @param pos: the position of the metaelement @rtype: float @return: z parameter of the metaelem object """ def setMetaz(pos,newz): """ - Sets the z parameter of a metaelem object + Sets the z parameter of a metaelem object. @type pos: int - @param : the position of the metaelement + @param pos: the position of the metaelement @type newz: float @param newz: the new z parameter value - @rtype: PyNone - @return: PyNone + @rtype: None + @return: None """ def getMetas(pos): """ - Retreives the s parameter of a metaelem object + Retrieves the s parameter of a metaelem object. @type pos: int - @param : the position of the metaelement + @param pos: the position of the metaelement @rtype: float @return: s parameter of the metaelem object """ def setMetas(pos,news): """ - Sets the s parameter of a metaelem object + Sets the s parameter of a metaelem object. @type pos: int - @param : the position of the metaelement + @param pos: the position of the metaelement @type news: float @param news: the new x parameter value - @rtype: PyNone - @return: PyNone + @rtype: None + @return: None """ def getMetalen(pos): """ - Retreives the len parameter of a metaelem object + Retrieves the len parameter of a metaelem object. @type pos: int - @param : the position of the metaelement + @param pos: the position of the metaelement @rtype: float @return: len parameter of the metaelem object """ def setMetalen(pos,newlen): """ - Sets the len parameter of a metaelem object + Sets the len parameter of a metaelem object. @type pos: int - @param : the position of the metaelement + @param pos: the position of the metaelement @type newlen: float @param newlen: the new x parameter value - @rtype: PyNone - @return: PyNone + @rtype: None + @return: None """ |