Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCampbell Barton <ideasman42@gmail.com>2009-05-14 02:52:31 +0400
committerCampbell Barton <ideasman42@gmail.com>2009-05-14 02:52:31 +0400
commit240aa6d34d561ac6156eda50ece90130903a2df0 (patch)
tree75df1c82fb729dd742dc1afedaf632ffe2cdf55c /source/gameengine/PyDoc
parentc7519789b8a7ba8973b2a165b2d008679c3f8241 (diff)
* More updates to game engine type docs from Roelf de Kock
* FBX Bugfix, was exporting all animation curves as 'Constant' type (no docs for this so could only guess), Thanks to Sander Brandenburg for spotting this problem. Also improved keyframe removal to work on animation curves an angle
Diffstat (limited to 'source/gameengine/PyDoc')
-rw-r--r--source/gameengine/PyDoc/GameTypes.py81
1 files changed, 41 insertions, 40 deletions
diff --git a/source/gameengine/PyDoc/GameTypes.py b/source/gameengine/PyDoc/GameTypes.py
index 828435b813a..6758824611c 100644
--- a/source/gameengine/PyDoc/GameTypes.py
+++ b/source/gameengine/PyDoc/GameTypes.py
@@ -512,8 +512,7 @@ class BL_Shader(PyObjectPlus):
def delSource():
"""
- TODO - Description
-
+ Clear the shader. Use this method before the source is changed with L{setSource}.
"""
def getFragmentProg():
"""
@@ -997,39 +996,56 @@ class KX_BlenderMaterial(PyObjectPlus): # , RAS_IPolyMaterial)
"""
KX_BlenderMaterial
- All placeholders have a __ prefix
"""
- def __getShader(val):
+ def getShader():
"""
- TODO - Description
-
- @param val: the starting frame of the animation
- @type val: float
+ Returns the material's shader.
- @rtype: integer
- @return: TODO Description
+ @rtype: L{BL_Shader}
+ @return: the material's shader
"""
- def __setBlending(val):
+ def setBlending(src, dest):
"""
- TODO - Description
+ Set the pixel color arithmetic functions.
- @param val: the starting frame of the animation
- @type val: float
+ @param src: Specifies how the red, green, blue,
+ and alpha source blending factors are computed.
+ @type src: GL_ZERO,
+ GL_ONE,
+ GL_SRC_COLOR,
+ GL_ONE_MINUS_SRC_COLOR,
+ GL_DST_COLOR,
+ GL_ONE_MINUS_DST_COLOR,
+ GL_SRC_ALPHA,
+ GL_ONE_MINUS_SRC_ALPHA,
+ GL_DST_ALPHA,
+ GL_ONE_MINUS_DST_ALPHA,
+ GL_SRC_ALPHA_SATURATE
+
- @rtype: integer
- @return: TODO Description
+ @param dest: Specifies how the red, green, blue,
+ and alpha destination blending factors are computed.
+ @type dest: GL_ZERO,
+ GL_ONE,
+ GL_SRC_COLOR,
+ GL_ONE_MINUS_SRC_COLOR,
+ GL_DST_COLOR,
+ GL_ONE_MINUS_DST_COLOR,
+ GL_SRC_ALPHA,
+ GL_ONE_MINUS_SRC_ALPHA,
+ GL_DST_ALPHA,
+ GL_ONE_MINUS_DST_ALPHA,
+ GL_SRC_ALPHA_SATURATE
+
"""
- def __getMaterialIndex(val):
+ def getMaterialIndex():
"""
- TODO - Description
-
- @param val: the starting frame of the animation
- @type val: float
+ Returns the material's index.
@rtype: integer
- @return: TODO Description
+ @return: the material's index
"""
class KX_CDActuator(SCA_IActuator):
@@ -1419,28 +1435,13 @@ class KX_ConstraintWrapper(PyObjectPlus):
"""
KX_ConstraintWrapper
- All placeholders have a __ prefix
"""
- def __getConstraintId(val):
- """
- TODO - Description
-
- @param val: the starting frame of the animation
- @type val: float
-
- @rtype: integer
- @return: TODO Description
- """
-
- def __testMethod(val):
+ def getConstraintId(val):
"""
- TODO - Description
-
- @param val: the starting frame of the animation
- @type val: float
+ Returns the contraint's ID
@rtype: integer
- @return: TODO Description
+ @return: the constraint's ID
"""
class KX_GameActuator(SCA_IActuator):