doc corrections and add bge.types.KX_ArmatureSensor
authorCampbell Barton <ideasman42@gmail.com>
Wed, 21 Nov 2012 08:53:04 +0000 (08:53 +0000)
committerCampbell Barton <ideasman42@gmail.com>
Wed, 21 Nov 2012 08:53:04 +0000 (08:53 +0000)
doc/python_api/rst/bge.logic.rst
doc/python_api/rst/bge.types.rst
doc/python_api/rst/bgl.rst
source/gameengine/Ketsji/KX_PolygonMaterial.cpp
source/gameengine/Ketsji/KX_PyConstraintBinding.cpp
source/gameengine/Ketsji/KX_PythonInitTypes.cpp

index 260a86f7c59c861ab760d3db3017f24fbe499519..b28c9603ef15dfe00f04baaea1229b421dd4543e 100644 (file)
@@ -254,13 +254,6 @@ General functions
    
    :rtype: list [float], len(getSpectrum()) == 512
 
-.. function:: stopDSP()
-
-   Stops the sound driver using DSP effects.
-   
-   Only the fmod sound driver supports this.
-   DSP can be computationally expensive.
-
 .. function:: getMaxLogicFrame()
 
    Gets the maximum number of logic frames per render frame.
@@ -493,31 +486,31 @@ See :class:`bge.types.KX_ConstraintActuator.option`
 
 * Applicable to Distance constraint:
 
-  .. data:: KX_ACT_CONSTRAINT_NORMAL
+  .. data:: KX_CONSTRAINT_NORMAL
 
      Activate alignment to surface
    
-  .. data:: KX_ACT_CONSTRAINT_DISTANCE
+  .. data:: KX_CONSTRAINT_DISTANCE
 
      Activate distance control
 
-  .. data:: KX_ACT_CONSTRAINT_LOCAL
+  .. data:: KX_CONSTRAINT_LOCAL
 
      Direction of the ray is along the local axis
 
 * Applicable to Force field constraint:
 
-  .. data:: KX_ACT_CONSTRAINT_DOROTFH
+  .. data:: KX_CONSTRAINT_DOROTFH
 
      Force field act on rotation as well
 
 * Applicable to both:
 
-  .. data:: KX_ACT_CONSTRAINT_MATERIAL
+  .. data:: KX_CONSTRAINT_MATERIAL
 
      Detect material rather than property
    
-  .. data:: KX_ACT_CONSTRAINT_PERMANENT
+  .. data:: KX_CONSTRAINTACT_PERMANENT
 
      No deactivation if ray does not hit target
 
@@ -585,27 +578,27 @@ See :class:`bge.types.KX_ConstraintActuator.limit`
 
    Set orientation of Z axis
    
-.. data:: KX_ACT_CONSTRAINT_FHNX
+.. data:: KX_CONSTRAINTACT_FHNX
 
    Set force field along negative X axis
    
-.. data:: KX_ACT_CONSTRAINT_FHNY
+.. data:: KX_CONSTRAINTACT_FHNY
 
    Set force field along negative Y axis
    
-.. data:: KX_ACT_CONSTRAINT_FHNZ
+.. data:: KX_CONSTRAINTACT_FHNZ
 
    Set force field along negative Z axis
    
-.. data:: KX_ACT_CONSTRAINT_FHPX
+.. data:: KX_CONSTRAINTACT_FHPX
 
    Set force field along positive X axis
 
-.. data:: KX_ACT_CONSTRAINT_FHPY
+.. data:: KX_CONSTRAINTACT_FHPY
 
    Set force field along positive Y axis
    
-.. data:: KX_ACT_CONSTRAINT_FHPZ
+.. data:: KX_CONSTRAINTACT_FHPZ
 
    Set force field along positive Z axis
 
index 15d188e0734f510786813ab24903197bbd8c431b..72cc6a5f154c490b057daa0928362b55cfa79b06 100644 (file)
@@ -762,12 +762,6 @@ Types
 
       :type: float
 
-   .. attribute:: useXY
-
-      axis this actuator is tracking, True=X, False=Y.
-
-      :type: boolean
-
    .. attribute:: object
 
       the object this actuator tracks.
@@ -1810,10 +1804,6 @@ Types
 
       :type: list [r, g, b]
 
-   .. attribute:: colour
-
-      Synonym for color.
-
    .. attribute:: lin_attenuation
 
       The linear component of this light's attenuation. (SPOT and NORMAL lights only).
@@ -1898,11 +1888,6 @@ Types
 
       :type: integer
 
-   .. method:: getNumMaterials()
-
-      :return: number of materials associated with this object
-      :rtype: integer
-
    .. method:: getMaterialName(matid)
 
       Gets the name of the specified material.
@@ -1943,11 +1928,6 @@ Types
       :return: a vertex object.
       :rtype: :class:`KX_VertexProxy`
 
-   .. method:: getNumPolygons()
-
-      :return: The number of polygon in the mesh.
-      :rtype: integer
-
    .. method:: getPolygon(index)
 
       Gets the specified polygon from the mesh.
@@ -2382,7 +2362,7 @@ Types
    The polygon attributes are read-only, you need to retrieve the vertex proxy if you want
    to change the vertex settings.
 
-   .. attribute:: matname
+   .. attribute:: material_name
 
       The name of polygon material, empty if no material.
 
@@ -2394,13 +2374,13 @@ Types
 
       :type: :class:`KX_PolygonMaterial` or :class:`KX_BlenderMaterial`
 
-   .. attribute:: texture
+   .. attribute:: texture_name
 
       The texture name of the polygon.
 
       :type: string
 
-   .. attribute:: matid
+   .. attribute:: material_id
 
       The material index of the polygon, use this to retrieve vertex proxy from mesh proxy.
 
@@ -2631,18 +2611,6 @@ Types
 
       :type: boolean
 
-   .. attribute:: lightlayer
-
-      Light layers this material affects.
-
-      :type: bitfield.
-
-   .. attribute:: triangle
-
-      Mesh data with this material is triangles. It's probably not safe to change this.
-
-      :type: boolean
-
    .. attribute:: diffuse
 
       The diffuse color of the material. black = [0.0, 0.0, 0.0] white = [1.0, 1.0, 1.0].
@@ -3228,13 +3196,7 @@ Types
 
    Sound Actuator.
 
-   The :data:`startSound`, :data:`pauseSound` and :data:`stopSound` do not requirethe actuator to be activated - they act instantly provided that the actuator has been activated once at least.
-
-   .. attribute:: fileName
-
-      The filename of the sound this actuator plays.
-
-      :type: string
+   The :data:`startSound`, :data:`pauseSound` and :data:`stopSound` do not require the actuator to be activated - they act instantly provided that the actuator has been activated once at least.
 
    .. attribute:: volume
 
@@ -3248,36 +3210,6 @@ Types
 
       :type: float
 
-   .. attribute:: rollOffFactor
-
-      The roll off factor. Rolloff defines the rate of attenuation as the sound gets further away.
-
-      :type: float
-
-   .. attribute:: looping
-
-      The loop mode of the actuator.
-
-      :type: integer
-
-   .. attribute:: position
-
-      The position of the sound as a list: [x, y, z].
-
-      :type: float array
-
-   .. attribute:: velocity
-
-      The velocity of the emitter as a list: [x, y, z]. The relative velocity to the observer determines the pitch. List of 3 floats: [x, y, z].
-
-      :type: float array
-
-   .. attribute:: orientation
-
-      The orientation of the sound. When setting the orientation you can also use quaternion [float, float, float, float] or euler angles [float, float, float].
-
-      :type: 3x3 matrix [[float]]
-
    .. attribute:: mode
 
       The operation mode of the actuator. Can be one of :ref:`these constants<logic-sound-actuator>`
@@ -3546,10 +3478,6 @@ Types
 
       Black = [0.0, 0.0, 0.0, 1.0], White = [1.0, 1.0, 1.0, 1.0]
 
-   .. attribute:: colour
-
-      Synonym for color.
-
    .. attribute:: x
 
       The x coordinate of the vertex.
@@ -4270,24 +4198,6 @@ Types
 
       :type: integer
 
-   .. method:: setSeed(seed)
-
-      Sets the seed of the random number generator.
-
-      If the seed is 0, the generator will produce the same value on every call.
-
-      :type seed: integer
-
-   .. method:: getSeed()
-
-      :return: The initial seed of the generator.  Equal seeds produce equal random series.
-      :rtype: integer
-
-   .. method:: getLastDraw()
-
-      :return: The last random number generated.
-      :rtype: integer
-
 .. class:: SCA_XNORController(SCA_IController)
 
    An XNOR controller activates when all linked sensors are the same (activated or inative).
index 9f7817c6fa20ebb84480b2ce9ce57a1d936b17bd..eefa30403a27450b5e39d1d92de943e1e3477534 100644 (file)
@@ -1510,7 +1510,7 @@ OpenGL}" and the online NeHe tutorials are two of the best resources.
    :arg mode: Specifies a symbolic value representing a shading technique.
 
 
-.. function:: glStencilFuc(func, ref, mask):
+.. function:: glStencilFunc(func, ref, mask):
 
    Set function and reference value for stencil testing
 
index b02df7be26fc261035a1014d7484921b5fedc9a5..f157d9ed20ab1c9dcdb65679e693ead7784c723b 100644 (file)
@@ -266,8 +266,6 @@ PyAttributeDef KX_PolygonMaterial::Attributes[] = {
        
        KX_PYATTRIBUTE_RO_FUNCTION("tface",     KX_PolygonMaterial, pyattr_get_tface), /* How the heck is this even useful??? - Campbell */
        KX_PYATTRIBUTE_RO_FUNCTION("gl_texture", KX_PolygonMaterial, pyattr_get_gl_texture), /* could be called 'bindcode' */
-       
-       /* triangle used to be an attribute, removed for 2.49, nobody should be using it */
        { NULL }        //Sentinel
 };
 
index a562b3ff682b1f7a497aae8792dc0464106d883b..abddd4c97f81390d089796d8ee3897fe8404b0e6 100644 (file)
@@ -729,7 +729,7 @@ PyObject *initPythonConstraintBinding()
        KX_MACRO_addTypesToDict(d, DBG_PROFILETIMINGS, btIDebugDraw::DBG_ProfileTimings);
        KX_MACRO_addTypesToDict(d, DBG_ENABLESATCOMPARISION, btIDebugDraw::DBG_EnableSatComparison);
        KX_MACRO_addTypesToDict(d, DBG_DISABLEBULLETLCP, btIDebugDraw::DBG_DisableBulletLCP);
-       KX_MACRO_addTypesToDict(d, DBG_ENABLECDD, btIDebugDraw::DBG_EnableCCD);
+       KX_MACRO_addTypesToDict(d, DBG_ENABLECCD, btIDebugDraw::DBG_EnableCCD);
        KX_MACRO_addTypesToDict(d, DBG_DRAWCONSTRAINTS, btIDebugDraw::DBG_DrawConstraints);
        KX_MACRO_addTypesToDict(d, DBG_DRAWCONSTRAINTLIMITS, btIDebugDraw::DBG_DrawConstraintLimits);
        KX_MACRO_addTypesToDict(d, DBG_FASTWIREFRAME, btIDebugDraw::DBG_FastWireframe);
index 805b9ce2fc2a6b8a92924fa71af0a97e4f2f31f4..d3c5a3f132fa8a62d1b3cd5ffd273b0831948446 100644 (file)
@@ -40,6 +40,7 @@
 #include "BL_ArmatureConstraint.h"
 #include "BL_ArmatureObject.h"
 #include "BL_ArmatureChannel.h"
+#include "KX_ArmatureSensor.h"
 #include "KX_BlenderMaterial.h"
 #include "KX_CameraActuator.h"
 #include "KX_CharacterWrapper.h"
@@ -185,8 +186,10 @@ void initPyTypes(void)
                PyType_Ready_Attr(dict, BL_ArmatureConstraint, init_getset);
                PyType_Ready_AttrPtr(dict, BL_ArmatureBone, init_getset);
                PyType_Ready_AttrPtr(dict, BL_ArmatureChannel, init_getset);
+               // PyType_Ready_Attr(dict, CPropValue, init_getset);  // doesn't use Py_Header
                PyType_Ready_Attr(dict, CListValue, init_getset);
                PyType_Ready_Attr(dict, CValue, init_getset);
+               PyType_Ready_Attr(dict, KX_ArmatureSensor, init_getset);
                PyType_Ready_Attr(dict, KX_BlenderMaterial, init_getset);
                PyType_Ready_Attr(dict, KX_Camera, init_getset);
                PyType_Ready_Attr(dict, KX_CameraActuator, init_getset);
@@ -228,6 +231,7 @@ void initPyTypes(void)
                PyType_Ready_Attr(dict, PyObjectPlus, init_getset);
                PyType_Ready_Attr(dict, SCA_2DFilterActuator, init_getset);
                PyType_Ready_Attr(dict, SCA_ANDController, init_getset);
+               // PyType_Ready_Attr(dict, SCA_Actuator, init_getset);  // doesn't use Py_Header
                PyType_Ready_Attr(dict, SCA_ActuatorSensor, init_getset);
                PyType_Ready_Attr(dict, SCA_AlwaysSensor, init_getset);
                PyType_Ready_Attr(dict, SCA_DelaySensor, init_getset);