Package horizons :: Package gui :: Package mousetools :: Module tearingtool :: Class TearingTool
[hide private]
[frames] | no frames]

Class TearingTool

source code

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

Represents a dangling tool to remove (tear) buildings.

Instance Methods [hide private]
 
__init__(self, session)
__init__(FIFE::IMouseListener self) -> IMouseListener
source code
 
remove(self) source code
 
mouseDragged(self, evt)
mouseDragged(IMouseListener self, MouseEvent evt)
source code
 
mouseMoved(self, evt)
mouseMoved(IMouseListener self, MouseEvent evt)
source code
 
on_escape(self) source code
 
mouseReleased(self, evt)
Tear selected instances and set selection tool as cursor
source code
 
confirm_ranged_delete(self, building) source code
 
mousePressed(self, evt)
mousePressed(IMouseListener self, MouseEvent evt)
source code
 
_mark(self, *edges)
Highights building instances and keeps self.selected up to date.
source code
 
_remove_object_transparency(self, coords)
helper function, used to remove transparency from object hovered upon, identified through its coordinates
source code
 
_make_surrounding_transparent(self, building)
Makes the surrounding of building_position transparent
source code
 
_restore_transparent_instances(self)
Removes transparency
source code
 
_on_object_deleted(self, message) 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 navigationtool.NavigationTool
 
_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
 
end(self) source code
 
get_hover_instances(self, where, layers=None)
Utility method, returns the instances under the cursor
source code
 
mouseWheelMovedDown(self, evt)
mouseWheelMovedDown(IMouseListener self, MouseEvent evt)
source code
 
mouseWheelMovedUp(self, evt)
mouseWheelMovedUp(IMouseListener self, MouseEvent evt)
source code
 
onCommand(self, command)
Called when some kind of command-event happens.
source code
    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
Class Variables [hide private]
  tear_selection_color = 255, 255, 255
  nearby_objects_radius = 4

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

    Inherited from navigationtool.NavigationTool
  HOVER_INSTANCES_UPDATE_DELAY = 1
  last_event_pos = fife.ScreenPoint(0, 0)
  last_hover_instances = WeakList()
  send_hover_instances_update = True
    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

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)

mouseReleased(self, evt)

source code 

Tear selected instances and set selection tool as cursor

Overrides: fife.fife.IMouseListener.mouseReleased

mousePressed(self, evt)

source code 

mousePressed(IMouseListener self, MouseEvent evt)

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