vector/Vlib/color_write.c File Reference

Vector Library - write color table for vector map. More...

#include <string.h>
#include <grass/gis.h>
#include <grass/vector.h>
#include <grass/raster.h>
#include <grass/glocale.h>

Include dependency graph for vector/Vlib/color_write.c:

Go to the source code of this file.

Functions
void	Vect_write_colors (const char *name, const char *mapset, struct Colors *colors)
	Write color table for vector map. More...

Detailed Description

Vector Library - write color table for vector map.

(C) 2011 by the GRASS Development Team

This program is free software under the GNU General Public License (>=v2). Read the file COPYING that comes with GRASS for details.

Author

Martin Landa <landa.martin gmail.com>

Definition in file vector/Vlib/color_write.c.

Function Documentation

Vect_write_colors()

void Vect_write_colors	(	const char *	name,
		const char *	mapset,
		struct Colors *	colors
	)

Write color table for vector map.

The color table is written for the vector map name in the specified mapset from the colors structure.

The colors structure must be created properly, i.e., Rast_init_colors() to initialize the structure and Rast_add_c_color_rule() to set the category colors. These routines are called by higher level routines which read or create entire color tables, such as Rast_read_colors() or Rast_make_ramp_colors().

Note: The calling sequence for this function deserves special attention. The mapset parameter seems to imply that it is possible to overwrite the color table for a vector map which is in another mapset. However, this is not what actually happens. It is very useful for users to create their own color tables for vector maps in other mapsets, but without overwriting other users' color tables for the same raster map. If mapset is the current mapset, then the color file for name will be overwritten by the new color table. But if mapset is not the current mapset, then the color table is actually written in the current mapset under the colr2 element as: vector/name/colr2.

The rules are written out using floating-point format, removing trailing zeros (possibly producing integers). The flag marking the colors as floating-point is not written.

If the environment variable FORCE_GRASS3_COLORS is set (to anything at all) then the output format is 3.0, even if the structure contains 4.0 rules. This allows users to create 3.0 color files for export to sites which don't yet have 4.0

Parameters

name	vector map name
mapset	mapset name
colors	pointer to structure Colors which holds color info

Returns

void

Definition at line 61 of file vector/Vlib/color_write.c.