2.50: svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r19323...
[blender.git] / source / gameengine / PyDoc / KX_MouseFocusSensor.py
index 28d5840..24f7716 100644 (file)
@@ -8,19 +8,60 @@ class KX_MouseFocusSensor(SCA_MouseSensor):
        
        The mouse focus sensor works by transforming the mouse coordinates from 2d device
        space to 3d space then raycasting away from the camera.
+       
+       @ivar raySource: The worldspace source of the ray (the view position)
+       @type raySource: list (vector of 3 floats)
+       @ivar rayTarget: The worldspace target of the ray.
+       @type rayTarget: list (vector of 3 floats)
+       @ivar rayDirection: The L{rayTarget} - L{raySource} normalized.
+       @type rayDirection: list (normalized vector of 3 floats)
+       @ivar hitObject: the last object the mouse was over.
+       @type hitObject: L{KX_GameObject<KX_GameObject.KX_GameObject>} or None
+       @ivar hitPosition: The worldspace position of the ray intersecton.
+       @type hitPosition: list (vector of 3 floats)
+       @ivar hitNormal: the worldspace normal from the face at point of intersection.
+       @type hitNormal: list (normalized vector of 3 floats)
        """
        
-       def GetRayTarget():
+       def getHitNormal():
+               """
+               Returns the normal (in worldcoordinates) at the point of collision where the object was hit by this ray. (B{deprecated})
+                
+               @rtype: list [x, y, z]
+               @return: the ray collision normal.
+               """
+       def getHitObject():
+               """
+               Returns the object that was hit by this ray or None. (B{deprecated})
+               
+               @rtype: L{KX_GameObject} or None
+               @return: the collision object.
+               """
+       def getHitPosition():
                """
-               Returns the end point of the sensor ray.
+               Returns the position (in worldcoordinates) at the point of collision where the object was hit by this ray. (B{deprecated})
                
                @rtype: list [x, y, z]
-               @return: the end point of the sensor ray, in world coordinates.
+               @return: the ray collision position.
                """
-       def GetRaySource():
+       def getRayDirection():
                """
-               Returns the start point of the sensor ray.
+               Returns the normalized direction (in worldcoordinates) of the ray cast by the mouse. (B{deprecated})
                
                @rtype: list [x, y, z]
-               @return: the start point of the sensor ray, in world coordinates.
+               @return: the ray direction.
                """
+       def getRaySource():
+               """
+               Returns the position (in worldcoordinates) the ray was cast from by the mouse. (B{deprecated})
+               
+               @rtype: list [x, y, z]
+               @return: the ray source.
+               """
+       def getRayTarget():
+               """
+               Returns the target of the ray (in worldcoordinates) that seeks the focus object. (B{deprecated})
+               
+               @rtype: list [x, y, z]
+               @return: the ray target.
+               """
\ No newline at end of file