Module KX_MouseFocusSensor :: Class KX_MouseFocusSensor
[frames | no frames]

Class KX_MouseFocusSensor

SCA_ILogicBrick --+        
                  |        
        SCA_ISensor --+    
                      |    
        SCA_MouseSensor --+
                          |
                         KX_MouseFocusSensor


The mouse focus sensor detects when the mouse is over the current game object.

The mouse focus sensor works by transforming the mouse coordinates from 2d device space to 3d space then raycasting away from the camera.
Method Summary
list [x, y, z] GetRaySource()
Returns the start point of the sensor ray.
list [x, y, z] GetRayTarget()
Returns the end point of the sensor ray.
    Inherited from SCA_MouseSensor
integer getXPosition()
Gets the x coordinate of the mouse.
integer getYPosition()
Gets the y coordinate of the mouse.
    Inherited from SCA_ISensor
integer getFrequency()
The frequency for pulse mode sensors.
  getInvert()
True if this sensor activates on negative events.
  getUseNegPulseMode()
True if the sensor is in negative pulse mode.
  getUsePosPulseMode()
True if the sensor is in positive pulse mode.
  isPositive()
True if this sensor brick has been activated.
  setFrequency(freq)
Sets the frequency for pulse mode sensors.
  setInvert(invert)
Sets if this sensor activates on positive or negative events.
  setUseNegPulseMode(pulse)
Sets negative pulse mode.
  setUsePosPulseMode(pulse)
Sets positive pulse mode.
    Inherited from SCA_ILogicBrick
integer getExecutePriority()
Gets the execution priority of this logic brick.
KX_GameObject getOwner()
Gets the game object associated with this logic brick.
  setExecutePriority(priority)
Sets the priority of this logic brick.

Method Details

GetRaySource()

Returns the start point of the sensor ray.
Returns:
the start point of the sensor ray, in world coordinates.
           (type=list [x, y, z])

GetRayTarget()

Returns the end point of the sensor ray.
Returns:
the end point of the sensor ray, in world coordinates.
           (type=list [x, y, z])

Generated by Epydoc 2.1 on Thu Feb 1 00:12:33 2007 http://epydoc.sf.net