.. wxPython Phoenix documentation This file was generated by Phoenix's sphinx generator and associated tools, do not edit by hand. Copyright: (c) 2011-2018 by Total Control Software License: wxWindows License .. include:: headings.inc .. module:: wx.lib.floatcanvas .. currentmodule:: wx.lib.floatcanvas .. highlight:: python .. _wx.lib.floatcanvas: ========================================================================================================================================== |phoenix_title| **wx.lib.floatcanvas** ========================================================================================================================================== This is the floatcanvas package, the main classes are :class:`~lib.floatcanvas.FloatCanvas` and :class:`~lib.floatcanvas.NavCanvas`, in each class documentation there is at least one sample on how to use them and many more samples are provided in `wxPhoenix/samples` folder. FloatCanvas.py contains the main :class:`~lib.floatcanvas.FloatCanvas` class, and its supporting classes. NavCanvas.py contains the :class:`~lib.floatcanvas.NavCanvas` wrapper for the FloatCanvas that provides the canvas and a toolbar with tools that allow you to navigate the canvas (zooming, panning, etc.) Resources.py is a module that contains a few resources required by the FloatCanvas (icons, etc) The FloatCanvas is a high level window for drawing maps and anything else in an arbitrary coordinate system. The goal is to provide a convenient way to draw stuff on the screen without having to deal with handling OnPaint events, converting to pixel coordinates, knowing about wxWindows brushes, pens, and colors, etc. It also provides virtually unlimited zooming and scrolling I am using it for two things: 1) general purpose drawing in floating point coordinates 2) displaying map data in Lat-long coordinates If the projection is set to None, it will draw in general purpose floating point coordinates. If the projection is set to 'FlatEarth', it will draw a FlatEarth projection, centered on the part of the map that you are viewing. You can also pass in your own projection function. It is double buffered, so re-draws after the window is uncovered by something else are very quick. It relies on `NumPy <http://www.numpy.org/>`_, which is needed for speed (maybe, I haven't profiled properly) and convenience. Bugs and Limitations: Lots: patches, fixes welcome For Map drawing: It ignores the fact that the world is, in fact, a sphere, so it will do strange things if you are looking at stuff near the poles or the date line. so far I don't have a need to do that, so I havn't bothered to add any checks for that yet. Zooming: I have set no zoom limits. What this means is that if you zoom in really far, you can get integer overflows, and get weird results. It doesn't seem to actually cause any problems other than weird output, at least when I have run it. Speed: I have done a couple of things to improve speed in this app. The one thing I have done is used `NumPy <http://www.numpy.org/>`_ Arrays to store the coordinates of the points of the objects. This allowed me to use array oriented functions when doing transformations, and should provide some speed improvement for objects with a lot of points (big polygons, polylines, pointsets). The real slowdown comes when you have to draw a lot of objects, because you have to call the wx.DC.DrawSomething call each time. This is plenty fast for tens of objects, OK for hundreds of objects, but pretty darn slow for thousands of objects. If you are zoomed in, it checks the Bounding box of an object before drawing it. This makes it a great deal faster when there are a lot of objects and you are zoomed in so that only a few are shown. Mouse Events: There are a full set of custom mouse events. They are just like the regular mouse events, but include an extra attribute: Event.GetCoords(), that returns the (x,y) position in world coordinates, as a length-2 `NumPy <http://www.numpy.org/>`_ vector of Floats. There are also a full set of bindings to mouse events on objects, so that you can specify a given function be called when an object is clicked, mouse-over'd, etc. See the Demo for what it can do, and how to use it. Copyright: Christopher Barker License: Same as the version of wxPython you are using it with. TRAC site for some docs and updates: http://trac.paulmcnett.com/floatcanvas Mailing List: http://mail.paulmcnett.com/cgi-bin/mailman/listinfo/floatcanvas The latest code is in the main wx SVN: For classic: http://svn.wxwidgets.org/viewvc/wx/wxPython/3rdParty/FloatCanvas/ For Phoenix: http://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk/wx/lib/floatcanvas Check for updates or answers to questions, send me an email. Please let me know if you're using this!!! Contact me at: Chris.Barker@noaa.gov |package_summary| Packages Summary ================================== ================================================================================ ================================================================================ :mod:`~wx.lib.floatcanvas.Utilities` __init__ for the floatcanvas Utilities package ================================================================================ ================================================================================ | |module_summary| Modules Summary ================================ ================================================================================ ================================================================================ :mod:`~wx.lib.floatcanvas.FCEvents` This is where FloatCanvas defines its event types and binders. :mod:`~wx.lib.floatcanvas.FCObjects` This is where FloatCanvas defines its drawings objects. :mod:`~wx.lib.floatcanvas.FloatCanvas` This is the main module of the floatcanvas package, it contains the :class:`~lib.floatcanvas.FloatCanvas.FloatCanvas` :mod:`~wx.lib.floatcanvas.GUIMode` Module that holds the GUI modes used by FloatCanvas :mod:`~wx.lib.floatcanvas.NavCanvas` Combines :class:`~lib.floatcanvas.FloatCanvas.FloatCanvas` with Navigation :mod:`~wx.lib.floatcanvas.Resources` :mod:`~wx.lib.floatcanvas.ScreenShot` ================================================================================ ================================================================================ | .. toctree:: :maxdepth: 1 :hidden: wx.lib.floatcanvas.Utilities wx.lib.floatcanvas.FCEvents wx.lib.floatcanvas.FCObjects wx.lib.floatcanvas.FloatCanvas wx.lib.floatcanvas.GUIMode wx.lib.floatcanvas.NavCanvas wx.lib.floatcanvas.Resources wx.lib.floatcanvas.ScreenShot