Revision: 20162
http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-blender&revision=20162
Author: campbellbarton
Date: 2009-05-11 23:35:38 +0200 (Mon, 11 May 2009)
Log Message:
-----------
BGE Doc updates thanks to Roelf de Kock
--- Notes from Roelf, maybe some other BGE devs could help resolve these
Here is what I have so far. I've left "TODO's" were there needs to be some more
comments.
The following things also need to be resolved:
-KX_VehicleWrapper.getWheelOrientationQuaternion looks like it should return a
quaternion but if I look at the code it looks like it returns a rotation matrix.
-I still need to find out what exactly KX_VehicleWrapper.getWheelRotation is.
I've got the return type but I would like to add some explanation for what it
actualy means (and units if any).
-BL_Shader.setNumberOfPasses ignores the parameter but from the comment in the
code it looks like the parameter that is being set (it is harcoded to be =1) in
setNumberOfPasses is not used. So I'm not sure if this method should be
documented at all.
Modified Paths:
--------------
trunk/blender/source/gameengine/PyDoc/BL_Shader.py
trunk/blender/source/gameengine/PyDoc/KX_PhysicsObjectWrapper.py
trunk/blender/source/gameengine/PyDoc/KX_VehicleWrapper.py
trunk/blender/source/gameengine/PyDoc/epy_docgen.sh
Modified: trunk/blender/source/gameengine/PyDoc/BL_Shader.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/BL_Shader.py 2009-05-11 19:19:36 UTC
(rev 20161)
+++ trunk/blender/source/gameengine/PyDoc/BL_Shader.py 2009-05-11 21:35:38 UTC
(rev 20162)
@@ -5,227 +5,244 @@
"""
BL_Shader GLSL shaders.
- All placeholders have a __ prefix
+ TODO - Description
"""
- def __setUniformfv(val):
+ def setUniformfv(name, fList):
"""
- TODO - Description
+ Set a uniform with a list of float values
- @param val: the starting frame of the animation
- @type val: float
+ @param name: the uniform name
+ @type name: string
- @rtype: integer
- @return: TODO Description
+ @param fList: a list (2, 3 or 4 elements) of float values
+ @type fList: list[float]
"""
- def __delSource(val):
+ def delSource():
"""
TODO - Description
-
- @param val: the starting frame of the animation
- @type val: float
-
- @rtype: integer
- @return: TODO Description
+
"""
- def __getFragmentProg(val):
+ def getFragmentProg():
"""
- TODO - Description
+ Returns the fragment program.
- @param val: the starting frame of the animation
- @type val: float
-
- @rtype: integer
- @return: TODO Description
+ @rtype: string
+ @return: The fragment program.
"""
- def __getVertexProg(val):
+ def getVertexProg():
"""
- TODO - Description
+ Get the vertex program.
- @param val: the starting frame of the animation
- @type val: float
-
- @rtype: integer
- @return: TODO Description
+ @rtype: string
+ @return: The vertex program.
"""
- def __isValid(val):
+ def isValid():
"""
- TODO - Description
-
- @param val: the starting frame of the animation
- @type val: float
-
- @rtype: integer
- @return: TODO Description
+ Check if the shader is valid.
+
+ @rtype: bool
+ @return: True if the shader is valid
"""
- def __setAttrib(val):
+ def setAttrib(enum):
"""
- TODO - Description
+ Set attribute location. (The parameter is ignored a.t.m. and
the value of "tangent" is always used.)
- @param val: the starting frame of the animation
- @type val: float
-
- @rtype: integer
- @return: TODO Description
+ @param enum: attribute location value
+ @type enum: integer
"""
- def __setNumberOfPasses(val):
+ def setNumberOfPasses( max_pass ):
"""
- TODO - Description
+ Set the maximum number of passes. Not used a.t.m.
- @param val: the starting frame of the animation
- @type val: float
-
- @rtype: integer
- @return: TODO Description
+ @param max_pass: the maximum number of passes
+ @type max_pass: integer
"""
- def __setSampler(val):
+ def setSampler(name, index):
"""
- TODO - Description
+ Set uniform texture sample index.
- @param val: the starting frame of the animation
- @type val: float
-
- @rtype: integer
- @return: TODO Description
+ @param name: Uniform name
+ @type name: string
+
+ @param index: Texture sample index.
+ @type index: integer
"""
- def __setSource(val):
+ def setSource(vertexProgram, fragmentProgram):
"""
- TODO - Description
+ Set the vertex and fragment programs
- @param val: the starting frame of the animation
- @type val: float
-
- @rtype: integer
- @return: TODO Description
+ @param vertexProgram: Vertex program
+ @type vertexProgram: string
+
+ @param fragmentProgram: Fragment program
+ @type fragmentProgram: string
"""
- def __setUniform1f(val):
+ def setUniform1f(name, fx):
"""
- TODO - Description
+ Set a uniform with 1 float value.
- @param val: the starting frame of the animation
- @type val: float
+ @param name: the uniform name
+ @type name: string
- @rtype: integer
- @return: TODO Description
+ @param fx: Uniform value
+ @type fx: float
"""
- def __setUniform1i(val):
+ def setUniform1i(name, ix):
"""
- TODO - Description
+ Set a uniform with an integer value.
- @param val: the starting frame of the animation
- @type val: float
-
- @rtype: integer
- @return: TODO Description
+ @param name: the uniform name
+ @type name: string
+
+ @param ix: the uniform value
+ @type ix: integer
"""
- def __setUniform2f(val):
+ def setUniform2f(name, fx, fy):
"""
- TODO - Description
+ Set a uniform with 2 float values
- @param val: the starting frame of the animation
- @type val: float
+ @param name: the uniform name
+ @type name: string
+
+ @param fx: first float value
+ @type fx: float
- @rtype: integer
- @return: TODO Description
+ @param fy: second float value
+ @type fy: float
"""
- def __setUniform2i(val):
+ def setUniform2i(name, ix, iy):
"""
- TODO - Description
+ Set a uniform with 2 integer values
- @param val: the starting frame of the animation
- @type val: float
+ @param name: the uniform name
+ @type name: string
+
+ @param ix: first integer value
+ @type ix: integer
- @rtype: integer
- @return: TODO Description
+ @param iy: second integer value
+ @type iy: integer
"""
- def __setUniform3f(val):
+ def setUniform3f(name, fx,fy,fz):
"""
- TODO - Description
+ Set a uniform with 3 float values.
- @param val: the starting frame of the animation
- @type val: float
+ @param name: the uniform name
+ @type name: string
+
+ @param fx: first float value
+ @type fx: float
- @rtype: integer
- @return: TODO Description
+ @param fy: second float value
+ @type fy: float
+
+ @param fz: third float value
+ @type fz: float
"""
- def __setUniform3i(val):
+ def setUniform3i(name, ix,iy,iz):
"""
- TODO - Description
+ Set a uniform with 3 integer values
- @param val: the starting frame of the animation
- @type val: float
+ @param name: the uniform name
+ @type name: string
+
+ @param ix: first integer value
+ @type ix: integer
- @rtype: integer
- @return: TODO Description
+ @param iy: second integer value
+ @type iy: integer
+
+ @param iz: third integer value
+ @type iz: integer
"""
- def __setUniform4f(val):
+ def setUniform4f(name, fx,fy,fz,fw):
"""
- TODO - Description
+ Set a uniform with 4 float values.
- @param val: the starting frame of the animation
- @type val: float
+ @param name: the uniform name
+ @type name: string
+
+ @param fx: first float value
+ @type fx: float
- @rtype: integer
- @return: TODO Description
+ @param fy: second float value
+ @type fy: float
+
+ @param fz: third float value
+ @type fz: float
+
+ @param fw: fourth float value
+ @type fw: float
"""
- def __setUniform4i(val):
+ def setUniform4i(name, ix,iy,iz, iw):
"""
- TODO - Description
+ Set a uniform with 4 integer values
- @param val: the starting frame of the animation
- @type val: float
+ @param name: the uniform name
+ @type name: string
+
+ @param ix: first integer value
+ @type ix: integer
- @rtype: integer
- @return: TODO Description
+ @param iy: second integer value
+ @type iy: integer
+
+ @param iz: third integer value
+ @type iz: integer
+
+ @param iw: fourth integer value
+ @type iw: integer
"""
- def __setUniformDef(val):
+ def setUniformDef(name, type):
"""
- TODO - Description
+ Define a new uniform
- @param val: the starting frame of the animation
- @type val: float
-
- @rtype: integer
- @return: TODO Description
+ @param name: the uniform name
+ @type name: string
+
+ @param type: uniform type
+ @type type: UNI_NONE, UNI_INT, UNI_FLOAT, UNI_INT2, UNI_FLOAT2,
UNI_INT3, UNI_FLOAT3, UNI_INT4, UNI_FLOAT4, UNI_MAT3, UNI_MAT4, UNI_MAX
"""
- def __setUniformMatrix3(val):
+ def setUniformMatrix3(name, mat, transpose):
"""
- TODO - Description
+ Set a uniform with a 3x3 matrix value
- @param val: the starting frame of the animation
- @type val: float
+ @param name: the uniform name
+ @type name: string
+
+ @param mat: A 3x3 matrix [[f,f,f], [f,f,f], [f,f,f]]
+ @type mat: 3x3 matrix
- @rtype: integer
- @return: TODO Description
+ @param transpose: set to True to transpose the matrix
+ @type transpose: bool
"""
- def __setUniformMatrix4(val):
+ def setUniformMatrix4(name, mat, transpose):
"""
- TODO - Description
+ Set a uniform with a 4x4 matrix value
- @param val: the starting frame of the animation
- @type val: float
+ @param name: the uniform name
+ @type name: string
+
+ @param mat: A 4x4 matrix [[f,f,f,f], [f,f,f,f], [f,f,f,f],
[f,f,f,f]]
+ @type mat: 4x4 matrix
- @rtype: integer
- @return: TODO Description
+ @param transpose: set to True to transpose the matrix
+ @type transpose: bool
"""
- def __setUniformiv(val):
+ def setUniformiv(name, iList):
"""
- TODO - Description
+ Set a uniform with a list of integer values
- @param val: the starting frame of the animation
- @type val: float
+ @param name: the uniform name
+ @type name: string
- @rtype: integer
- @return: TODO Description
+ @param iList: a list (2, 3 or 4 elements) of integer values
+ @type iList: list[integer]
"""
- def __validate(val):
+ def validate():
"""
- TODO - Description
+ Validate the shader object.
- @param val: the starting frame of the animation
- @type val: float
-
- @rtype: integer
- @return: TODO Description
"""
Modified: trunk/blender/source/gameengine/PyDoc/KX_PhysicsObjectWrapper.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/KX_PhysicsObjectWrapper.py
2009-05-11 19:19:36 UTC (rev 20161)
+++ trunk/blender/source/gameengine/PyDoc/KX_PhysicsObjectWrapper.py
2009-05-11 21:35:38 UTC (rev 20162)
@@ -4,46 +4,57 @@
"""
KX_PhysicsObjectWrapper
- All placeholders have a __ prefix
"""
- def __setActive(val):
+ def setActive(active):
"""
- TODO - Description
+ Set the object to be active.
- @param val: the starting frame of the animation
- @type val: float
-
- @rtype: integer
- @return: TODO Description
+ @param active: set to True to be active
+ @type active: bool
"""
- def __setAngularVelocity(val):
+ def setAngularVelocity(x, y, z, local):
"""
- TODO - Description
+ Set the angular velocity of the object.
- @param val: the starting frame of the animation
- @type val: float
+ @param x: angular velocity for the x-axis
+ @type x: float
- @rtype: integer
- @return: TODO Description
+ @param y: angular velocity for the y-axis
+ @type y: float
+
+ @param z: angular velocity for the z-axis
+ @type z: float
+
+ @param local: set to True for local axis
+ @type local: bool
"""
- def __setLinearVelocity(val):
+ def setLinearVelocity(x, y, z, local):
"""
- TODO - Description
@@ Diff output truncated at 10240 characters. @@
_______________________________________________
Bf-blender-cvs mailing list
[email protected]
http://lists.blender.org/mailman/listinfo/bf-blender-cvs
