Module GameTypes :: Class KX_MouseFocusSensor

Class KX_MouseFocusSensor

PyObjectPlus --+                
               |                
          CValue --+            
                   |            
     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.

Instance Methods

[hide private]

Deprecated

list [x, y, z]

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

source code

KX_GameObject or None

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

source code

list [x, y, z]

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

source code

list [x, y, z]

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

source code

list [x, y, z]

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

source code

list [x, y, z]

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

source code

Inherited from SCA_MouseSensor

integer

getButtonStatus(button)
Get the mouse button status.

source code

integer

getXPosition()
Gets the x coordinate of the mouse.

source code

integer

getYPosition()
Gets the y coordinate of the mouse.

source code

Inherited from SCA_ISensor

reset()
Reset sensor internal state, effect depends on the type of sensor and settings.

source code

integer

getFrequency()
The frequency for pulse mode sensors.

source code

getInvert()
True if this sensor activates on negative events.

source code

boolean

getLevel()
Returns whether this sensor is a level detector or a edge detector.

source code

getUseNegPulseMode()
True if the sensor is in negative pulse mode.

source code

getUsePosPulseMode()
True if the sensor is in positive pulse mode.

source code

isPositive()
True if this sensor brick is in a positive state.

source code

isTriggered()
True if this sensor brick has triggered the current controller.

source code

setFrequency(freq)
Sets the frequency for pulse mode sensors.

source code

setInvert(invert)
Sets if this sensor activates on positive or negative events.

source code

setLevel(level)
Set whether to detect level or edge transition when entering a state.

source code

setUseNegPulseMode(pulse)
Sets negative pulse mode.

source code

setUsePosPulseMode(pulse)
Sets positive pulse mode.

source code

Inherited from SCA_ILogicBrick

integer

getExecutePriority()
Gets the execution priority of this logic brick.

source code

KX_GameObject

getOwner()
Gets the game object associated with this logic brick.

source code

setExecutePriority(priority)
Sets the priority of this logic brick.

source code

Inherited from CValue

string

getName()
Returns the name of the CValue.

source code

Inherited from PyObjectPlus

bool

isA(game_type)
Check if this is a type or a subtype game_type.

source code

Instance Variables

[hide private]

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.

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.

bool

usePulseFocus
When enabled, moving the mouse over a different object generates a pulse.

Inherited from SCA_MouseSensor

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

[integer,interger]

position
current [x,y] coordinates of the mouse, in frame coordinates (pixels)

Inherited from SCA_ISensor

int

frequency
The frequency for pulse mode sensors.

boolean

invert
Flag to set if this sensor activates on positive or negative events.

boolean

level
Option whether to detect level or edge transition when entering a state.

boolean

positive
True if this sensor brick is in a positive state.

boolean

tap
When enabled only sensors that are just activated will send a positive event, after this they will be detected as negative by the controllers.

boolean

triggered
True if this sensor brick is in a positive state.

boolean

useNegPulseMode
Flag to turn negative pulse mode on and off.

boolean

usePosPulseMode
Flag to turn positive pulse mode on and off.

Inherited from SCA_ILogicBrick

int

executePriority
This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first).

string

name
The name of this CValue derived object (read-only).

KX_GameObject or None in exceptional cases.

owner
The game object this logic brick is attached to (read-only).

Inherited from PyObjectPlus

bool

invalid
Test if the object has been freed by the game engine and is no longer valid.

Method Details

[hide private]

getHitNormal()

source code

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

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

Deprecated: use the hitNormal property

getHitObject()

source code

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

Returns: KX_GameObject or None: the collision object.

Deprecated: use the hitObject property

getHitPosition()

source code

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

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

Deprecated: use the hitPosition property

getRayDirection()

source code

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

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

Deprecated: use the rayDirection property

getRaySource()

source code

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

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

Deprecated: use the raySource property

getRayTarget()

source code

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

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

Deprecated: use the rayTarget property

Instance Variable Details

[hide private]

usePulseFocus

When enabled, moving the mouse over a different object generates a pulse. (only used when the 'Mouse Over Any' sensor option is set)

Type:: bool