[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [20208] trunk/blender/source/gameengine: BGE PyAPI

Campbell Barton ideasman42 at gmail.com
Fri May 15 01:06:05 CEST 2009


Revision: 20208
          http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-blender&revision=20208
Author:   campbellbarton
Date:     2009-05-15 01:06:05 +0200 (Fri, 15 May 2009)

Log Message:
-----------
BGE PyAPI
[#18701] Issues with camera.pointInsideFrustum method
- note in docs that the projection matrix is not correct for first logic tick.

Renamed...
KX_Camera.isViewport -> KX_Camera.useViewport
KX_Lamp.quat_attenuation -> KX_Lamp.quad_attenuation

Deprecated KX_Camera.getProjectionMatrix(), KX_Camera.setProjectionMatrix() for projection_matrix attr

Added most missing docs reported by the doc-checker script

Modified Paths:
--------------
    trunk/blender/source/gameengine/Ketsji/KX_Camera.cpp
    trunk/blender/source/gameengine/Ketsji/KX_Camera.h
    trunk/blender/source/gameengine/Ketsji/KX_Light.cpp
    trunk/blender/source/gameengine/PyDoc/GameLogic.py
    trunk/blender/source/gameengine/PyDoc/GameTypes.py

Modified: trunk/blender/source/gameengine/Ketsji/KX_Camera.cpp
===================================================================
--- trunk/blender/source/gameengine/Ketsji/KX_Camera.cpp	2009-05-14 21:06:48 UTC (rev 20207)
+++ trunk/blender/source/gameengine/Ketsji/KX_Camera.cpp	2009-05-14 23:06:05 UTC (rev 20208)
@@ -476,13 +476,13 @@
 	KX_PYMETHODTABLE_O(KX_Camera, pointInsideFrustum),
 	KX_PYMETHODTABLE_NOARGS(KX_Camera, getCameraToWorld),
 	KX_PYMETHODTABLE_NOARGS(KX_Camera, getWorldToCamera),
-	KX_PYMETHODTABLE_NOARGS(KX_Camera, getProjectionMatrix),
-	KX_PYMETHODTABLE_O(KX_Camera, setProjectionMatrix),
 	KX_PYMETHODTABLE(KX_Camera, setViewport),
 	KX_PYMETHODTABLE_NOARGS(KX_Camera, setOnTop),
 	
 	// DEPRECATED
 	KX_PYMETHODTABLE_O(KX_Camera, enableViewport),
+	KX_PYMETHODTABLE_NOARGS(KX_Camera, getProjectionMatrix),
+	KX_PYMETHODTABLE_O(KX_Camera, setProjectionMatrix),
 	
 	{NULL,NULL} //Sentinel
 };
@@ -496,9 +496,9 @@
 	KX_PYATTRIBUTE_RW_FUNCTION("near",	KX_Camera,	pyattr_get_near, pyattr_set_near),
 	KX_PYATTRIBUTE_RW_FUNCTION("far",	KX_Camera,	pyattr_get_far,  pyattr_set_far),
 	
-	KX_PYATTRIBUTE_RW_FUNCTION("isViewport",	KX_Camera,	pyattr_get_is_viewport,  pyattr_set_is_viewport),
+	KX_PYATTRIBUTE_RW_FUNCTION("useViewport",	KX_Camera,	pyattr_get_use_viewport,  pyattr_set_use_viewport),
 	
-	KX_PYATTRIBUTE_RO_FUNCTION("projection_matrix",	KX_Camera,	pyattr_get_projection_matrix),
+	KX_PYATTRIBUTE_RW_FUNCTION("projection_matrix",	KX_Camera,	pyattr_get_projection_matrix, pyattr_set_projection_matrix),
 	KX_PYATTRIBUTE_RO_FUNCTION("modelview_matrix",	KX_Camera,	pyattr_get_modelview_matrix),
 	KX_PYATTRIBUTE_RO_FUNCTION("camera_to_world",	KX_Camera,	pyattr_get_camera_to_world),
 	KX_PYATTRIBUTE_RO_FUNCTION("world_to_camera",	KX_Camera,	pyattr_get_world_to_camera),
@@ -693,6 +693,7 @@
 "\tie: [[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]])\n"
 )
 {
+	ShowDeprecationWarning("getProjectionMatrix()", "the projection_matrix property");
 	return PyObjectFrom(GetProjectionMatrix()); /* new ref */
 }
 
@@ -738,6 +739,8 @@
 "\tcam = co.getOwner()\n"
 "\tcam.setProjectionMatrix(Perspective(-1.0, 1.0, -1.0, 1.0, 0.1, 1))\n")
 {
+	ShowDeprecationWarning("setProjectionMatrix(mat)", "the projection_matrix property");
+	
 	MT_Matrix4x4 mat;
 	if (!PyMatTo(value, mat))
 	{
@@ -871,18 +874,18 @@
 }
 
 
-PyObject* KX_Camera::pyattr_get_is_viewport(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef)
+PyObject* KX_Camera::pyattr_get_use_viewport(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef)
 {
 	KX_Camera* self= static_cast<KX_Camera*>(self_v);
 	return PyBool_FromLong(self->GetViewport());
 }
 
-int KX_Camera::pyattr_set_is_viewport(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value)
+int KX_Camera::pyattr_set_use_viewport(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value)
 {
 	KX_Camera* self= static_cast<KX_Camera*>(self_v);
 	int param = PyObject_IsTrue( value );
 	if (param == -1) {
-		PyErr_SetString(PyExc_AttributeError, "camera.isViewport = bool: KX_Camera, expected True or False");
+		PyErr_SetString(PyExc_AttributeError, "camera.useViewport = bool: KX_Camera, expected True or False");
 		return 1;
 	}
 	self->EnableViewport((bool)param);

Modified: trunk/blender/source/gameengine/Ketsji/KX_Camera.h
===================================================================
--- trunk/blender/source/gameengine/Ketsji/KX_Camera.h	2009-05-14 21:06:48 UTC (rev 20207)
+++ trunk/blender/source/gameengine/Ketsji/KX_Camera.h	2009-05-14 23:06:05 UTC (rev 20208)
@@ -287,8 +287,8 @@
 	static PyObject*	pyattr_get_far(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
 	static int			pyattr_set_far(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
 	
-	static PyObject*	pyattr_get_is_viewport(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
-	static int			pyattr_set_is_viewport(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
+	static PyObject*	pyattr_get_use_viewport(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
+	static int			pyattr_set_use_viewport(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
 	
 	static PyObject*	pyattr_get_projection_matrix(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
 	static int			pyattr_set_projection_matrix(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);

Modified: trunk/blender/source/gameengine/Ketsji/KX_Light.cpp
===================================================================
--- trunk/blender/source/gameengine/Ketsji/KX_Light.cpp	2009-05-14 21:06:48 UTC (rev 20207)
+++ trunk/blender/source/gameengine/Ketsji/KX_Light.cpp	2009-05-14 23:06:05 UTC (rev 20208)
@@ -235,7 +235,7 @@
 	KX_PYATTRIBUTE_RW_FUNCTION("color", KX_LightObject, pyattr_get_color, pyattr_set_color),
 	KX_PYATTRIBUTE_RW_FUNCTION("colour", KX_LightObject, pyattr_get_color, pyattr_set_color),
 	KX_PYATTRIBUTE_FLOAT_RW("lin_attenuation", 0, 1, KX_LightObject, m_lightobj.m_att1),
-	KX_PYATTRIBUTE_FLOAT_RW("quat_attenuation", 0, 1, KX_LightObject, m_lightobj.m_att2),
+	KX_PYATTRIBUTE_FLOAT_RW("quad_attenuation", 0, 1, KX_LightObject, m_lightobj.m_att2),
 	KX_PYATTRIBUTE_FLOAT_RW("spotsize", 1, 180, KX_LightObject, m_lightobj.m_spotsize),
 	KX_PYATTRIBUTE_FLOAT_RW("spotblend", 0, 1, KX_LightObject, m_lightobj.m_spotblend),
 	KX_PYATTRIBUTE_RO_FUNCTION("SPOT", KX_LightObject, pyattr_get_typeconst),

Modified: trunk/blender/source/gameengine/PyDoc/GameLogic.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/GameLogic.py	2009-05-14 21:06:48 UTC (rev 20207)
+++ trunk/blender/source/gameengine/PyDoc/GameLogic.py	2009-05-14 23:06:05 UTC (rev 20208)
@@ -104,17 +104,14 @@
 @var KX_TRUE: True value used by some modules.
 @var KX_FALSE: False value used by some modules.
 
- at group Property Sensor: KX_PROPSENSOR_EQUAL, KX_PROPSENSOR_NOTEQUAL, KX_PROPSENSOR_INTERVAL, KX_PROPSENSOR_CHANGED, KX_PROPSENSOR_EXPRESSION
+ at group Property Sensor: KX_PROPSENSOR_*
 @var KX_PROPSENSOR_EQUAL:		Activate when the property is equal to the sensor value.
 @var KX_PROPSENSOR_NOTEQUAL:	Activate when the property is not equal to the sensor value.
 @var KX_PROPSENSOR_INTERVAL:	Activate when the property is between the specified limits.
 @var KX_PROPSENSOR_CHANGED:	Activate when the property changes
 @var KX_PROPSENSOR_EXPRESSION:	Activate when the expression matches
 
-
-
-
- at group Constraint Actuator: KX_CONSTRAINTACT_LOCX, KX_CONSTRAINTACT_LOCY, KX_CONSTRAINTACT_LOCZ, KX_CONSTRAINTACT_ROTX, KX_CONSTRAINTACT_ROTY, KX_CONSTRAINTACT_ROTZ, KX_CONSTRAINTACT_DIRNX, KX_CONSTRAINTACT_DIRNY, KX_CONSTRAINTACT_DIRPX, KX_CONSTRAINTACT_DIRPY, KX_CONSTRAINTACT_ORIX, KX_CONSTRAINTACT_ORIY, KX_CONSTRAINTACT_ORIZ
+ at group Constraint Actuator: KX_CONSTRAINTACT_*
 @var KX_CONSTRAINTACT_LOCX: See L{KX_ConstraintActuator}
 @var KX_CONSTRAINTACT_LOCY: See L{KX_ConstraintActuator}
 @var KX_CONSTRAINTACT_LOCZ: See L{KX_ConstraintActuator}
@@ -129,7 +126,7 @@
 @var KX_CONSTRAINTACT_ORIY: See L{KX_ConstraintActuator}
 @var KX_CONSTRAINTACT_ORIZ: See L{KX_ConstraintActuator}
 
- at group IPO Actuator: KX_IPOACT_PLAY, KX_IPOACT_PINGPONG, KX_IPOACT_FLIPPER, KX_IPOACT_LOOPSTOP, KX_IPOACT_LOOPEND, KX_IPOACT_FROM_PROP
+ at group IPO Actuator: KX_IPOACT_*
 @var KX_IPOACT_PLAY:	 See L{KX_IpoActuator}
 @var KX_IPOACT_PINGPONG:	 See L{KX_IpoActuator}
 @var KX_IPOACT_FLIPPER:	 See L{KX_IpoActuator}
@@ -137,7 +134,7 @@
 @var KX_IPOACT_LOOPEND:	 See L{KX_IpoActuator}
 @var KX_IPOACT_FROM_PROP:	 See L{KX_IpoActuator}
 
- at group Random Distributions: KX_RANDOMACT_BOOL_CONST, KX_RANDOMACT_BOOL_UNIFORM, KX_RANDOMACT_BOOL_BERNOUILLI, KX_RANDOMACT_INT_CONST, KX_RANDOMACT_INT_UNIFORM, KX_RANDOMACT_INT_POISSON, KX_RANDOMACT_FLOAT_CONST, KX_RANDOMACT_FLOAT_UNIFORM, KX_RANDOMACT_FLOAT_NORMAL, KX_RANDOMACT_FLOAT_NEGATIVE_EXPONENTIAL
+ at group Random Distributions: KX_RANDOMACT_*
 @var KX_RANDOMACT_BOOL_CONST:		See L{SCA_RandomActuator}
 @var KX_RANDOMACT_BOOL_UNIFORM:		See L{SCA_RandomActuator}
 @var KX_RANDOMACT_BOOL_BERNOUILLI:		See L{SCA_RandomActuator}
@@ -149,14 +146,14 @@
 @var KX_RANDOMACT_FLOAT_NORMAL:		See L{SCA_RandomActuator}
 @var KX_RANDOMACT_FLOAT_NEGATIVE_EXPONENTIAL:		See L{SCA_RandomActuator}
 
- at group Action Actuator: KX_ACTIONACT_PLAY, KX_ACTIONACT_FLIPPER, KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND, KX_ACTIONACT_PROPERTY
+ at group Action Actuator: KX_ACTIONACT_*
 @var KX_ACTIONACT_PLAY:	    See L{BL_ActionActuator}
 @var KX_ACTIONACT_FLIPPER:  See L{BL_ActionActuator}
 @var KX_ACTIONACT_LOOPSTOP: See L{BL_ActionActuator}
 @var KX_ACTIONACT_LOOPEND:  See L{BL_ActionActuator}
 @var KX_ACTIONACT_PROPERTY: See L{BL_ActionActuator}
 
- at group Sound Actuator: KX_SOUNDACT_PLAYSTOP, KX_SOUNDACT_PLAYEND, KX_SOUNDACT_LOOPSTOP, KX_SOUNDACT_LOOPEND, KX_SOUNDACT_LOOPBIDIRECTIONAL, KX_SOUNDACT_LOOPBIDIRECTIONAL_STOP
+ at group Sound Actuator: KX_SOUNDACT_*
 @var KX_SOUNDACT_PLAYSTOP:		    See L{KX_SoundActuator}
 @var KX_SOUNDACT_PLAYEND:		    See L{KX_SoundActuator}
 @var KX_SOUNDACT_LOOPSTOP:		    See L{KX_SoundActuator}
@@ -164,7 +161,7 @@
 @var KX_SOUNDACT_LOOPBIDIRECTIONAL:	    See L{KX_SoundActuator}
 @var KX_SOUNDACT_LOOPBIDIRECTIONAL_STOP:    See L{KX_SoundActuator}
 
- at group Radar Sensor: KX_RADAR_AXIS_POS_X, KX_RADAR_AXIS_POS_Y, KX_RADAR_AXIS_POS_Z, KX_RADAR_AXIS_NEG_X, KX_RADAR_AXIS_NEG_Y, KX_RADAR_AXIS_NEG_Z
+ at group Radar Sensor: KX_RADAR_*
 @var KX_RADAR_AXIS_POS_X:		    See L{KX_RadarSensor}
 @var KX_RADAR_AXIS_POS_Y:		    See L{KX_RadarSensor}
 @var KX_RADAR_AXIS_POS_Z:		    See L{KX_RadarSensor}
@@ -172,7 +169,7 @@
 @var KX_RADAR_AXIS_NEG_Y:		    See L{KX_RadarSensor}
 @var KX_RADAR_AXIS_NEG_Z:		    See L{KX_RadarSensor}
 
- at group Ray Sensor: KX_RAY_AXIS_POS_X, KX_RAY_AXIS_POS_Y, KX_RAY_AXIS_POS_Z, KX_RAY_AXIS_NEG_X, KX_RAY_AXIS_NEG_Y, KX_RAY_AXIS_NEG_Z
+ at group Ray Sensor: KX_RAY_*
 @var KX_RAY_AXIS_POS_X:		    See L{KX_RaySensor}
 @var KX_RAY_AXIS_POS_Y:		    See L{KX_RaySensor}
 @var KX_RAY_AXIS_POS_Z:		    See L{KX_RaySensor}
@@ -180,44 +177,44 @@
 @var KX_RAY_AXIS_NEG_Y:		    See L{KX_RaySensor}
 @var KX_RAY_AXIS_NEG_Z:		    See L{KX_RaySensor}
 
- at group Dynamic Actuator: KX_DYN_RESTORE_DYNAMICS, KX_DYN_DISABLE_DYNAMICS, KX_DYN_ENABLE_RIGID_BODY, KX_DYN_DISABLE_RIGID_BODY,	KX_DYN_SET_MASS
+ at group Dynamic Actuator: KX_DYN_*
 @var KX_DYN_RESTORE_DYNAMICS:	See L{KX_SCA_DynamicActuator}

@@ Diff output truncated at 10240 characters. @@




More information about the Bf-blender-cvs mailing list