add docstrings to main boost python functions

This commit is contained in:
Dane Springmeyer 2009-03-30 04:32:23 +00:00
parent a87acb13d5
commit c9b4d71b1a

View file

@ -194,23 +194,23 @@ void render_to_file1(const mapnik::Map& map,
const std::string& filename,
const std::string& format)
{
mapnik::Image32 image(map.getWidth(),map.getHeight());
render(map,image,0,0);
mapnik::save_to_file(image,filename,format);
mapnik::Image32 image(map.getWidth(),map.getHeight());
render(map,image,0,0);
mapnik::save_to_file(image,filename,format);
}
void render_to_file2(const mapnik::Map& map,
const std::string& filename)
{
mapnik::Image32 image(map.getWidth(),map.getHeight());
render(map,image,0,0);
mapnik::save_to_file(image,filename);
mapnik::Image32 image(map.getWidth(),map.getHeight());
render(map,image,0,0);
mapnik::save_to_file(image,filename);
}
double scale_denominator(mapnik::Map const &map, bool geographic)
{
return mapnik::scale_denominator(map, geographic);
return mapnik::scale_denominator(map, geographic);
}
void translator(mapnik::config_error const & ex) {
@ -219,7 +219,7 @@ void translator(mapnik::config_error const & ex) {
unsigned mapnik_version()
{
return MAPNIK_VERSION;
return MAPNIK_VERSION;
}
BOOST_PYTHON_FUNCTION_OVERLOADS(load_map_overloads, load_map, 2, 3);
@ -267,23 +267,155 @@ BOOST_PYTHON_MODULE(_mapnik)
export_coord();
export_map();
def("render_to_file",&render_to_file1);
def("render_to_file",&render_to_file2);
def("render_tile_to_file",&render_tile_to_file);
def("render",&render);
def("render",&render2);
#if defined(HAVE_CAIRO) && defined(HAVE_PYCAIRO)
def("render",&render3);
def("render",&render4);
def("render",&render5);
def("render",&render6);
#endif
def("scale_denominator", &scale_denominator);
def("render_to_file",&render_to_file1,
"\n"
"Render Map to file using explicit image type\n"
"\n"
"Usage:\n"
">>> from mapnik import Map, render_to_file, load_map\n"
">>> m = Map(256,256)\n"
">>> load_map(m,'mapfile.xml')\n"
">>> render_to_file(m,'image8bit.png','png256')\n"
">>> render_to_file(m,'image32bit.png','png')\n"
"\n"
);
def("render_to_file",&render_to_file2,
"\n"
"Render Map to file (type taken from file extension)\n"
"\n"
"Usage:\n"
">>> from mapnik import Map, render_to_file, load_map\n"
">>> m = Map(256,256)\n"
">>> render_to_file(m,'image.jpeg')\n"
"\n"
);
def("render_tile_to_file",&render_tile_to_file,
"\n"
"TODO\n"
"\n"
);
def("render",&render,
"\n"
"Render Map to an AGG Image32 using offsets\n"
"\n"
"Usage:\n"
">>> from mapnik import Map, Image, render, load_map\n"
">>> m = Map(256,256)\n"
">>> load_map(m,'mapfile.xml')\n"
">>> im = Image(m.width,m.height)\n"
">>> render(m,im,1,1)\n"
"\n"
);
def("render",&render2,
"\n"
"Render Map to an AGG Image32\n"
"\n"
"Usage:\n"
">>> from mapnik import Map, Image, render, load_map\n"
">>> m = Map(256,256)\n"
">>> load_map(m,'mapfile.xml')\n"
">>> im = Image(m.width,m.height)\n"
">>> render(m,im)\n"
"\n"
);
#if defined(HAVE_CAIRO) && defined(HAVE_PYCAIRO)
def("render",&render3,
"\n"
"Render Map to Cairo Surface using offsets\n"
"\n"
"Usage:\n"
">>> from mapnik import Map, render, load_map\n"
">>> from cairo import SVGSurface\n"
">>> m = Map(256,256)\n"
">>> load_map(m,'mapfile.xml')\n"
">>> surface = SVGSurface('image.svg', m.width, m.height)\n"
">>> render(m,surface,1,1)\n"
"\n"
);
def("render",&render4,
"\n"
"Render Map to Cairo Surface\n"
"\n"
"Usage:\n"
">>> from mapnik import Map, render, load_map\n"
">>> from cairo import SVGSurface\n"
">>> m = Map(256,256)\n"
">>> load_map(m,'mapfile.xml')\n"
">>> surface = SVGSurface('image.svg', m.width, m.height)\n"
">>> render(m,surface)\n"
"\n"
);
def("render",&render5,
"\n"
"Render Map to Cairo Context using offsets\n"
"\n"
"Usage:\n"
">>> from mapnik import Map, render, load_map\n"
">>> from cairo import SVGSurface, Context\n"
">>> surface = SVGSurface('image.svg', m.width, m.height)\n"
">>> ctx = Context(surface)\n"
">>> load_map(m,'mapfile.xml')\n"
">>> render(m,context,1,1)\n"
"\n"
);
def("render",&render6,
"\n"
"Render Map to Cairo Context\n"
"\n"
"Usage:\n"
">>> from mapnik import Map, render, load_map\n"
">>> from cairo import SVGSurface, Context\n"
">>> surface = SVGSurface('image.svg', m.width, m.height)\n"
">>> ctx = Context(surface)\n"
">>> load_map(m,'mapfile.xml')\n"
">>> render(m,context)\n"
"\n"
);
#endif
def("scale_denominator", &scale_denominator,
"\n"
"Return the Map Scale Denominator.\n"
"Also available as Map.scale_denominator()\n"
"\n"
"Usage:\n"
"\n"
">>> from mapnik import Map, Projection, scale_denominator, load_map\n"
">>> m = Map(256,256)\n"
">>> load_map(m,'mapfile.xml')\n"
">>> scale_denominator(m,Projection(m.srs).geographic)\n"
"\n"
);
def("load_map", & load_map, load_map_overloads());
def("load_map_from_string", & load_map_string, load_map_string_overloads());
def("save_map", & save_map, "save Map object to XML");
def("mapnik_version", &mapnik_version);
def("save_map", & save_map,
"\n"
"Save Map object to XML file\n"
"\n"
"Usage:\n"
">>> from mapnik import Map, load_map, save_map\n"
">>> m = Map(256,256)\n"
">>> load_map(m,'mapfile_wgs84.xml')\n"
">>> m.srs\n"
"'+proj=latlong +datum=WGS84'\n"
">>> m.srs = '+init=espg:3395'\n"
">>> save_map(m,'mapfile_mercator.xml')\n"
"\n"
);
def("mapnik_version", &mapnik_version,"Get the Mapnik version number");
using mapnik::symbolizer;
class_<symbolizer>("Symbolizer",no_init)