*** empty log message ***

source/blender/python/api2_2x/doc/Curvedoc.txt

@@ -0,0 +1,105 @@
+CURVE Module documentation
+
+
+
+
+INTRODUCTION
+
+The Curve module gives access to the curves objects. Curves are used for many things in blender : creation of graphical objects, duplication of meshes, displacement of meshes, in IPOs for instance.
+Blender has three main types of curves :
+	nurbs curves, each control point has three coordinates.
+	bezier curves, each control point has nine coordinates.
+	text curves, which represent graphical text objects.
+
+
+
+
+
+
+functions of the module :
+
+Get(Name:string) : returns the Curve whose name is Name.
+
+get : same as Get
+
+New(Name:string (optional)) : Creates a new Curve Object.
+If the parameter Name is given, it will be the name of the Curve Object, 
+else the name will be choosen by blender.
+
+
+Curve Object member functions :
+
+getName() : Retreives the Curve Object name.
+
+setName(Name : string) : Sets the Curve Object name.
+
+getPathLen() : Retrieves the  Curve Object path length.
+
+setPathLen(len:int) : Sets the Curve Object path length.
+
+getTotcol() :  Retreives the parameter  totcol  of the Curve.
+
+setTotcol(val:int) : Sets the parameter totcol
+/*I do not know what means this parameter...*/
+
+getFlag()Retrieves the mode of the Curve Object
+
+setFlag(val:int) :Sets the mode  of the Curve.
+
+The mode of the curve is a combination of parameters.
+Bits 0,1,2 : "Back", "Front" and "3D".
+Bit 3 :  "CurvePath" is set.
+Bit 4 :  "CurveFollow" is set.
+
+getBevresol() : Retreives the bevel resolution of the curve.
+
+setBevresol(val:float) : Sets the bevel resolution of the curve.
+
+getResolu() : Retreives the U-resolution of the curve.
+
+setResolu(val:int) : sets the U-resolution of the curve.
+
+getResolv() : Retreives the V-resolution of the curve.
+
+setResolv(val:int) : sets the V-resolution of the curve.
+
+getWidth() : Retreives the bevel width of the curve.
+
+setWidth(val:float) :  Sets the bevel width.
+
+getExt1() : Retreives the bevel height1 of the curve.
+
+setExt1(val:float) : Sets the bevel height1 of the curve. 
+
+getExt2() : Retreives the bevel height2 of the curve. 
+
+setExt2(val:float) : Sets the bevel height2 of the curve. 
+
+getControlPoint(i:int) : Retreives the i-th  control point.
+Depending upon the curve type, returne a list of 4(nurbs) or 9(bez) floats.
+
+setControlPoint(i:int, x1:float,...x4:float)
+setControlPoint(i:int, x1:float,...x9:float) : Sets the i-th control point value.
+
+getLoc() : Retreives the Curve location(from the center)
+
+setLoc(x:float,y:float,z:float) : Sets the Curve location
+
+getRot() : Retreives the Curve rotation(from the center)
+
+setRot(x:float,y:float,z:float) : Sets the Curve rotation.
+
+getSize() : Retreives the Curve size.
+
+setSize(x:float,y:float,z:float) : Sets the Curve size.
+
+Direct acces to the parameters values : You cann read and write  the parameter XXX with the following syntax :
+val = obj.XXX
+or obj.XXX = val.
+The possible parameters names are :"name","pathlen","resolu","resolv","width","ext1", and "ext2"
+
+
+
+
+
+Submodules : No submodule.

source/blender/python/api2_2x/doc/Effectdoc.txt

@@ -0,0 +1,257 @@
+EFFECT Module documentation
+
+
+INTRODUCTION
+The module effect allows you to access all the data of an effect. 
+An effect can modify an object (typically a mesh) in three different ways.
+    a) the build effect : makes the mesh appear progressivly.
+    b) the wave effect : waves appear on the mesh (which should be fine-grained)
+    c) the particle effect : every vertex of the mesh emits particles, 
+which can themselves emit new particles. This effect is the most parametrizable.
+
+In the blender internals, the effect object is just a placeholder for the "real"
+ effect, which can be a wave, particle or build effect. The python API follows 
+this structure : the Effect module grants access to (the few) data which
+ are shared between all effects. It has three submodules : Wave, Build, Particle
+, which grant r/w access to the real parameters of these effects.
+
+
+
+
+functions of the module :
+
+Get(Name:string,pos:int) : returns the pos-th Effect associated
+ to the object whose name is Name.
+
+get : same as Get
+
+New(Type:string ) : Creates and returns a new Effect Object.
+The parameter Type can take the values "particle", "wave" or "build"
+
+
+
+Effect object member functions :
+
+getType() : Retrieves the type of the Effect Object.
+
+setType(val:int) : Sets the type of the Effect Object.
+The possible values of the type are :
+    0 : effect build.
+    1 : effect particle.
+    2 : effect wave.
+
+
+getMode()Retrieves the mode of the Effect Object
+
+setMode(val:int) :Sets the mode
+
+The mode of the effect is a combination of parameters, whose semantics depend upon the effect type.
+All types :
+Bit 0 : set to 1 if the effect is selected in the effects window.
+Wave effect :
+Bits 1,2,3  :  set to 1 if the button "X", "Y" or "Cycl" is clicked.
+Particle effect :
+Bits 1,2,3 :  set to 1 if the button "Bspline", "Static" or "Face" is clicked.
+
+
+
+
+
+
+Submodules : Wave, Build, Particle.
+
+
+
+
+Wave module 
+
+
+
+functions of the module :
+
+Get(Name:string,pos:int) : returns the pos-th wave Effect associated to the object whose name is Name.
+
+get : same as Get
+
+New( ) : Creates and returns a new Wave Object.
+
+
+Wave object member functions :
+
+getStartx() : returns the startx parameter of the wave object.
+
+setStartx(val:int) : sets the startx parameter of the wave object.
+
+getStarty() : returns the starty parameter of the wave object.
+
+setStarty(val:int) : sets the starty parameter of the wave object.
+
+getHeight() : returns the height parameter of the wave object.
+
+setHeight(val:int) : sets the height parameter of the wave object.
+
+getWidth() : returns the width parameter of the wave object.
+
+setWidth(val:int) : sets the width parameter of the wave object.
+
+getNarrow() : returns the narrow parameter of the wave object.
+
+setNarrow(val:int) : sets the narrow parameter of the wave object.
+
+getSpeed() : returns the speed parameter of the wave object.
+
+setSpeed(val:int) : sets the speed parameter of the wave object.
+
+getMinfac() : returns the minfac parameter of the wave object.
+
+setMinfac(val:int) : sets the minfac parameter of the wave object.
+
+getDamp() : returns the damp parameter of the wave object.
+
+setDamp(val:int) : sets the damp parameter of the wave object.
+
+getTimeoffs() : returns the timeoffs parameter of the wave object.
+
+setTimeoffs(val:int) : sets the time offset parameter of the wave object.
+
+getLifetime() : returns the lifetime parameter of the wave object.
+
+setLifetime(val:int) : sets the lifetime parameter of the wave object.
+
+
+
+The Object.attr syntax
+
+Wave attributes can be read/written with the object.attr syntax.
+Example :
+
+w = Blender.Wave.Get("Obname",3) #retreives the 4th effect associated to the object named Obname
+a = w.speed  # a is now the value corresponding to the speed of the effect
+w.speed = 42   # the speed of the effect is now equal to 42
+
+The parameter can take these values :  "lifetime","timeoffs","damp","minfac","speed","narrow","width","height","startx","starty"
+
+
+
+
+Build module 
+
+
+
+functions of the module :
+
+Get(Name:string,pos:int) : returns the pos-th build Effect associated to the object whose name is Name.
+
+get(Name:string,pos:int) : same as Get
+
+New( ) : Creates and returns a new Build Object.
+
+
+Build object member functions :
+
+getLen() : returns the length of the effect (in frames).
+
+setLen(val:float) : sets the length of the effect (in frames).
+
+getSfra() : returns the starting frame of the effect.
+
+setSfra(val:float) : sets the starting frame of the effect.
+
+
+The Object.attribute syntax
+
+The attribute can take these values : "sfra","len".
+
+
+Particle module 
+
+
+
+functions of the module :
+
+Get(Name:string,pos:int) : returns the pos-th particle Effect associated to the object whose name is Name.
+
+get(Name:string,pos:int) : same as Get
+
+New( ) : Creates and returns a new Effect Object.
+
+
+Particle object member functions :
+
+getStartTime() : returns the start time  of the particle effect (in frames).
+
+setStartTime(val:float) : sets the start time of the particle effect (in frames).
+
+getEndTime() : returns the end time  of the particle effect (in frames).
+
+setEndTime(val:float) : sets the end time of the particle effect (in frames).
+
+getLifeTime() : returns the life time  of the particles.
+
+setLifeTime(val:float) : sets the life time of the particles.
+
+getNormfac() : returns the normal strength of the particles (relatively to mesh).
+
+setNormfac(val:float) : sets the normal strength of the particles(relatively to mesh).
+
+getObfac() : returns the initial of the particles relatively to objects.
+
+setObfac(val:float) : sets the initial of the particles relatively to objects.
+
+getRandfac() : returns the initial random speed of the particles.
+
+setRandfac(val:float) : sets the initial  random speed of the particles.
+
+getTexfac() : returns the initial speed of the particles caused by the texture.
+
+setTexfac(val:float) : sets the initial speed of the particles caused by the texture.
+
+getRandlife() : returns the variability of the life of the particles.
+
+setRandlife(val:float) : sets  the variability of the life of the particles.
+
+getNabla() : returns the dimension of the area for gradient computation.
+
+setNabla(val:float) : sets  the dimension of the area for gradient computation.
+
+getTotpart() : returns the total number of particles.
+
+setTotpart(val:int) : sets  the total number of particles.
+
+getTotkey() : returns the number of key positions.
+
+setTotkey(val:int) : sets the number of key positions.
+
+getSeed() : returns the seed of the RNG.
+
+setSeed(val:int) : sets the seed of the RNG.
+
+getSeed() : returns the x,y,z components of the constant force applied to the particles.
+
+setSeed(valx:float,valy:float,valz:float) : sets the x,y,z components of the constant force applied to the particles.
+
+getMult() : returns the 4 probabilities of a particle having a child.
+
+setMult(val1:float,val2:float,val3:float,val4:float) : sets the 4 probabilities of a particle having a child.
+
+getLife() : returns the lifespan of the 4 generation particles.
+
+setLife(val1:float,val2:float,val3:float,val4:float) : sets  the lifespan of the 4 generation particles.
+
+getMat() : returns the material used by the 4 generation particles.
+
+setMat(val1:float,val2:float,val3:float,val4:float) : sets the material used by the 4 generation particles.
+
+getChild() : returns the number of children a particle may have.
+
+setChild(val1:float,val2:float,val3:float,val4:float) : sets  the number of children a particle may have.
+
+getDefvec() : returns the x, y and z axis of the force defined by the texture.
+
+setDefvec(val1:float,val2:float,val3:float) : sets the x, y and z axis of the force defined by the texture.
+
+
+
+The Object.attribute syntax
+
+The attribute can take these values : "seed","nabla","sta","end","lifetime","normfac","obfac","randfac","texfac","randlife","vectsize","totpart","force","mult","life","child","mat","defvec".

source/blender/python/api2_2x/doc/Ipodoc.txt

@@ -0,0 +1,66 @@
+IPO Module documentation
+
+
+INTRODUCTION
+The module ipo allows you to access all the data of an ipo.
+The most important part(s) of an ipo is its ipocurve(s). The ipocurve has a set of bezier points (defined by 9 coordinates). The ipo module grants the user read/write access to these points.
+
+
+
+
+functions of the module :
+
+Get(Name:string) : returns the Ipo associated whose name is Name.
+
+get : same as Get
+
+New(Name:string , idcode:int ) : Creates and returns a new Ipo Object.
+The parameters are mandatory. If the name is already used, blender will change it to name.XXX (XXX is an integer)
+
+
+
+Ipo object member functions :
+
+getName() : Retrieves the name of the Ipo Object.
+
+setName(newname:string) : Sets the name of the Ipo Object.
+
+getBlocktype() : Retrieves the blocktype of the Ipo Object.
+
+setBlocktype(newblocktype:string) : Sets the blocktype of the Ipo Object.
+
+getShowkey() : Retrieves the showkey of the Ipo Object.
+
+setShowkey(val:int) : Sets the showkey of the Ipo Object.
+
+getPad() : Retrieves the pad of the Ipo Object.
+
+setPad(val:int) : Sets the pad of the Ipo Object.
+
+getRctf() : Retrieves the rctf of the Ipo Object.
+
+setRctf(val:int) : Sets the rctf of the Ipo Object.
+
+I do not fully understand the meaning of these parameters.
+
+
+
+getNcurves() : returns the number of ipocurves the ipo object contains.
+
+getBP() : returns the basepoint of the ipo object (generally NULL)
+
+getCurveCurval(numcurve:int) : returns the current value of the ipo curve number numcurve.
+
+getCurveBeztriple(numcurve:int,numpoint:int) : returns a list of 9 floats, which are the coordinates of the control point number numpoint of the ipocurve number numcurve.
+
+
+
+setCurveBeztriple(numcurve:int,numpoint:int,newvalues : list of 9 floats) : sets the coordinates of the control point number numpoint of the ipocurve number numcurve to newvalues. (the z coordinate should be 0, but blender does not complain if non null values are passed)
+
+
+
+Example :
+import Blender
+
+d = Blender.Ipo.Get('ObIpo') # hope there is an ipo named "ObIpo"...Else create it before.
+

source/blender/python/api2_2x/doc/Metaballdoc.txt

@@ -0,0 +1,58 @@
+METABALL Module documentation
+
+
+INTRODUCTION
+The metaball module effect allows you to access all the data of an metaball.
+A metaball consists of several (maybe only one) metaelems, which are spheres, interacting with each other, thus creating soft organic volumes.
+
+
+
+functions of the module :
+New(name) : creates ans returns a metaball object. 
+Get(opt : name) : if the parameter name is given, returns the metaball object whose name has been passed, or Py_None, if no such metaball exists in the current scene. If no parameter is given, returns a list of all the metaballs in the current scene.
+get : alias for Get
+
+Metaball  object member functions :
+
+getName()Return Metaball  name
+setName(string newname) - Sets Metaball  name
+getWiresize() - Return Metaball  wire size
+setWiresize(float val) - Sets Metaball  wire size
+getRendersize() - Return Metaball  render size
+setRendersize(float newval- Sets Metaball  render size
+getThresh()- Return Metaball  threshold
+setThresh(float newval)- Sets Metaball  threshold 
+getBbox,- Return Metaball bounding box(a list of eight lists of three elements)
+getNMetaElems() Returns the number of Metaelems (basic spheres)
+getMetatype(int num_metaelem): returns the type of the metaelem number num_metaelem.
+0 : ball
+1 : tubex
+2 : tubey
+3 : tubez
+setMetatype(int num_metaelem,int newtype) : sets the type of the metaelem number num_metaelem.
+getMetadata(field_name,int num_metaelem)  gets Metaball MetaData. Explained later.
+setMetadata(field_name,int num_metaelem,newval) sets Metaball MetaData. Explained later.
+getMetalay(int num_metaelem) 
+getMetax(int num_metaelem) : gets the x coordinate of the metaelement
+setMetax(int num_metaelem,float newval) : sets the x coordinate of the metaelement 
+getMetay(int num_metaelem) : gets the y coordinate of the metaelement
+setMetay(int num_metaelem,float newval) : sets the y coordinate of the metaelement 
+getMetaz(int num_metaelem) : gets the z coordinate of the metaelement
+setMetaz(int num_metaelem,float newval) : sets the z coordinate of the metaelement 
+getMetas(int num_metaelem) : gets the s coordinate of the metaelement
+setMetas(int num_metaelem,float newval) : sets the s coordinate of the metaelement 
+getMetalen(int num_metaelem)  : gets the length of the metaelement. Important for tubes.
+setMetalen(int num_metaelem,float newval)  : sets the length of the metaelement. Important for tubes.
+getloc, - Gets Metaball loc values
+setloc, (f f f) - Sets Metaball loc values
+getrot, () - Gets Metaball rot values
+setrot,, (f f f) - Sets Metaball rot values
+getsize,() - Gets Metaball size values
+setsize,(f f f) - Sets Metaball size values
+
+
+
+
+The Object.attribute syntax
+
+The attribute can take these values : seed,nabla,sta,end,lifetime,normfac,obfac,randfac,texfac,randlife,vectsize,totpart,force,mult,life,child,mat,defvec.

source/blender/python/api2_2x/doc/Worlddoc.txt

@@ -0,0 +1,58 @@
+METABALL Module documentation
+
+
+INTRODUCTION
+The metaball module effect allows you to access all the data of an metaball.
+A metaball consists of several (maybe only one) metaelems, which are spheres, interacting with each other, thus creating soft organic volumes.
+
+
+
+functions of the module :
+New(name) : creates ans returns a metaball object. 
+Get(opt : name) : if the parameter name is given, returns the metaball object whose name has been passed, or Py_None, if no such metaball exists in the current scene. If no parameter is given, returns a list of all the metaballs in the current scene.
+get : alias for Get
+
+Metaball  object member functions :
+
+getName()Return Metaball  name
+setName(string newname) - Sets Metaball  name
+getWiresize() - Return Metaball  wire size
+setWiresize(float val) - Sets Metaball  wire size
+getRendersize() - Return Metaball  render size
+setRendersize(float newval- Sets Metaball  render size
+getThresh()- Return Metaball  threshold
+setThresh(float newval)- Sets Metaball  threshold 
+getBbox,- Return Metaball bounding box(a list of eight lists of three elements)
+getNMetaElems() Returns the number of Metaelems (basic spheres)
+getMetatype(int num_metaelem): returns the type of the metaelem number num_metaelem.
+0 : ball
+1 : tubex
+2 : tubey
+3 : tubez
+setMetatype(int num_metaelem,int newtype) : sets the type of the metaelem number num_metaelem.
+getMetadata(field_name,int num_metaelem)  gets Metaball MetaData. Explained later.
+setMetadata(field_name,int num_metaelem,newval) sets Metaball MetaData. Explained later.
+getMetalay(int num_metaelem) 
+getMetax(int num_metaelem) : gets the x coordinate of the metaelement
+setMetax(int num_metaelem,float newval) : sets the x coordinate of the metaelement 
+getMetay(int num_metaelem) : gets the y coordinate of the metaelement
+setMetay(int num_metaelem,float newval) : sets the y coordinate of the metaelement 
+getMetaz(int num_metaelem) : gets the z coordinate of the metaelement
+setMetaz(int num_metaelem,float newval) : sets the z coordinate of the metaelement 
+getMetas(int num_metaelem) : gets the s coordinate of the metaelement
+setMetas(int num_metaelem,float newval) : sets the s coordinate of the metaelement 
+getMetalen(int num_metaelem)  : gets the length of the metaelement. Important for tubes.
+setMetalen(int num_metaelem,float newval)  : sets the length of the metaelement. Important for tubes.
+getloc, - Gets Metaball loc values
+setloc, (f f f) - Sets Metaball loc values
+getrot, () - Gets Metaball rot values
+setrot,, (f f f) - Sets Metaball rot values
+getsize,() - Gets Metaball size values
+setsize,(f f f) - Sets Metaball size values
+
+
+
+
+The Object.attribute syntax
+
+The attribute can take these values : seed,nabla,sta,end,lifetime,normfac,obfac,randfac,texfac,randlife,vectsize,totpart,force,mult,life,child,mat,defvec.