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

Class KX_RaySensor

SCA_ILogicBrick --+    
                  |    
        SCA_ISensor --+
                      |
                     KX_RaySensor


A ray sensor detects the first object in a given direction.
Method Summary
list [nx, ny, nz] getHitNormal()
Returns the normal (in worldcoordinates) of the object at the location where the object was hit by this ray.
KX_GameObject getHitObject()
Returns the game object that was hit by this ray.
list [x, y, z] getHitPosition()
Returns the position (in worldcoordinates) where the object was hit by this ray.
list [dx, dy, dz] getRayDirection()
Returns the direction from the ray (in worldcoordinates)
    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

getHitNormal()

Returns the normal (in worldcoordinates) of the object at the location where the object was hit by this ray.
Returns:
list [nx, ny, nz]

getHitObject()

Returns the game object that was hit by this ray.
Returns:
KX_GameObject

getHitPosition()

Returns the position (in worldcoordinates) where the object was hit by this ray.
Returns:
list [x, y, z]

getRayDirection()

Returns the direction from the ray (in worldcoordinates)
Returns:
list [dx, dy, dz]

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