Package horizons :: Package gui :: Package mousetools :: Module navigationtool :: Class NavigationTool
[hide private]
[frames] | no frames]

Class NavigationTool

source code

              object --+        
                       |        
fife.fife.IMouseListener --+    
                           |    
       cursortool.CursorTool --+
                               |
                              NavigationTool

Navigation Class to process mouse actions ingame

Instance Methods [hide private]
 
__init__(self, session)
__init__(FIFE::IMouseListener self) -> IMouseListener
source code
 
remove(self) source code
 
mousePressed(self, evt)
mousePressed(IMouseListener self, MouseEvent evt)
source code
 
mouseReleased(self, evt)
mouseReleased(IMouseListener self, MouseEvent evt)
source code
 
mouseDragged(self, evt)
mouseDragged(IMouseListener self, MouseEvent evt)
source code
 
mouseMoved(self, evt)
mouseMoved(IMouseListener self, MouseEvent evt)
source code
 
mouseWheelMovedUp(self, evt)
mouseWheelMovedUp(IMouseListener self, MouseEvent evt)
source code
 
mouseWheelMovedDown(self, evt)
mouseWheelMovedDown(IMouseListener self, MouseEvent evt)
source code
 
onCommand(self, command)
Called when some kind of command-event happens.
source code
 
get_hover_instances(self, where, layers=None)
Utility method, returns the instances under the cursor
source code
 
end(self) source code
 
_schedule_hover_instance_update(self)
Hover instances have potentially changed, do an update in a timely fashion (but not right away)
source code
 
_send_hover_instance_upate(self)
Broadcast update with new instances below mouse (hovered).
source code

Inherited from fife.fife.IMouseListener: __disown__, __repr__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

    Inherited from cursortool.CursorTool
 
_get_screenpoint(self, arg)
Python lacks polymorphism.
source code
 
_round_map_coords(self, map_x, map_y)
Returns the coordinates of an event at the map.
source code
 
disable(self)
Call this to not get events.
source code
 
enable(self)
Call this to get events.
source code
 
get_exact_world_location(self, evt)
Returns the coordinates of an event at the map.
source code
 
get_world_location(self, evt) source code
 
mouseClicked(self, evt)
mouseClicked(IMouseListener self, MouseEvent evt)
source code
 
mouseEntered(self, evt)
mouseEntered(IMouseListener self, MouseEvent evt)
source code
 
mouseExited(self, evt)
mouseExited(IMouseListener self, MouseEvent evt)
source code
 
mouseWheelMovedLeft(self, evt) source code
 
mouseWheelMovedRight(self, evt) source code
Class Variables [hide private]
  last_event_pos = fife.ScreenPoint(0, 0)
  send_hover_instances_update = True
  HOVER_INSTANCES_UPDATE_DELAY = 1
  last_hover_instances = WeakList()
  consumed_by_widgets = False

Inherited from fife.fife.IMouseListener: __del__, __swig_destroy__, thisown

    Inherited from cursortool.CursorTool
  log = logging.getLogger("gui.mousetools")
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, session)
(Constructor)

source code 

__init__(FIFE::IMouseListener self) -> IMouseListener

Overrides: object.__init__
(inherited documentation)

remove(self)

source code 
Overrides: cursortool.CursorTool.remove

mousePressed(self, evt)

source code 

mousePressed(IMouseListener self, MouseEvent evt)

Overrides: fife.fife.IMouseListener.mousePressed
(inherited documentation)

mouseReleased(self, evt)

source code 

mouseReleased(IMouseListener self, MouseEvent evt)

Overrides: fife.fife.IMouseListener.mouseReleased
(inherited documentation)

mouseDragged(self, evt)

source code 

mouseDragged(IMouseListener self, MouseEvent evt)

Overrides: fife.fife.IMouseListener.mouseDragged
(inherited documentation)

mouseMoved(self, evt)

source code 

mouseMoved(IMouseListener self, MouseEvent evt)

Overrides: fife.fife.IMouseListener.mouseMoved
(inherited documentation)

mouseWheelMovedUp(self, evt)

source code 

mouseWheelMovedUp(IMouseListener self, MouseEvent evt)

Overrides: fife.fife.IMouseListener.mouseWheelMovedUp
(inherited documentation)

mouseWheelMovedDown(self, evt)

source code 

mouseWheelMovedDown(IMouseListener self, MouseEvent evt)

Overrides: fife.fife.IMouseListener.mouseWheelMovedDown
(inherited documentation)

onCommand(self, command)

source code 

Called when some kind of command-event happens. For "documentation", see: engine/core/eventchannel/command/ec_commandids.h engine/core/eventchannel/eventmanager.cpp in fife. It's usually about mouse/keyboard focus or window being iconified/restored.

get_hover_instances(self, where, layers=None)

source code 

Utility method, returns the instances under the cursor

Parameters:
  • where - anything supporting getX/getY
  • layers - list of layer ids to search for. Default to OBJECTS

end(self)

source code 
Overrides: cursortool.CursorTool.end

_send_hover_instance_upate(self)

source code 

Broadcast update with new instances below mouse (hovered). At most called in a certain interval, not after every mouse move in order to prevent delays.