Class KX_MouseFocusSensor (2.48)


Methods
getHitNormal getRayDirection
getHitObject getRaySource
getHitPosition getRayTarget
 
Variables
---------- ----------
 
Constants
---------- ----------

Inherited Methods:  Class SCA_ISensor
getFrequency reset
getInvert setFrequency
getLevel setInvert
getUseNegPulseMode setLevel
getUsePosPulseMode setUseNegPulseMode
isPositive setUsePosPulseMode
isTriggered ----------

Inherited Methods:  Class SCA_MouseSensor 
getXPosition getYPosition

Inherited Methods:  Class SCA_ILogicBrick
getExecutePriority setExecutePriority
getOwner ----------

Inherited Methods:  Class PyObjectPlus
isA ----------

Inherited Methods:  Class Value
getName ----------



Methods



getHitNormal

getHitNormal()

Mouse Sensor Type:

Mouse over
or
Mouse over any

Returns the cosine of the angle ( x, y and z ) of the normal to the world coordinates.

Return type:  List float [ nx, ny, nz]

nx = cosine of normal to world x-axis
ny = cosine of normal to world y-axis
nz = cosine of normal to world z-axis

Note:
activate TRUE level triggering (pulse mode).

Sample Code

# get the controller
controller = GameLogic.getCurrentController()

# get the mouse over sensor connected to the controller named MouseOver
mouseOver = controller.getSensor("MouseOver")

# get the normal of object where it was hit
norm = mouseOver.getHitNormal()

getHitObject

getHitObject()

Mouse Sensor Type:

Mouse over
or
Mouse over any

Returns the game object that mouse passed over.

Return type:  KX_GameObject

Note:
'Mouse over any' -- activate TRUE level triggering (pulse mode).

Sample Code

# get the controller
controller = GameLogic.getCurrentController()

# get the mouse over sensor attached to the controller named MouseOver
mouseOver = controller.getSensor("MouseOver")

# get the game object hit by mouse over
gameObj = mouseOver.getHitObject()

getHitPosition

getHitPosition()

Mouse Sensor Type:

Mouse over
or
Mouse over any

Returns the position (in World Coordinates) where the object was hit.

Return type:  float List [ x, y, z]

x = x world coordinates
y = y world coordinates
z = z world coordinates

Note:
'Mouse over any' activate TRUE level triggering (pulse mode).

Sample Code

# get the controller
controller = GameLogic.getCurrentController()

# get the mouse over sensor attached to the controller named MouseOver
mouseOver = controller.getSensor("MouseOver")

# get position where the game object hit by Mouse Over
pos = mouseOver.getHitPosition()

getRayDirection

getRayDirection()

Mouse Sensor Type:

Mouse over
or
Mouse over any

Returns the cosines of the angle ( x, y and z ) of the direction that the ray is pointing (World coordinates).

Return type: float List [ dx, dy, dz]

dx = cosine of direction to world x-axis
dy = cosine of direction to world y-axis
dz = cosine of direction to world z-axis

Note:
'Mouse over any' activate TRUE level triggering (pulse mode).

Sample Code

# get the controller
controller = GameLogic.getCurrentController()

# get the mouse over sensor attached to the controller named MouseOver
mouseOver = controller.getSensor("MouseOver")

# get direction mouse over is pointing
dir = mouseOver.getRayDirection()

getRaySource

getRaySource()

Mouse Sensor Type:

Mouse over
or
Mouse over any

Returns the start point of the sensor ray.

Return type:  float list [ x, y, z]  World Coordinates.

x = x world coordinates
y = y world coordinates
z = z world coordinates

Note:
'Mouse over any' activate TRUE level triggering (pulse mode).

Sample Code

# get the controller
controller = GameLogic.getCurrentController()

# get sensor attached to controller named MouseOver
mouse = controller.getSensor("MouseOver")

# get the starting point of the sensor ray
source = mouse.getRaySource()

getRayTarget

getRayTarget()

Mouse Sensor Type:

Mouse over
or
Mouse over any

Returns the end point of the sensor ray.

Return type:  float list [ x, y, z]  World Coordinates.

x = x world coordinates
y = y world coordinates
z = z world coordinates

Note:
'Mouse over any' activate TRUE level triggering (pulse mode).

Sample Code

# get the controller
controller = GameLogic.getCurrentController()

# get sensor attached to the controller named MouseOver
mouse = controller.getSensor("MouseOver")

# get the ending point of the sensor ray
end = mouse.getRayTarget()

Blender 3D
Game Engine