Commit 8360fc1f authored by Jiří Techet's avatar Jiří Techet

Updated documentation

Signed-off-by: 's avatarJiří Techet <techet@gmail.com>
parent 898f3af7
......@@ -16,6 +16,14 @@
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/**
* SECTION:champlain-error-tile-renderer
* @short_description: A renderer that renders error tiles independently of input data
*
* #ChamplainErrorTileRenderer always renders error tiles (tiles that indicate that the real tile could
* not be loaded) no matter what input data is used.
*/
#include "champlain-error-tile-renderer.h"
#include <gdk/gdk.h>
......@@ -119,6 +127,13 @@ champlain_error_tile_renderer_class_init (ChamplainErrorTileRendererClass *klass
object_class->finalize = champlain_error_tile_renderer_finalize;
object_class->dispose = champlain_error_tile_renderer_dispose;
/**
* ChamplainErrorTileRenderer:tile-size:
*
* The size of the rendered tile.
*
* Since: 0.8
*/
g_object_class_install_property (object_class,
PROP_TILE_SIZE,
g_param_spec_uint ("tile-size",
......@@ -145,6 +160,16 @@ champlain_error_tile_renderer_init (ChamplainErrorTileRenderer *self)
}
/**
* champlain_error_tile_renderer_new:
* @tile_size: the size of the rendered error tile
*
* Constructor of a #ChamplainErrorTileRenderer.
*
* Returns: a constructed #ChamplainErrorTileRenderer
*
* Since: 0.8
*/
ChamplainErrorTileRenderer *
champlain_error_tile_renderer_new (guint tile_size)
{
......@@ -155,6 +180,7 @@ champlain_error_tile_renderer_new (guint tile_size)
static void
set_data (ChamplainRenderer *renderer, const gchar *data, guint size)
{
/* always render the error tile no matter what data is set */
}
......@@ -228,6 +254,15 @@ render (ChamplainRenderer *renderer, ChamplainTile *tile)
}
/**
* champlain_error_tile_renderer_set_tile_size:
* @renderer: a #ChamplainErrorTileRenderer
* @size: the size of the rendered error tiles
*
* Sets the size of the rendered error tile.
*
* Since: 0.8
*/
void
champlain_error_tile_renderer_set_tile_size (ChamplainErrorTileRenderer *renderer,
guint size)
......@@ -240,6 +275,16 @@ champlain_error_tile_renderer_set_tile_size (ChamplainErrorTileRenderer *rendere
}
/**
* champlain_error_tile_renderer_get_tile_size:
* @renderer: a #ChamplainErrorTileRenderer
*
* Gets the size of the rendered error tiles.
*
* Returns: the size of the rendered error tiles
*
* Since: 0.8
*/
guint
champlain_error_tile_renderer_get_tile_size (ChamplainErrorTileRenderer *renderer)
{
......
......@@ -21,7 +21,7 @@
* SECTION:champlain-file-cache
* @short_description: Stores and loads cached tiles from the file system
*
* #ChamplainFileCache is a map source that stores and retrieves tiles from the
* #ChamplainFileCache is a cache that stores and retrieves tiles from the
* file system. Tiles most frequently loaded gain in "popularity". This popularity
* is taken into account when purging the cache.
*/
......@@ -374,12 +374,13 @@ champlain_file_cache_init (ChamplainFileCache *file_cache)
* @cache_dir: the directory where the cache is created. For temporary caches
* one more directory with random name is created inside this directory.
* When cache_dir == NULL, a cache in ~/.cache/champlain is used.
* @renderer: the #ChamplainRenderer used for tiles rendering
*
* Constructor of #ChamplainFileCache.
*
* Returns: a constructed #ChamplainFileCache
*
* Since: 0.6
* Since: 0.8
*/
ChamplainFileCache *
champlain_file_cache_new_full (guint size_limit,
......
......@@ -17,14 +17,13 @@
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/*
* SECTION:champlain-local-map-data-source
* @short_description: Loads local map data for #ChamplainMemphisTileSource
/**
* SECTION:champlain-file-tile-source
* @short_description: A map source that loads tile data from a file
*
* This map data source loads local <ulink role="online-location"
* This tile source loads local <ulink role="online-location"
* url="http://wiki.openstreetmap.org/wiki/.osm">
* OpenStreetMap XML data files</ulink> (*.osm).
*
*/
#include "champlain-file-tile-source.h"
......@@ -73,14 +72,23 @@ champlain_file_tile_source_init (ChamplainFileTileSource *self)
}
/*
* champlain_file_tile_source_new:
/**
* champlain_file_tile_source_new_full:
* @id: the map source's id
* @name: the map source's name
* @license: the map source's license
* @license_uri: the map source's license URI
* @min_zoom: the map source's minimum zoom level
* @max_zoom: the map source's maximum zoom level
* @tile_size: the map source's tile size (in pixels)
* @projection: the map source's projection
* @renderer: the #ChamplainRenderer used to render tiles
*
* Creates a new instance of #ChamplainFileTileSource.
* Constructor of #ChamplainFileTileSource.
*
* Returns: a new #ChamplainFileTileSource.
* Returns: a constructed #ChamplainFileTileSource object
*
* Since: 0.6
* Since: 0.8
*/
ChamplainFileTileSource *
champlain_file_tile_source_new_full (const gchar *id,
......@@ -110,14 +118,14 @@ champlain_file_tile_source_new_full (const gchar *id,
}
/*
/**
* champlain_file_tile_source_load_map_data:
* @map_data_source: a #ChamplainFileTileSource
* @self: a #ChamplainFileTileSource
* @map_path: a path to a map data file
*
* Loads the OpenStreetMap XML file at the given path.
*
* Since: 0.6
* Since: 0.8
*/
void
champlain_file_tile_source_load_map_data (ChamplainFileTileSource *self,
......
......@@ -49,15 +49,18 @@ G_BEGIN_DECLS
typedef struct _ChamplainFileTileSourcePrivate ChamplainFileTileSourcePrivate;
typedef struct
typedef struct _ChamplainFileTileSource ChamplainFileTileSource;
typedef struct _ChamplainFileTileSourceClass ChamplainFileTileSourceClass;
struct _ChamplainFileTileSource
{
ChamplainTileSource parent;
} ChamplainFileTileSource;
};
typedef struct
struct _ChamplainFileTileSourceClass
{
ChamplainTileSourceClass parent_class;
} ChamplainFileTileSourceClass;
};
GType champlain_file_tile_source_get_type (void);
......@@ -72,7 +75,7 @@ ChamplainFileTileSource *champlain_file_tile_source_new_full (const gchar *id,
ChamplainRenderer *renderer);
void champlain_file_tile_source_load_map_data (
ChamplainFileTileSource *map_data_source,
ChamplainFileTileSource *self,
const gchar *map_path);
G_END_DECLS
......
......@@ -16,6 +16,15 @@
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/**
* SECTION:champlain-image-renderer
* @short_description: A renderer that renders tiles from binary image data
*
* #ChamplainImageRenderer renders tiles from binary image data. The rendering
* is performed using #GdkPixbufLoader so the set of supported image
* formats is equal to the set of formats supported by #GdkPixbufLoader.
*/
#include "champlain-image-renderer.h"
#include <gdk/gdk.h>
......@@ -82,6 +91,15 @@ champlain_image_renderer_init (ChamplainImageRenderer *self)
}
/**
* champlain_image_renderer_new:
*
* Constructor of #ChamplainImageRenderer.
*
* Returns: a constructed #ChamplainImageRenderer object
*
* Since: 0.8
*/
ChamplainImageRenderer *
champlain_image_renderer_new (void)
{
......
......@@ -23,10 +23,10 @@
* This map source simplifies creation of map chains by providing two
* functions for their creation and modification in a stack-like manner:
* champlain_map_source_chain_push() and champlain_map_source_chain_pop().
* For instance, to create a chain consisting of #ChamplainFileCache,
* #ChamplainNetworkTileSource and #ChamplainErrorTileSource, the map
* For instance, to create a chain consisting of #ChamplainMemoryCache,
* #ChamplainFileCache and #ChamplainNetworkTileSource, the map
* sources have to be pushed into the chain in the reverse order starting
* from #ChamplainErrorTileSource. After its creation, #ChamplainMapSourceChain
* from #ChamplainNetworkTileSource. After its creation, #ChamplainMapSourceChain
* behaves as a chain of map sources it contains.
*/
......
......@@ -373,8 +373,8 @@ champlain_map_source_factory_create (ChamplainMapSourceFactory *factory,
* Creates a cached map source.
*
* Returns: a ready to use #ChamplainMapSourceChain consisting of
* #ChamplainFileCache, #ChamplainMapSource matching the given name, and
* #ChamplainErrorTileSource.
* #ChamplainMemoryCache, #ChamplainFileCache, #ChamplainMapSource matching the given name, and
* an error tile source created with champlain_map_source_factory_create_error_source ().
*
* Since: 0.6
*/
......@@ -411,6 +411,17 @@ champlain_map_source_factory_create_cached_source (ChamplainMapSourceFactory *fa
}
/**
* champlain_map_source_factory_create_error_source:
* @factory: the Factory
* @tile_size: the size of the error tile
*
* Creates a map source generating error tiles.
*
* Returns: a ready to use map source generating error tiles.
*
* Since: 0.8
*/
ChamplainMapSource *
champlain_map_source_factory_create_error_source (ChamplainMapSourceFactory *factory,
guint tile_size)
......
......@@ -50,9 +50,10 @@ G_BEGIN_DECLS
#define CHAMPLAIN_MAP_SOURCE_FACTORY_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS ((obj), CHAMPLAIN_TYPE_MAP_SOURCE_FACTORY, ChamplainMapSourceFactoryClass))
typedef struct _ChamplainMapSourceFactoryPrivate ChamplainMapSourceFactoryPrivate;
typedef struct _ChamplainMapSourceFactory ChamplainMapSourceFactory;
typedef struct _ChamplainMapSourceFactoryClass ChamplainMapSourceFactoryClass;
typedef struct _ChamplainMapSourceFactoryPrivate ChamplainMapSourceFactoryPrivate;
struct _ChamplainMapSourceFactory
{
......
......@@ -38,15 +38,16 @@
* To undertand the concept of chains, consider for instance a chain
* consisting of #ChamplainFileCache whose next source is
* #ChamplainNetworkTileSource whose next source is #ChamplainErrorTileSource.
* #ChamplainNetworkTileSource whose next source is an error tile source
* created with champlain_map_source_factory_create_error_source ().
* When champlain_map_source_fill_tile() is called on the first object of the
* chain, #ChamplainFileCache, the cache checks whether it contains the
* requested tile in its database. If it does, it returns the tile; otherwise,
* it calls champlain_map_source_fill_tile() on the next source in the chain
* (#ChamplainNetworkTileSource). The network tile source loads the tile
* from the network. When successful, it returns the tile; otherwise it requests
* the tile from the next source in the chain (#ChamplainErrorTileSource).
* #ChamplainErrorTileSource always generates an error tile, no matter what
* the tile from the next source in the chain (error tile source).
* The error tile source always generates an error tile, no matter what
* its next source is.
*/
......@@ -202,7 +203,7 @@ champlain_map_source_class_init (ChamplainMapSourceClass *klass)
/**
* ChamplainMapSource:renderer:
*
* Renderer used to render tiles.
* Renderer used for tiles rendering.
*
* Since: 0.8
*/
......@@ -250,7 +251,7 @@ champlain_map_source_get_next_source (ChamplainMapSource *map_source)
* champlain_map_source_get_renderer:
* @map_source: a #ChamplainMapSource
*
* Get the renderer used to render tiles.
* Get the renderer used for tiles rendering.
*
* Returns: the renderer.
*
......@@ -301,9 +302,9 @@ champlain_map_source_set_next_source (ChamplainMapSource *map_source,
/**
* champlain_map_source_set_renderer:
* @map_source: a #ChamplainMapSource
* @renderer: the renderer used for tile rendering
* @renderer: the renderer
*
* Sets the renderer used to render tiles.
* Sets the renderer used for tiles rendering.
*
* Since: 0.8
*/
......
......@@ -16,6 +16,16 @@
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/**
* SECTION:champlain-memory-cache
* @short_description: Stores and loads cached tiles from the memory
*
* #ChamplainMemoryCache is a cache that stores and retrieves tiles from the
* memory. The cache contents is not preserved between application restarts
* so this cache serves mostly as a quick access temporary cache to the
* most recently used tiles.
*/
#define DEBUG_FLAG CHAMPLAIN_DEBUG_CACHE
#include "champlain-debug.h"
......@@ -138,18 +148,16 @@ champlain_memory_cache_class_init (ChamplainMemoryCacheClass *klass)
object_class->get_property = champlain_memory_cache_get_property;
object_class->set_property = champlain_memory_cache_set_property;
/*
/**
* ChamplainMemoryCache:size-limit:
*
* The cache size limit in bytes.
* The maximal number of tiles that are stored in the cache.
*
* Note: this new value will not be applied until you call #champlain_cache_purge
*
* Since: 0.4
* Since: 0.8
*/
pspec = g_param_spec_uint ("size-limit",
"Size Limit",
"The cache's size limit (Mb)",
"Maximal number of stored tiles",
1,
G_MAXINT,
100,
......@@ -164,6 +172,17 @@ champlain_memory_cache_class_init (ChamplainMemoryCacheClass *klass)
}
/**
* champlain_memory_cache_new_full:
* @size_limit: maximal number of tiles stored in the cache
* @renderer: the #ChamplainRenderer used for tiles rendering
*
* Constructor of #ChamplainMemoryCache.
*
* Returns: a constructed #ChamplainMemoryCache
*
* Since: 0.8
*/
ChamplainMemoryCache *
champlain_memory_cache_new_full (guint size_limit,
ChamplainRenderer *renderer)
......@@ -191,6 +210,16 @@ champlain_memory_cache_init (ChamplainMemoryCache *memory_cache)
}
/**
* champlain_memory_cache_get_size_limit:
* @memory_cache: a #ChamplainMemoryCache
*
* Gets the maximal number of tiles stored in the cache.
*
* Returns: maximal number of stored tiles
*
* Since: 0.8
*/
guint
champlain_memory_cache_get_size_limit (ChamplainMemoryCache *memory_cache)
{
......@@ -200,6 +229,15 @@ champlain_memory_cache_get_size_limit (ChamplainMemoryCache *memory_cache)
}
/**
* champlain_memory_cache_set_size_limit:
* @memory_cache: a #ChamplainMemoryCache
* @size_limit: maximal number of tiles stored in the cache
*
* Sets the maximal number of tiles stored in the cache.
*
* Since: 0.8
*/
void
champlain_memory_cache_set_size_limit (ChamplainMemoryCache *memory_cache,
guint size_limit)
......@@ -397,6 +435,14 @@ refresh_tile_time (ChamplainTileCache *tile_cache,
}
/**
* champlain_memory_cache_clean:
* @memory_cache: a #ChamplainMemoryCache
*
* Cleans the contents of the cache.
*
* Since: 0.8
*/
void
champlain_memory_cache_clean (ChamplainMemoryCache *memory_cache)
{
......
......@@ -17,20 +17,16 @@
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/*
* SECTION:champlain-memphis-tile-source
* @short_description: A map source that draws tiles locally
/**
* SECTION:champlain-memphis-renderer
* @short_description: A renderer that renders tiles from OSM vector XML data
*
* The #ChamplainMemphisRenderer uses the rendering library
* <ulink role="online-location" url="https://trac.openstreetmap.ch/trac/memphis/">
* LibMemphis</ulink> to draw <ulink role="online-location" url="http://www.openstreetmap.org/">
* LibMemphis</ulink> to render tiles based on <ulink role="online-location" url="http://www.openstreetmap.org/">
* OpenStreetMap</ulink> data. Tiles are rendered in separate threads.
* It supports zoom levels 12 to 18.
*
* The map data is supplied by a #ChamplainMapDataSource.
* #ChamplainLocalMapDataSource loads data from a local OSM file.
* #ChamplainNetworkMapDataSource uses the OSM API to download data chunks.
*
* The output of the renderer can be configured with a Memphis rules XML file.
* (TODO: link to the specification) The default rules only show
* highways as thin black lines.
......@@ -229,12 +225,12 @@ champlain_memphis_renderer_class_init (ChamplainMemphisRendererClass *klass)
256,
G_PARAM_READWRITE));
/*
* ChamplainMapDataSource:bounding-box:
/**
* ChamplainMemphisRenderer:bounding-box:
*
* The bounding box of the area that contains map data.
*
* Since: 0.6
* Since: 0.8
*/
g_object_class_install_property (object_class,
PROP_BOUNDING_BOX,
......@@ -266,6 +262,16 @@ champlain_memphis_renderer_init (ChamplainMemphisRenderer *renderer)
}
/**
* champlain_memphis_renderer_new_full:
* @tile_size: the size of the rendered error tile
*
* Constructor of a #ChamplainMemphisRenderer.
*
* Returns: a constructed #ChamplainMemphisRenderer object
*
* Since: 0.8
*/
ChamplainMemphisRenderer *
champlain_memphis_renderer_new_full (guint tile_size)
{
......@@ -472,14 +478,14 @@ set_data (ChamplainRenderer *renderer,
}
/*
/**
* champlain_memphis_renderer_load_rules:
* @renderer: a #ChamplainMemphisRenderer
* @rules_path: a path to a rules file
*
* Loads a Memphis rules file.
*
* Since: 0.6
* Since: 0.8
*/
void
champlain_memphis_renderer_load_rules (
......@@ -520,7 +526,7 @@ champlain_memphis_renderer_load_rules (
}
/*
/**
* champlain_memphis_renderer_get_background_color:
* @renderer: a #ChamplainMemphisRenderer
*
......@@ -529,7 +535,7 @@ champlain_memphis_renderer_load_rules (
* Returns: the background color of the map as a newly-allocated
* #ClutterColor.
*
* Since: 0.6
* Since: 0.8
*/
ClutterColor *
champlain_memphis_renderer_get_background_color (
......@@ -552,14 +558,14 @@ champlain_memphis_renderer_get_background_color (
}
/*
/**
* champlain_memphis_renderer_set_background_color:
* @renderer: a #ChamplainMemphisRenderer
* @color: a #ClutterColor
*
* Sets the background color of the map from a #ClutterColor.
*
* Since: 0.6
* Since: 0.8
*/
void
champlain_memphis_renderer_set_background_color (
......@@ -575,15 +581,15 @@ champlain_memphis_renderer_set_background_color (
}
/*
/**
* champlain_memphis_renderer_set_rule:
* @renderer: a #ChamplainMemphisRenderer
* @rule: a #MemphisRule
* @rule: a #ChamplainMemphisRule
*
* Edits or adds a #ChamplainMemphisRule to the rules-set. New rules are appended
* to the list.
* to the list.
*
* Since: 0.6
* Since: 0.8
*/
void
champlain_memphis_renderer_set_rule (ChamplainMemphisRenderer *renderer,
......@@ -598,7 +604,7 @@ champlain_memphis_renderer_set_rule (ChamplainMemphisRenderer *renderer,
}
/*
/**
* champlain_memphis_renderer_get_rule:
* @renderer: a #ChamplainMemphisRenderer
* @id: an id string
......@@ -607,7 +613,7 @@ champlain_memphis_renderer_set_rule (ChamplainMemphisRenderer *renderer,
*
* Returns: the requested #ChamplainMemphisRule or NULL if none is found.
*
* Since: 0.6
* Since: 0.8
*/
ChamplainMemphisRule *
champlain_memphis_renderer_get_rule (ChamplainMemphisRenderer *renderer,
......@@ -626,7 +632,7 @@ champlain_memphis_renderer_get_rule (ChamplainMemphisRenderer *renderer,
}
/*
/**
* champlain_memphis_renderer_get_rule_ids:
* @renderer: a #ChamplainMemphisRenderer
*
......@@ -637,7 +643,7 @@ champlain_memphis_renderer_get_rule (ChamplainMemphisRenderer *renderer,
*
* Example: "waterway:river|stream|canal"
*
* Since: 0.6
* Since: 0.8
*/
GList *
champlain_memphis_renderer_get_rule_ids (ChamplainMemphisRenderer *renderer)
......@@ -654,14 +660,14 @@ champlain_memphis_renderer_get_rule_ids (ChamplainMemphisRenderer *renderer)
}
/*
/**
* champlain_memphis_renderer_remove_rule:
* @renderer: a #ChamplainMemphisRenderer
* @id: an id string
*
* Removes the rule with the given id.
*
* Since: 0.6
* Since: 0.8
*/
void
champlain_memphis_renderer_remove_rule (
......@@ -676,6 +682,15 @@ champlain_memphis_renderer_remove_rule (
}
/**
* champlain_memphis_renderer_set_tile_size:
* @renderer: a #ChamplainMemphisRenderer
* @size: the size of the rendered tiles
*
* Sets the size of the rendered tiles.
*
* Since: 0.8
*/
void
champlain_memphis_renderer_set_tile_size (ChamplainMemphisRenderer *renderer,
guint size)
......@@ -694,6 +709,16 @@ champlain_memphis_renderer_set_tile_size (ChamplainMemphisRenderer *renderer,
}
/**
* champlain_memphis_renderer_get_tile_size:
* @renderer: a #ChamplainMemphisRenderer
*
* Gets the size of the rendered tiles.
*
* Returns: the size of the rendered tiles
*
* Since: 0.8
*/
guint
champlain_memphis_renderer_get_tile_size (ChamplainMemphisRenderer *renderer)
{
......@@ -703,6 +728,16 @@ champlain_memphis_renderer_get_tile_size (ChamplainMemphisRenderer *renderer)
}
/**
* champlain_memphis_renderer_get_bounding_box:
* @renderer: a #ChamplainMemphisRenderer
*
* Gets the bounding box of the area for which map data is available.
*
* Returns: the bounding box
*
* Since: 0.8
*/
ChamplainBoundingBox *
champlain_memphis_renderer_get_bounding_box (ChamplainMemphisRenderer *renderer)
{
......
......@@ -50,22 +50,60 @@ G_BEGIN_DECLS
typedef struct _ChamplainMemphisRendererPrivate ChamplainMemphisRendererPrivate;
typedef struct
typedef struct _ChamplainMemphisRenderer ChamplainMemphisRenderer;
typedef struct _ChamplainMemphisRendererClass ChamplainMemphisRendererClass;
typedef struct _ChamplainMemphisRule ChamplainMemphisRule;
typedef struct _ChamplainMemphisRuleAttr ChamplainMemphisRuleAttr;
/**
* ChamplainMemphisRuleType:
* @CHAMPLAIN_MEMPHIS_RULE_TYPE_UNKNOWN: MEMPHIS_RULE_TYPE_UNKNOWN
* @CHAMPLAIN_MEMPHIS_RULE_TYPE_NODE: MEMPHIS_RULE_TYPE_NODE
* @CHAMPLAIN_MEMPHIS_RULE_TYPE_WAY: MEMPHIS_RULE_TYPE_WAY
* @CHAMPLAIN_MEMPHIS_RULE_TYPE_RELATION: MEMPHIS_RULE_TYPE_RELATION
*
* A wrapper of the MemphisRuleType union. For details see the libmemphis
* documentation.
*
* Since: 0.8
*/
typedef enum
{
CHAMPLAIN_MEMPHIS_RULE_TYPE_UNKNOWN,
CHAMPLAIN_MEMPHIS_RULE_TYPE_NODE,
CHAMPLAIN_MEMPHIS_RULE_TYPE_WAY,
CHAMPLAIN_MEMPHIS_RULE_TYPE_RELATION
} ChamplainMemphisRuleType;
struct _ChamplainMemphisRenderer
{
ChamplainRenderer parent;
ChamplainMemphisRendererPrivate *priv;
} ChamplainMemphisRenderer;
};
typedef struct
struct _ChamplainMemphisRendererClass
{
ChamplainRendererClass parent_class;
} ChamplainMemphisRendererClass;
typedef struct _ChamplainMemphisRule ChamplainMemphisRule;
typedef struct _ChamplainMemphisRuleAttr ChamplainMemphisRuleAttr;
};
/**
* ChamplainMemphisRuleAttr:
* @z_min: z_min
* @z_max: z_max
* @color_red: color_red
* @color_green: color_green
* @color_blue: color_blue
* @color_alpha: color_alpha
* @style: style
* @size: size
*
* A wrapper of the MemphisRuleAttr structure. For details see the libmemphis
* documentation.
*
* Since: 0.8
*/
struct _ChamplainMemphisRuleAttr
{
guint8 z_min;
......@@ -78,14 +116,21 @@ struct _ChamplainMemphisRuleAttr
gdouble size;
};
typedef enum
{
CHAMPLAIN_MEMPHIS_RULE_TYPE_UNKNOWN,
CHAMPLAIN_MEMPHIS_RULE_TYPE_NODE,
CHAMPLAIN_MEMPHIS_RULE_TYPE_WAY,
CHAMPLAIN_MEMPHIS_RULE_TYPE_RELATION
} ChamplainMemphisRuleType;
/**
* ChamplainMemphisRule:
* @keys: keys
* @values: values
* @type: type
* @polygon: polygon
* @line: line
* @border: border