Added Python module for Lights.

Added attributes to the vertex class.

28 files changed, 266 insertions, 27 deletions

diff --git a/source/gameengine/PyDoc/BL_ActionActuator.py b/source/gameengine/PyDoc/BL_ActionActuator.py
new file mode 100644
index 00000000000..a1b0777054e
--- /dev/null
+++ b/source/gameengine/PyDoc/BL_ActionActuator.py
@@ -0,0 +1,137 @@
+# $Id$
+# Documentation for BL_ActionActuator
+from SCA_ILogicBrick import *
+
+class BL_ActionActuator(SCA_ILogicBrick):
+	"""
+	Action Actuators apply an action to an actor.
+	"""
+	def setAction(action, reset = True):
+		"""
+		Sets the current action.
+		
+		@param action: The name of the action to set as the current action.
+		@type action: string
+		@param reset: Optional parameter indicating whether to reset the
+		              blend timer or not.  A value of 1 indicates that the
+		              timer should be reset.  A value of 0 will leave it
+		              unchanged.  If reset is not specified, the timer will
+		              be reset.
+		"""
+
+	def setStart(start):
+		"""
+		Specifies the starting frame of the animation.
+		
+		@param start: the starting frame of the animation
+		@type start: float
+		"""
+
+	def setEnd(end):
+		"""
+		Specifies the ending frame of the animation.
+		
+		@param end: the ending frame of the animation
+		@type end: float
+		"""
+	def setBlendin(blendin):
+		"""
+		Specifies the number of frames of animation to generate
+		when making transitions between actions.
+		
+		@param blendin: the number of frames in transition.
+		@type blendin: float
+		"""
+
+	def setPriority(priority):
+		"""
+		Sets the priority of this actuator.
+		
+		@param priority: Specifies the new priority.  Actuators will lower
+		                 priority numbers will override actuators with higher
+		                 numbers.
+		@type priority: integer
+		"""
+	def setFrame(frame):
+		"""
+		Sets the current frame for the animation.
+		
+		@param frame: Specifies the new current frame for the animation
+		@type frame: float
+		"""
+
+	def setProperty(prop):
+		"""
+		Sets the property to be used in FromProp playback mode.
+		
+		@param prop: the name of the property to use.
+		@type prop: string.
+		"""
+
+	def setBlendtime(blendtime):
+		"""
+		Sets the internal frame timer.
+		 
+		Allows the script to directly modify the internal timer
+		used when generating transitions between actions.  
+		
+		@param blendtime: The new time. This parameter must be in the range from 0.0 to 1.0.
+		@type blendtime: float
+		"""
+
+	def getAction():
+		"""
+		getAction() returns the name of the action associated with this actuator.
+		
+		@rtype: string
+		"""
+	
+	def getStart():
+		"""
+		Returns the starting frame of the action.
+		
+		@rtype: float
+		"""
+	def getEnd():
+		"""
+		Returns the last frame of the action.
+		
+		@rtype: float
+		"""
+	def getBlendin():
+		"""
+		Returns the number of interpolation animation frames to be generated when this actuator is triggered.
+		
+		@rtype: float
+		"""
+	def getPriority():
+		"""
+		Returns the priority for this actuator.  Actuators with lower Priority numbers will
+		override actuators with higher numbers.
+		
+		@rtype: integer
+		"""
+	def getFrame():
+		"""
+		Returns the current frame number.
+		
+		@rtype: float
+		"""
+	def getProperty():
+		"""
+		Returns the name of the property to be used in FromProp mode.
+		
+		@rtype: string
+		"""
+	def setChannel(channel, matrix, mode = False):
+		"""
+		@param channel: A string specifying the name of the bone channel.
+		@type channel: string
+		@param matrix: A 4x4 matrix specifying the overriding transformation
+		               as an offset from the bone's rest position.
+		@type matrix: list [[float]]
+		@param mode: True for armature/world space, False for bone space
+		@type mode: boolean
+		"""
+
+
diff --git a/source/gameengine/PyDoc/GameKeys.py b/source/gameengine/PyDoc/GameKeys.py
index 2c938d27fa3..58fc53b0961 100644
--- a/source/gameengine/PyDoc/GameKeys.py
+++ b/source/gameengine/PyDoc/GameKeys.py
@@ -1,3 +1,4 @@
+# $Id$
 """
 Documentation for the GameKeys module.
 
diff --git a/source/gameengine/PyDoc/GameLogic.py b/source/gameengine/PyDoc/GameLogic.py
index 3672a16be44..05dfd0cd481 100644
--- a/source/gameengine/PyDoc/GameLogic.py
+++ b/source/gameengine/PyDoc/GameLogic.py
@@ -1,3 +1,4 @@
+# $Id$
 """
 Documentation for the GameLogic Module.
 
diff --git a/source/gameengine/PyDoc/KX_CDActuator.py b/source/gameengine/PyDoc/KX_CDActuator.py
index fa210f8534c..12e74f166b5 100644
--- a/source/gameengine/PyDoc/KX_CDActuator.py
+++ b/source/gameengine/PyDoc/KX_CDActuator.py
@@ -1,3 +1,4 @@
+# $Id$
 # Documentation for CD Actuator
 from SCA_ILogicBrick import *
 
diff --git a/source/gameengine/PyDoc/KX_Camera.py b/source/gameengine/PyDoc/KX_Camera.py
index fc44824b854..729380ddfb0 100644
--- a/source/gameengine/PyDoc/KX_Camera.py
+++ b/source/gameengine/PyDoc/KX_Camera.py
@@ -1,3 +1,4 @@
+# $Id$
 # Documentation for Camera game objects.
 from KX_GameObject import *
 
@@ -128,7 +129,7 @@ class KX_Camera(KX_GameObject):
 		Sets the camera's projection matrix.
 		
 		You should use normalised device coordinates for the clipping planes:
-		left = -1.0, right = 1.0, top = 1.0, bottom = -1.0, near = 0.0, far = 1.0
+		left = -1.0, right = 1.0, top = 1.0, bottom = -1.0, near = cam.near, far = cam.far
 		
 		@type matrix: 4x4 matrix.
 		@param matrix: The new projection matrix for this camera.
@@ -137,41 +138,31 @@ class KX_Camera(KX_GameObject):
 		@verbatim{
 		import GameLogic
 		
-		# Scale a matrix
-		def Scale(matrix, scalar):
-			for row in matrix:
-				for col in row:
-					col = col * scalar
-		
 		# Generate an identiy matrix.
 		def Identity():
 			return [[1.0, 0.0, 0.0, 0.0], [0.0, 1.0, 0.0, 0.0], [0.0, 0.0, 1.0, 0.0], [0.0, 0.0, 0.0, 1.0]]
 		
 		# Generate a perspective projection matrix
-		def Perspective():
-			m = Identity()
-			m[0][0] = m[0][2] = 2.0
-			m[1][1] = m[1][2] = 2.0
-			m[2][2] = m[2][3] = -1.0
-			m[3][2] = -1.0
-			m[3][3] = 0.0
-			return m
+		def Perspective(cam):
+			return [[cam.near, 0.0     ,  0.0                                  ,  0.0                                      ],
+			        [0.0     , cam.near,  0.0                                  ,  0.0                                      ],
+				[0.0     , 0.0     , -(cam.far+cam.near)/(cam.far-cam.near), -2.0*cam.far*cam.near/(cam.far - cam.near)],
+				[0.0     , 0.0     , -1.0                                  ,  0.0                                      ]]
 		
 		# Generate an orthographic projection matrix
-		# You will need to Scale this matrix.
-		def Orthographic():
-			m = Identity()
-			m[0][0] = 2.0
-			m[0][3] = 0.0
-			m[1][1] = 2.0
-			m[1][3] = 0.0
-			m[2][2] = 1.0
-			m[2][3] = 1.0
-			m[3][3] = 1.0
-			return m
+		# You will need to scale the camera
+		def Orthographic(cam):
+			return [[1.0/cam.scaling[0], 0.0               ,  0.0                   ,  0.0                                  ],
+				[0.0               , 1.0/cam.scaling[1],  0.0                   ,  0.0                                  ],
+				[0.0               , 0.0               , -2.0/(cam.far-cam.near), -(cam.far+cam.near)/(cam.far-cam.near)],
+				[0.0               , 0.0               ,  0.0                   ,  1.0                                  ]]
 		
 		# Generate an isometric projection matrix
 		def Isometric():
+			return [[0.866, 0.0  , 0.866, 0.0],
+			        [0.25 , 0.866,-0.25 , 0.0],
+				[0.0  , 0.0  ,-1.0  , 0.0],
+				[0.0  , 0.0  , 0.0  , 1.0]]
 			m = Identity()
 			m[0][0] = m[0][2] = m[1][1] = 0.8660254037844386
 			m[1][0] = 0.25
diff --git a/source/gameengine/PyDoc/KX_CameraActuator.py b/source/gameengine/PyDoc/KX_CameraActuator.py
new file mode 100644
index 00000000000..1030f0ca836
--- /dev/null
+++ b/source/gameengine/PyDoc/KX_CameraActuator.py
@@ -0,0 +1,11 @@
+# $Id$
+# Documentation for KX_CameraActuator
+from SCA_ILogicBrick import *
+
+class KX_CameraActuator(SCA_ILogicBrick):
+	"""
+	Applies changes to a camera.
+	
+	This actuator has no python methods.
+	"""
+
diff --git a/source/gameengine/PyDoc/KX_GameActuator.py b/source/gameengine/PyDoc/KX_GameActuator.py
index 6c2a989286b..740177dcfca 100644
--- a/source/gameengine/PyDoc/KX_GameActuator.py
+++ b/source/gameengine/PyDoc/KX_GameActuator.py
@@ -1,3 +1,4 @@
+# $Id$
 # Documentation for KX_GameActuator
 
 class KX_GameActuator:
diff --git a/source/gameengine/PyDoc/KX_GameObject.py b/source/gameengine/PyDoc/KX_GameObject.py
index b4a88e83129..cdde9d03968 100644
--- a/source/gameengine/PyDoc/KX_GameObject.py
+++ b/source/gameengine/PyDoc/KX_GameObject.py
@@ -1,3 +1,4 @@
+# $Id$
 # Documentation for game objects
 
 class KX_GameObject:
diff --git a/source/gameengine/PyDoc/KX_Light.py b/source/gameengine/PyDoc/KX_Light.py
new file mode 100644
index 00000000000..95f6622faf0
--- /dev/null
+++ b/source/gameengine/PyDoc/KX_Light.py
@@ -0,0 +1,37 @@
+# $Id$
+# Documentation for Light game objects.
+from KX_GameObject import *
+
+class KX_Light(KX_GameObject):
+	"""
+	A Light object.
+	
+	Constants:
+	@cvar SPOT:   A spot light source. See attribute 'type'
+	@cvar SUN:    A point light source with no attenuation. See attribute 'type'
+	@cvar NORMAL: A point light source. See attribute 'type'
+	
+	Attributes:
+	@cvar type:            The type of light - must be SPOT, SUN or NORMAL
+	@cvar layer:           The layer mask that this light affects object on. (bitfield)
+	@cvar energy:          The brightness of this light. (float)
+	@cvar distance:        The maximum distance this light can illuminate. (float) (SPOT and NORMAL lights only)
+	@cvar colour:          The colour of this light. ([r, g, b]) Black = [0.0, 0.0, 0.0], White = [1.0, 1.0, 1.0]
+	@cvar color:           Synonym for colour.
+	@cvar lin_attenuation: The linear component of this lights attenuation. (SPOT and NORMAL lights only)
+	@cvar spotsize:        The cone angle of the spot light, in degrees. (float) (SPOT lights only)
+	                       0.0 <= spotsize <= 180.0. Spotsize = 360.0 is also accepted. 
+	@cvar spotblend:       Specifies the intensity distribution of the spot light. (float) (SPOT lights only)
+	                       Higher values result in a more focused light source.
+	                       0.0 <= spotblend <= 1.0.
+	
+	Example:
+	# Turn on a red alert light.
+	import GameLogic
+	
+	co = GameLogic.getCurrentController()
+	light = co.getOwner()
+	
+	light.energy = 1.0
+	light.colour = [1.0, 0.0, 0.0]
+	"""
diff --git a/source/gameengine/PyDoc/KX_MeshProxy.py b/source/gameengine/PyDoc/KX_MeshProxy.py
index a5cb8e7ace2..30858ace97f 100644
--- a/source/gameengine/PyDoc/KX_MeshProxy.py
+++ b/source/gameengine/PyDoc/KX_MeshProxy.py
@@ -1,3 +1,4 @@
+# $Id$
 # Documentation for KX_MeshProxy
 
 class KX_MeshProxy:
diff --git a/source/gameengine/PyDoc/KX_MouseFocusSensor.py b/source/gameengine/PyDoc/KX_MouseFocusSensor.py
index 9e0d523725b..28d584037f8 100644
--- a/source/gameengine/PyDoc/KX_MouseFocusSensor.py
+++ b/source/gameengine/PyDoc/KX_MouseFocusSensor.py
@@ -1,3 +1,4 @@
+# $Id$
 # Documentation for KX_MouseFocusSensor
 from SCA_MouseSensor import *
 
diff --git a/source/gameengine/PyDoc/KX_NearSensor.py b/source/gameengine/PyDoc/KX_NearSensor.py
index 95d83ae008e..fef2e4b2acc 100644
--- a/source/gameengine/PyDoc/KX_NearSensor.py
+++ b/source/gameengine/PyDoc/KX_NearSensor.py
@@ -1,3 +1,4 @@
+# $Id$
 # Documentation for KX_NearSensor
 from KX_TouchSensor import *
 
diff --git a/source/gameengine/PyDoc/KX_NetworkMessageSensor.py b/source/gameengine/PyDoc/KX_NetworkMessageSensor.py
index 94ccccc3e09..85f87ecbaa7 100644
--- a/source/gameengine/PyDoc/KX_NetworkMessageSensor.py
+++ b/source/gameengine/PyDoc/KX_NetworkMessageSensor.py
@@ -1,3 +1,4 @@
+# $Id$
 # Documentation for KX_NetworkMessageSensor
 from SCA_ISensor import *
 
diff --git a/source/gameengine/PyDoc/KX_RadarSensor.py b/source/gameengine/PyDoc/KX_RadarSensor.py
index 5800cd3e135..64be858371a 100644
--- a/source/gameengine/PyDoc/KX_RadarSensor.py
+++ b/source/gameengine/PyDoc/KX_RadarSensor.py
@@ -1,3 +1,4 @@
+# $Id$
 # Documentation for KX_RadarSensor
 from KX_NearSensor import *
 
diff --git a/source/gameengine/PyDoc/KX_RaySensor.py b/source/gameengine/PyDoc/KX_RaySensor.py
index ede288d9578..e487edcb655 100644
--- a/source/gameengine/PyDoc/KX_RaySensor.py
+++ b/source/gameengine/PyDoc/KX_RaySensor.py
@@ -1,3 +1,4 @@
+# $Id$
 # Documentation for KX_RaySensor
 from SCA_ISensor import *
 
diff --git a/source/gameengine/PyDoc/KX_TouchSensor.py b/source/gameengine/PyDoc/KX_TouchSensor.py
index 013da4b57c0..88278d57f76 100644
--- a/source/gameengine/PyDoc/KX_TouchSensor.py
+++ b/source/gameengine/PyDoc/KX_TouchSensor.py
@@ -1,3 +1,4 @@
+# $Id$
 # Documentation for KX_TouchSensor
 from SCA_ISensor import *
 
diff --git a/source/gameengine/PyDoc/KX_VertexProxy.py b/source/gameengine/PyDoc/KX_VertexProxy.py
index 41afdbab3d7..198298a5394 100644
--- a/source/gameengine/PyDoc/KX_VertexProxy.py
+++ b/source/gameengine/PyDoc/KX_VertexProxy.py
@@ -1,3 +1,4 @@
+# $Id$
 # Documentation for the vertex proxy class
 
 class KX_VertexProxy:
@@ -5,8 +6,27 @@ class KX_VertexProxy:
 	A vertex holds position, UV, colour and normal information.
 	
 	Note:
-	The physics simulation is NOT currently updated - physics will not respond correctly
+	The physics simulation is NOT currently updated - physics will not respond
 	to changes in the vertex position.
+	
+	Attributes:
+	@cvar XYZ: The position of the vertex. (list [x, y, z])
+	@cvar UV: The texture coordinates of the vertex. (list [u, v])
+	@cvar normal: The normal of the vertex (list [nx, ny, nz])
+	@cvar colour: The colour of the vertex. (list [r, g, b, a]) Black = [0.0, 0.0, 0.0, 1.0], White = [1.0, 1.0, 1.0, 1.0]
+	@cvar color: Synonym for colour.
+	
+	@cvar x: The x coordinate of the vertex. (float)
+	@cvar y: The y coordinate of the vertex. (float)
+	@cvar z: The z coordinate of the vertex. (float)
+	
+	@cvar u: The u texture coordinate of the vertex. (float)
+	@cvar v: The v texture coordinate of the vertex. (float)
+	
+	@cvar r: The red component of the vertex colour.   (float) 0.0 <= r <= 1.0
+	@cvar g: The green component of the vertex colour. (float) 0.0 <= g <= 1.0
+	@cvar b: The blue component of the vertex colour.  (float) 0.0 <= b <= 1.0
+	@cvar a: The alpha component of the vertex colour. (float) 0.0 <= a <= 1.0
 	"""
 	
 	def getXYZ():
diff --git a/source/gameengine/PyDoc/Rasterizer.py b/source/gameengine/PyDoc/Rasterizer.py
index 1dd64a996a2..2c4e368a819 100644
--- a/source/gameengine/PyDoc/Rasterizer.py
+++ b/source/gameengine/PyDoc/Rasterizer.py
@@ -1,3 +1,4 @@
+# $Id$
 """
 Documentation for the Rasterizer module.
 
diff --git a/source/gameengine/PyDoc/SCA_ANDController.py b/source/gameengine/PyDoc/SCA_ANDController.py
new file mode 100644
index 00000000000..eec66f59e5d
--- /dev/null
+++ b/source/gameengine/PyDoc/SCA_ANDController.py
@@ -0,0 +1,11 @@
+# $Id$
+# Documentation for SCA_ANDController
+form SCA_ILogicBrick import *
+
+class SCA_ANDController(SCA_ILogicBrick):
+	"""
+	An AND controller activates only when all linked sensors are activated.
+	
+	There are no special python methods for this controller.
+	"""
+
diff --git a/source/gameengine/PyDoc/SCA_AlwaysSensor.py b/source/gameengine/PyDoc/SCA_AlwaysSensor.py
index 8ab761ce02b..54ab07a8a99 100644
--- a/source/gameengine/PyDoc/SCA_AlwaysSensor.py
+++ b/source/gameengine/PyDoc/SCA_AlwaysSensor.py
@@ -1,3 +1,4 @@
+# $Id$
 # Documentation for SCA_AlwaysSensor
 from SCA_ISensor import *
 
diff --git a/source/gameengine/PyDoc/SCA_ILogicBrick.py b/source/gameengine/PyDoc/SCA_ILogicBrick.py
index 860094b9758..6bb6d7fd43d 100644
--- a/source/gameengine/PyDoc/SCA_ILogicBrick.py
+++ b/source/gameengine/PyDoc/SCA_ILogicBrick.py
@@ -1,3 +1,4 @@
+# $Id$
 # Documentation for the logic brick base class SCA_ILogicBrick
 from KX_GameObject import *
 
diff --git a/source/gameengine/PyDoc/SCA_ISensor.py b/source/gameengine/PyDoc/SCA_ISensor.py
index a5583b0f63f..c964788f447 100644
--- a/source/gameengine/PyDoc/SCA_ISensor.py
+++ b/source/gameengine/PyDoc/SCA_ISensor.py
@@ -1,3 +1,4 @@
+# $Id$
 # Documentation for SCA_ISensor
 from SCA_ILogicBrick import *
 
diff --git a/source/gameengine/PyDoc/SCA_KeyboardSensor.py b/source/gameengine/PyDoc/SCA_KeyboardSensor.py
index 21e2390e39e..e90fb9cc2f1 100644
--- a/source/gameengine/PyDoc/SCA_KeyboardSensor.py
+++ b/source/gameengine/PyDoc/SCA_KeyboardSensor.py
@@ -1,3 +1,4 @@
+# $Id$
 # Documentation for SCA_KeyboardSensor
 from SCA_ISensor import *
 
diff --git a/source/gameengine/PyDoc/SCA_MouseSensor.py b/source/gameengine/PyDoc/SCA_MouseSensor.py
index 24867f192b2..06b261f67fa 100644
--- a/source/gameengine/PyDoc/SCA_MouseSensor.py
+++ b/source/gameengine/PyDoc/SCA_MouseSensor.py
@@ -1,3 +1,4 @@
+# $Id$
 # Documentation for SCA_MouseSensor
 from SCA_ISensor import *
 
diff --git a/source/gameengine/PyDoc/SCA_ORController.py b/source/gameengine/PyDoc/SCA_ORController.py
new file mode 100644
index 00000000000..ccea5837569
--- /dev/null
+++ b/source/gameengine/PyDoc/SCA_ORController.py
@@ -0,0 +1,11 @@
+# $Id$
+# Documentation for SCA_ORController
+from SCA_ILogicBrick import *
+
+class SCA_ORController(SCA_ILogicBrick):
+	"""
+	An OR controller activates when any connected sensor activates.
+	
+	There are no special python methods for this controller.
+	"""
+
diff --git a/source/gameengine/PyDoc/SCA_PropertySensor.py b/source/gameengine/PyDoc/SCA_PropertySensor.py
index ad5b1e87a7d..f0a14477b24 100644
--- a/source/gameengine/PyDoc/SCA_PropertySensor.py
+++ b/source/gameengine/PyDoc/SCA_PropertySensor.py
@@ -1,3 +1,4 @@
+# $Id$
 # Documentation for SCA_PropertySensor
 from SCA_ISensor import *
 
diff --git a/source/gameengine/PyDoc/SCA_PythonController.py b/source/gameengine/PyDoc/SCA_PythonController.py
index a07edd03a8c..f0926178288 100644
--- a/source/gameengine/PyDoc/SCA_PythonController.py
+++ b/source/gameengine/PyDoc/SCA_PythonController.py
@@ -1,3 +1,4 @@
+# $Id$
 # Documentation for SCA_PythonController
 from SCA_ILogicBrick import *
 
diff --git a/source/gameengine/PyDoc/SCA_RandomSensor.py b/source/gameengine/PyDoc/SCA_RandomSensor.py
index bab92f2afc8..940b8f879ff 100644
--- a/source/gameengine/PyDoc/SCA_RandomSensor.py
+++ b/source/gameengine/PyDoc/SCA_RandomSensor.py
@@ -1,3 +1,4 @@
+# $Id$
 # Documentation for SCA_RandomSensor
 from SCA_ISensor import *