Module KX_MouseFocusSensor :: Class KX_MouseFocusSensor

Class KX_MouseFocusSensor

SCA_ILogicBrick.SCA_ILogicBrick --+        
                                  |        
            SCA_ISensor.SCA_ISensor --+    
                                      |    
        SCA_MouseSensor.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.

Instance Methods
list [x, y, z]
getHitNormal()
Returns the normal (in worldcoordinates) at the point of collision where the object was hit by this ray.
KX_GameObject or None
getHitObject()
Returns the object that was hit by this ray or None.
list [x, y, z]
getHitPosition()
Returns the position (in worldcoordinates) at the point of collision where the object was hit by this ray.
list [x, y, z]
getRayDirection()
Returns the normalized direction (in worldcoordinates) of the ray cast by the mouse.
list [x, y, z]
getRaySource()
Returns the position (in worldcoordinates) the ray was cast from by the mouse.
list [x, y, z]
getRayTarget()
Returns the target of the ray (in worldcoordinates) that seeks the focus object.
integer
getButtonStatus(button)
Get the mouse button status. (Inherited from SCA_MouseSensor.SCA_MouseSensor)
integer
getExecutePriority()
Gets the execution priority of this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
integer
getFrequency()
The frequency for pulse mode sensors. (Inherited from SCA_ISensor.SCA_ISensor)
 
getInvert()
True if this sensor activates on negative events. (Inherited from SCA_ISensor.SCA_ISensor)
boolean
getLevel()
Returns whether this sensor is a level detector or a edge detector. (Inherited from SCA_ISensor.SCA_ISensor)
KX_GameObject
getOwner()
Gets the game object associated with this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
 
getUseNegPulseMode()
True if the sensor is in negative pulse mode. (Inherited from SCA_ISensor.SCA_ISensor)
 
getUsePosPulseMode()
True if the sensor is in positive pulse mode. (Inherited from SCA_ISensor.SCA_ISensor)
integer
getXPosition()
DEPRECATED: use the position property Gets the x coordinate of the mouse. (Inherited from SCA_MouseSensor.SCA_MouseSensor)
integer
getYPosition()
DEPRECATED: use the position property Gets the y coordinate of the mouse. (Inherited from SCA_MouseSensor.SCA_MouseSensor)
 
isPositive()
True if this sensor brick is in a positive state. (Inherited from SCA_ISensor.SCA_ISensor)
 
isTriggered()
True if this sensor brick has triggered the current controller. (Inherited from SCA_ISensor.SCA_ISensor)
 
reset()
Reset sensor internal state, effect depends on the type of sensor and settings. (Inherited from SCA_ISensor.SCA_ISensor)
 
setExecutePriority(priority)
Sets the priority of this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
 
setFrequency(freq)
Sets the frequency for pulse mode sensors. (Inherited from SCA_ISensor.SCA_ISensor)
 
setInvert(invert)
Sets if this sensor activates on positive or negative events. (Inherited from SCA_ISensor.SCA_ISensor)
 
setLevel(level)
Set whether to detect level or edge transition when entering a state. (Inherited from SCA_ISensor.SCA_ISensor)
 
setUseNegPulseMode(pulse)
Sets negative pulse mode. (Inherited from SCA_ISensor.SCA_ISensor)
 
setUsePosPulseMode(pulse)
Sets positive pulse mode. (Inherited from SCA_ISensor.SCA_ISensor)
Instance Variables
int executePriority
This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first). (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
int frequency
The frequency for pulse mode sensors. (Inherited from SCA_ISensor.SCA_ISensor)
list (normalized vector of 3 floats) hitNormal
the worldspace normal from the face at point of intersection.
KX_GameObject or None hitObject
the last object the mouse was over.
list (vector of 3 floats) hitPosition
The worldspace position of the ray intersecton.
boolean invert
Flag to set if this sensor activates on positive or negative events. (Inherited from SCA_ISensor.SCA_ISensor)
boolean level
Flag to set whether to detect level or edge transition when entering a state. (Inherited from SCA_ISensor.SCA_ISensor)
integer mode
sensor mode: 1=KX_MOUSESENSORMODE_LEFTBUTTON 2=KX_MOUSESENSORMODE_MIDDLEBUTTON 3=KX_MOUSESENSORMODE_RIGHTBUTTON 4=KX_MOUSESENSORMODE_WHEELUP 5=KX_MOUSESENSORMODE_WHEELDOWN 9=KX_MOUSESENSORMODE_MOVEMENT (Inherited from SCA_MouseSensor.SCA_MouseSensor)
KX_GameObject or None in exceptional cases. owner
The game object this logic brick is attached to (read only). (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
[integer,interger] position
current [x,y] coordinates of the mouse, in frame coordinates (pixels) (Inherited from SCA_MouseSensor.SCA_MouseSensor)
boolean positive
True if this sensor brick is in a positive state. (Inherited from SCA_ISensor.SCA_ISensor)
list (normalized vector of 3 floats) rayDirection
The rayTarget - raySource normalized.
list (vector of 3 floats) raySource
The worldspace source of the ray (the view position)
list (vector of 3 floats) rayTarget
The worldspace target of the ray.
boolean triggered
True if this sensor brick is in a positive state. (Inherited from SCA_ISensor.SCA_ISensor)
boolean useNegPulseMode
Flag to turn negative pulse mode on and off. (Inherited from SCA_ISensor.SCA_ISensor)
boolean usePosPulseMode
Flag to turn positive pulse mode on and off. (Inherited from SCA_ISensor.SCA_ISensor)
Method Details

getHitNormal()

 

Returns the normal (in worldcoordinates) at the point of collision where the object was hit by this ray. (deprecated)

Returns: list [x, y, z]
the ray collision normal.

getHitObject()

 

Returns the object that was hit by this ray or None. (deprecated)

Returns: KX_GameObject or None
the collision object.

getHitPosition()

 

Returns the position (in worldcoordinates) at the point of collision where the object was hit by this ray. (deprecated)

Returns: list [x, y, z]
the ray collision position.

getRayDirection()

 

Returns the normalized direction (in worldcoordinates) of the ray cast by the mouse. (deprecated)

Returns: list [x, y, z]
the ray direction.

getRaySource()

 

Returns the position (in worldcoordinates) the ray was cast from by the mouse. (deprecated)

Returns: list [x, y, z]
the ray source.

getRayTarget()

 

Returns the target of the ray (in worldcoordinates) that seeks the focus object. (deprecated)

Returns: list [x, y, z]
the ray target.