sij/mapnik
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doxygen docs for some functions and classes

Browse source
This commit is contained in:
Andreas Volz 2009-03-01 21:09:09 +00:00
parent 2ac636dc31
commit 194093d719
4 changed files with 166 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
include/mapnik/datasource.hpp
View file

@ -75,12 +75,24 @@ namespace mapnik {
datasource (parameters const& params)
: params_(params) {}
/*!
* @brief Get the configuration parameters of the data source.
*
* These vary depending on the type of data source.
*
* @return The configuration parameters of the data source.
*/
parameters const& params() const
{
return params_;
}
/*!
* @brief Get the type of the datasource
* @return The type of the datasource (Vector or Raster)
*/
virtual int type() const=0;
virtual featureset_ptr features(const query& q) const=0;
virtual featureset_ptr features_at_point(coord2d const& pt) const=0;
virtual Envelope<double> envelope() const=0;

4
include/mapnik/envelope.hpp
View file

@ -34,6 +34,10 @@
#include <iomanip>
namespace mapnik {
/*!
* A spatial envelope (i.e. bounding box) which also defines some basic operators.
*/
template <typename T> class MAPNIK_DECL Envelope
: boost::addable<Envelope<T>,
boost::subtractable<Envelope<T>,

123
include/mapnik/layer.hpp
View file

@ -33,6 +33,14 @@
namespace mapnik
{
/*!
* @brief A Mapnik map layer.
*
* Create a Layer with a named string and, optionally, an srs string either
* with a Proj.4 epsg code ('+init=epsg:<code>') or with a Proj.4 literal
* ('+proj=<literal>'). If no srs is specified it will default to
* '+proj=latlong +datum=WGS84'
*/
class MAPNIK_DECL Layer
{
public:
@ -40,31 +48,146 @@ namespace mapnik
Layer(Layer const& l);
Layer& operator=(Layer const& l);
bool operator==(Layer const& other) const;
/*!
* @brief Set the name of the layer.
*/
void set_name(std::string const& name);
/*!
* @return the name of the layer.
*/
const std::string& name() const;
/*!
* @brief Set the title of the layer.
*/
void set_title(std::string const& title);
/*!
* @return the title of the layer.
*/
const std::string& title() const;
/*!
* @brief Set the abstract of the Layer.
*/
void set_abstract(std::string const& abstract);
/*!
* @return the abstract of the Layer.
*/
const std::string& abstract() const;
/*!
* @brief Set the SRS of the layer.
*/
void set_srs(std::string const& srs);
/*!
* @return the SRS of the layer.
*/
std::string const& srs() const;
/*!
* @brief Add a new style to this layer.
*
* @param stylename The name of the style to add.
*/
void add_style(std::string const& stylename);
/*!
* @return the styles list attached to this layer.
*/
std::vector<std::string> const& styles() const;
/*!
* @return the styles list attached to this layer
* (const version).
*/
std::vector<std::string>& styles();
/*!
* @param maxZoom The minimum zoom level to set
*/
void setMinZoom(double minZoom);
/*!
* @param maxZoom The maximum zoom level to set
*/
void setMaxZoom(double maxZoom);
/*!
* @return the minimum zoom level of the layer.
*/
double getMinZoom() const;
/*!
* @return the maximum zoom level of the layer.
*/
double getMaxZoom() const;
/*!
* @brief Set whether this layer is active and will be rendered.
*/
void setActive(bool active);
/*!
* @return whether this layer is active and will be rendered.
*/
bool isActive() const;
/*!
* @brief Set whether this layer is queryable.
*/
void setQueryable(bool queryable);
/*!
* @return whether this layer is queryable or not.
*/
bool isQueryable() const;
/*!
* @brief Get the visability for a specific scale.
*
* @param scale Accepts an integer or float input.
*
* @return true if this layer's data is active and visible at a given scale.
* Otherwise returns False.
* @return false if:
* scale >= minzoom - 1e-6
* or
* scale < maxzoom + 1e-6
*/
bool isVisible(double scale) const;
/*!
* @param clear_cache Set whether this layer's labels are cached.
*/
void set_clear_label_cache(bool clear_cache);
/*!
* @return whether this layer's labels are cached.
*/
bool clear_label_cache() const;
/*!
* @brief Attach a datasource for this Layer.
*
* @param ds The datasource to attach.
*/
void set_datasource(datasource_ptr const& ds);
/*!
* @return the datasource attached to this layer.
*/
datasource_ptr datasource() const;
/*!
* @return the geographic envelope/bounding box of the data in the layer.
*/
Envelope<double> envelope() const;
~Layer();
private:
void swap(const Layer& other);

28
include/mapnik/map.hpp
View file

@ -303,15 +303,41 @@ namespace mapnik
*/
Envelope<double> get_buffered_extent() const;
/*!
* @return The Map Scale.
*/
double scale() const;
double scale_denominator() const;
CoordTransform view_transform() const;
/*!
* @brief Query a Map Layer (by layer index) for features
*
* Intersecting the given x,y location in the coordinates
* of map projection.
*
* @param index The index of the layer to query from.
* @param x The x coordinate where to query.
* @param y The y coordinate where to query.
* @return A Mapnik Featureset if successful otherwise will return NULL.
*/
featureset_ptr query_point(unsigned index, double x, double y) const;
/*!
* @brief Query a Map Layer (by layer index) for features
*
* Intersecting the given x,y location in the coordinates
* of the pixmap or map surface.
*
* @param index The index of the layer to query from.
* @param x The x coordinate where to query.
* @param y The y coordinate where to query.
* @return A Mapnik Featureset if successful otherwise will return NULL.
*/
featureset_ptr query_map_point(unsigned index, double x, double y) const;
~Map();
inline void setAspectFixMode(aspect_fix_mode afm) { aspectFixMode_ = afm; }