OGSF library - loading and manipulating point sets (higher level functions) More...

#include <stdlib.h>
#include <string.h>
#include <grass/gis.h>
#include <grass/ogsf.h>
#include <grass/glocale.h>
#include "gsget.h"

Include dependency graph for gp2.c:

Go to the source code of this file.

Functions
int	GP_site_exists (int id)
	Check if point set exists. More...

int	GP_new_site (void)
	Create new point set. More...

int	GP_num_sites (void)
	Get number of loaded point sets. More...

int *	GP_get_site_list (int *numsites)
	Get list of point sets. More...

int	GP_delete_site (int id)
	Delete registrated point set. More...

int	GP_load_site (int id, const char *filename)
	Load point set from file. More...

int	GP_get_sitename (int id, char **filename)
	Get point set filename. More...

int	GP_get_style (int id, int color, int width, float size, int symbol)
	Get point set style. More...

int	GP_set_style (int id, int color, int width, float size, int symbol)
	Set point style. More...

int	GP_set_style_thematic (int id, int layer, const char color, const char width, const char size, const char symbol, struct Colors *color_rules)
	Set point set style for thematic mapping. More...

int	GP_unset_style_thematic (int id)
	Make style for thematic mapping inactive. More...

int	GP_set_zmode (int id, int use_z)
	Set z mode for point set. More...

int	GP_get_zmode (int id, int *use_z)
	Get z-mode. More...

void	GP_set_trans (int id, float xtrans, float ytrans, float ztrans)
	Set transformation params. More...

void	GP_get_trans (int id, float xtrans, float ytrans, float *ztrans)
	Get transformation params. More...

int	GP_select_surf (int hp, int hs)
	Select surface for given point set. More...

int	GP_unselect_surf (int hp, int hs)
	Unselect surface. More...

int	GP_surf_is_selected (int hp, int hs)
	Check if surface is selected. More...

void	GP_draw_site (int id)
	Draw point set. More...

void	GP_alldraw_site (void)
	Draw all available point sets. More...

int	GP_Set_ClientData (int id, void *clientd)
	Set client data. More...

void *	GP_Get_ClientData (int id)
	Get client data. More...

int	GP_str_to_marker (const char *str)
	Determine point marker symbol for string. More...

Detailed Description

OGSF library - loading and manipulating point sets (higher level functions)

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

Author: Bill Brown USACERL (January 1994); Updated by Martin landa <landa.martin gmail.com> (doxygenized in May 2008, thematic mapping in June 2011)

Definition in file gp2.c.

Function Documentation

◆ GP_alldraw_site()

void GP_alldraw_site ( void )

Draw all available point sets.

Definition at line 611 of file gp2.c.

◆ GP_delete_site()

int GP_delete_site ( int id )

Delete registrated point set.

Parameters

id	point set id

Returns: 1 on success; -1 on error (point sets not available)

Definition at line 132 of file gp2.c.

References G_debug(), gp_delete_site(), and GP_site_exists().

◆ GP_draw_site()

void GP_draw_site ( int id )

Draw point set.

Parameters

id	point set id

Definition at line 577 of file gp2.c.

References g_site::drape_surf_id, G_debug(), gp_get_site(), gpd_2dsite(), gpd_3dsite(), GS_get_region(), gs_get_surf(), g_site::has_z, g_site::n_surfs, and g_site::use_z.

Referenced by Nviz_draw_all_site().

◆ GP_Get_ClientData()

void* GP_Get_ClientData ( int id )

Get client data.

Parameters

id	point set id

Returns: pointer to client data; NULL on error

Definition at line 653 of file gp2.c.

References g_site::clientdata, gp_get_site(), and NULL.

◆ GP_get_site_list()

int* GP_get_site_list ( int * numsites )

Get list of point sets.

Must freed when no longer needed!

Parameters

numsites number of point sets

Returns: pointer to list of points sets; NULL on error

Definition at line 102 of file gp2.c.

Referenced by Nviz_draw_all_site().

◆ GP_get_sitename()

int GP_get_sitename	(	int	id,
		char **	filename
	)

Get point set filename.

Note: char array is allocated by G_store()

Parameters

	id	point set id
[out]	filename	point set filename

Returns: -1 on error (point set not found); 1 on success

Definition at line 209 of file gp2.c.

◆ GP_get_style()

int GP_get_style	(	int	id,
		int *	color,
		int *	width,
		float *	size,
		int *	symbol
	)

Get point set style.

Parameters

id	point set id

Returns: 1 on success; -1 on error (point set not found)

Definition at line 232 of file gp2.c.

◆ GP_get_trans()

void GP_get_trans	(	int	id,
		float *	xtrans,
		float *	ytrans,
		float *	ztrans
	)

Get transformation params.

Parameters

	id	point set id
[out]	xtrans,ytrans,ztrans	x/y/z values

Definition at line 457 of file gp2.c.

References G_debug(), gp_get_site(), g_site::x_trans, g_site::y_trans, and g_site::z_trans.

◆ GP_get_zmode()

int GP_get_zmode	(	int	id,
		int *	use_z
	)

Get z-mode.

Todo:: Who's using this?

Parameters

	id	point set id
[out]	use_z	non-zero code to use z

Returns: -1 on error (invalid point set id); 1 on success

Definition at line 414 of file gp2.c.

References G_debug(), gp_get_site(), NULL, and g_site::use_z.

◆ GP_load_site()

int GP_load_site	(	int	id,
		const char *	filename
	)

Load point set from file.

Check to see if handle already loaded, if so - free before loading new for now, always load to memory.

Todo:: load file handle & ready for reading instead of using memory

Parameters

id	point set id
filename	point set filename

Returns: -1 on error; 1 on success

Definition at line 173 of file gp2.c.

◆ GP_new_site()

int GP_new_site ( void )

Create new point set.

Returns: point set id; -1 on error (number of point sets exceeded)

Definition at line 64 of file gp2.c.

◆ GP_num_sites()

int GP_num_sites ( void )

Get number of loaded point sets.

Returns: number of point sets

Definition at line 87 of file gp2.c.

References gp_num_sites().

◆ GP_select_surf()

int GP_select_surf	(	int	hp,
		int	hs
	)

Select surface for given point set.

Parameters

hp	point set id
hs	surface id

Returns: 1 surface selected; -1 on error

Definition at line 484 of file gp2.c.

References g_site::drape_surf_id, G_debug(), gp_get_site(), GP_surf_is_selected(), GS_surf_exists(), and g_site::n_surfs.

◆ GP_Set_ClientData()

int GP_Set_ClientData	(	int	id,
		void *	clientd
	)

Set client data.

Parameters

id	point set id
clientd	client data

Returns: 1 on success; -1 on error (invalid point set id)

Definition at line 631 of file gp2.c.

References g_site::clientdata, and gp_get_site().

◆ GP_set_style()

int GP_set_style	(	int	id,
		int	color,
		int	width,
		float	size,
		int	symbol
	)

Set point style.

Supported icon symbols (markers):

ST_X
ST_BOX
ST_SPHERE
ST_CUBE
ST_DIAMOND
ST_DEC_TREE
ST_CON_TREE
ST_ASTER
ST_GYRO
ST_HISTOGRAM

Parameters

id	point set id
color	icon color
width	icon line width
size	icon size
symbol	icon symbol

Returns: 1 on success; -1 on error (point set not found)

Definition at line 274 of file gp2.c.

◆ GP_set_style_thematic()

int GP_set_style_thematic	(	int	id,
		int	layer,
		const char *	color,
		const char *	width,
		const char *	size,
		const char *	symbol,
		struct Colors *	color_rules
	)

Set point set style for thematic mapping.

Updates also style for each geopoint.

Parameters

id	point set id
layer	layer number for thematic mapping (-1 for undefined)
color	icon color column name
width	icon line width column name
size	icon size column name
symbol	icon symbol column name
colors	pointer to Colors structure or NULL

Returns: 1 on success; -1 on error (point set not found)

Definition at line 309 of file gp2.c.

◆ GP_set_trans()

void GP_set_trans	(	int	id,
		float	xtrans,
		float	ytrans,
		float	ztrans
	)

Set transformation params.

Parameters

id	point set id
xtrans,ytrans,ztrans	x/y/z values

Definition at line 434 of file gp2.c.

References G_debug(), gp_get_site(), g_site::x_trans, g_site::y_trans, and g_site::z_trans.

◆ GP_set_zmode()

int GP_set_zmode	(	int	id,
		int	use_z
	)

Set z mode for point set.

Parameters

id	point set id
use_z	TRUE to use z-coordinaces when vector map is 3D

Returns: 1 on success; 0 vector map is not 3D; -1 on error (invalid point set id)

Definition at line 380 of file gp2.c.

References G_debug(), gp_get_site(), g_site::has_z, NULL, and g_site::use_z.

◆ GP_site_exists()

int GP_site_exists ( int id )

Check if point set exists.

Parameters

id	point set id

Returns: 1 found; 0 not found

Definition at line 37 of file gp2.c.

References G_debug(), gp_get_site(), and NULL.

Referenced by GP_delete_site().

◆ GP_str_to_marker()

int GP_str_to_marker ( const char * str )

Determine point marker symbol for string.

Supported markers:

ST_X
ST_BOX
ST_SPHERE
ST_CUBE
ST_DIAMOND
ST_DEC_TREE
ST_CON_TREE
ST_ASTER
ST_GYRO
ST_HISTOGRAM

Parameters

str	string buffer

Returns: marker code (default: ST_SPHERE)

Definition at line 684 of file gp2.c.

References _, G_warning(), ST_ASTER, ST_BOX, ST_CON_TREE, ST_CUBE, ST_DEC_TREE, ST_DIAMOND, ST_GYRO, ST_HISTOGRAM, ST_SPHERE, and ST_X.

◆ GP_surf_is_selected()

int GP_surf_is_selected	(	int	hp,
		int	hs
	)

Check if surface is selected.

Parameters

hp	point set id
hs	surface id

Returns: 1 selected; 0 not selected

Definition at line 552 of file gp2.c.

References g_site::drape_surf_id, G_debug(), gp_get_site(), and g_site::n_surfs.

Referenced by GP_select_surf(), and GP_unselect_surf().

◆ GP_unselect_surf()

int GP_unselect_surf	(	int	hp,
		int	hs
	)

Unselect surface.

Parameters

hp	point set id
hs	surface id

Returns: 1 surface unselected; -1 on error

Definition at line 514 of file gp2.c.

References g_site::drape_surf_id, G_debug(), gp_get_site(), GP_surf_is_selected(), and g_site::n_surfs.

◆ GP_unset_style_thematic()

int GP_unset_style_thematic ( int id )

Make style for thematic mapping inactive.

Parameters

id	point set id

Returns: 1 on success; -1 on error (point set not found)

Definition at line 352 of file gp2.c.

References g_vect_style_thematic::active, G_debug(), gp_get_site(), NULL, and g_site::tstyle.

Functions

Detailed Description

Function Documentation

◆ GP_alldraw_site()

◆ GP_delete_site()

◆ GP_draw_site()

◆ GP_Get_ClientData()

◆ GP_get_site_list()

◆ GP_get_sitename()

◆ GP_get_style()

◆ GP_get_trans()

◆ GP_get_zmode()

◆ GP_load_site()

◆ GP_new_site()

◆ GP_num_sites()

◆ GP_select_surf()

◆ GP_Set_ClientData()

◆ GP_set_style()

◆ GP_set_style_thematic()

◆ GP_set_trans()

◆ GP_set_zmode()

◆ GP_site_exists()

◆ GP_str_to_marker()

◆ GP_surf_is_selected()

◆ GP_unselect_surf()

◆ GP_unset_style_thematic()