[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [25875] trunk/blender/source/gameengine/ PyDoc: BGE API_DOC: VideoTexture and PhysicsConstraints templates ( need the functions to be filled with their description).

Sun Jan 10 20:35:42 CET 2010

Revision: 25875
          http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-blender&revision=25875
Author:   dfelinto
Date:     2010-01-10 20:35:42 +0100 (Sun, 10 Jan 2010)

Log Message:
-----------
BGE API_DOC: VideoTexture and PhysicsConstraints templates (need the functions to be filled with their description).

PhysicsConstraints is documented in the Game Kit Book:
http://download.blender.org/documentation/gamekit1/

VideoTexture is documented in the wiki:
http://wiki.blender.org/index.php/Dev:Source/GameEngine/2.49/VideoTexture

I don't think I will have time to fill the documentation. But I hope this commit helps someone interested in helping it.

Therefore volunteers to document those modules are highly welcome !!! (let's give to BGE the documentation it deserves)!

* + added GameLogic.Lave/LoadGlobalDict + some typo fixes

Modified Paths:
--------------
    trunk/blender/source/gameengine/PyDoc/API_intro.py
    trunk/blender/source/gameengine/PyDoc/GameLogic.py
    trunk/blender/source/gameengine/PyDoc/GameTypes.py

Added Paths:
-----------
    trunk/blender/source/gameengine/PyDoc/PhysicsConstraints.py
    trunk/blender/source/gameengine/PyDoc/VideoTexture.py

Modified: trunk/blender/source/gameengine/PyDoc/API_intro.py
===================================================================

--- trunk/blender/source/gameengine/PyDoc/API_intro.py	2010-01-10 19:21:46 UTC (rev 25874)
+++ trunk/blender/source/gameengine/PyDoc/API_intro.py	2010-01-10 19:35:42 UTC (rev 25875)
@@ -16,10 +16,10 @@
 			- L{Rasterizer} display and rendering.
 			- L{GameTypes} contains all the python types spesific to the GameEngine.
 	
-	Undocumented modules:
+	Modules with documentation in progress:
 	---------------------
-		- VideoTexture
-		- PhysicsConstraints
+		- L{VideoTexture}
+		- L{PhysicsConstraints}
 	
 	Additional Modules:
 	-------------------

Modified: trunk/blender/source/gameengine/PyDoc/GameLogic.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/GameLogic.py	2010-01-10 19:21:46 UTC (rev 25874)
+++ trunk/blender/source/gameengine/PyDoc/GameLogic.py	2010-01-10 19:35:42 UTC (rev 25875)
@@ -313,7 +313,6 @@
 import GameTypes
 
 # TODO
-# globalDict
 # error
 
 def getCurrentController():
@@ -446,6 +445,14 @@
 	@param ticrate: The new update frequency (in Hz).
 	@type ticrate: float
 	"""
+def saveGlobalDict():
+	"""
+	Saves GameLogic.globalDict to a file.
+	"""
+def loadGlobalDict():
+	"""
+	Loads GameLogic.globalDict from a file.
+	"""
 
 #{ Utility functions
 def getAverageFrameRate():

Modified: trunk/blender/source/gameengine/PyDoc/GameTypes.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/GameTypes.py	2010-01-10 19:21:46 UTC (rev 25874)
+++ trunk/blender/source/gameengine/PyDoc/GameTypes.py	2010-01-10 19:35:42 UTC (rev 25875)
@@ -1581,7 +1581,7 @@
 	"""
 	def endObject():
 		"""
-		Delete this object, can be used inpace of the EndObject Actuator.
+		Delete this object, can be used in place of the EndObject Actuator.
 		The actual removal of the object from the scene is delayed.
 		"""	
 	def replaceMesh(mesh, useDisplayMesh=True, usePhysicsMesh=False):
@@ -1682,7 +1682,7 @@
 	def getAxisVect(vect):
 		"""
 		Returns the axis vector rotates by the objects worldspace orientation.
-		This is the equivalent if multiplying the vector by the orientation matrix.
+		This is the equivalent of multiplying the vector by the orientation matrix.
 		
 		@type vect: 3d vector.
 		@param vect: a vector to align the axis.

Added: trunk/blender/source/gameengine/PyDoc/PhysicsConstraints.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/PhysicsConstraints.py	                        (rev 0)
+++ trunk/blender/source/gameengine/PyDoc/PhysicsConstraints.py	2010-01-10 19:35:42 UTC (rev 25875)
@@ -0,0 +1,126 @@
+# $Id$
+"""
+Documentation for the PhysicsConstraints module.
+
+Example:
+	import PhysicsConstraints
+	import GameLogic
+
+"""
+# TODO
+# error
+
+def createConstraint():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def getAppliedImpulse():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def getVehicleConstraint():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def removeConstraint():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def setCcdMode():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def setContactBreakingTreshold():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def setDeactivationAngularTreshold():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def setDeactivationLinearTreshold():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def setDeactivationTime():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def setDebugMode():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def setGravity():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def setLinearAirDamping():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def setNumIterations():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def setNumTimeSubSteps():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def setSolverDamping():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def setSolverTau():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def setSolverType():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def setSorConstant():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def setUseEpa():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
\ No newline at end of file


Property changes on: trunk/blender/source/gameengine/PyDoc/PhysicsConstraints.py
___________________________________________________________________
Name: svn:keywords
   + Author Date Id Revision
Name: svn:eol-style
   + native

Added: trunk/blender/source/gameengine/PyDoc/VideoTexture.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/VideoTexture.py	                        (rev 0)
+++ trunk/blender/source/gameengine/PyDoc/VideoTexture.py	2010-01-10 19:35:42 UTC (rev 25875)
@@ -0,0 +1,133 @@
+# $Id$
+"""
+Documentation for the VideoTexture module.
+
+Example:
+	import VideoTexture
+	import GameLogic
+
+"""
+def getLastError():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def imageToArray(image):
+	"""
+	Does something
+
+	@param image: Image ID
+	@type image: integer
+	@rtype: array
+	"""
+def materialID(material):
+	"""
+	Gets the ID of a material
+
+	@param material: the name of the material
+	@type material: string
+	@rtype: 
+	"""
+def setLogFile():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def FilterBGR24():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def FilterBlueScreen():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def FilterColor():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def FilterGray():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def FilterLevel():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def FilterNormal():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def FilterRGB24():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def FilterRGBA32():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def ImageBuff():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def ImageFFmpeg():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def ImageMirror():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def ImageMix():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def ImageRender():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def ImageViewport():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def Texture():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
+def VideoFFmpeg():
+	"""
+	Does something
+	
+	@rtype: 
+	"""
\ No newline at end of file


Property changes on: trunk/blender/source/gameengine/PyDoc/VideoTexture.py
___________________________________________________________________
Name: svn:keywords
   + Author Date Id Revision
Name: svn:eol-style
   + native



