GRASS GIS 8 Programmer's Manual  8.2.2dev(2023)-3d2c704037
gp.c File Reference

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

#include <stdlib.h>
#include <grass/gis.h>
#include <grass/ogsf.h>
Include dependency graph for gp.c:

Go to the source code of this file.

Macros

#define FIRST_SITE_ID   21720
 

Functions

geositegp_get_site (int id)
 Get geosite struct. More...
 
geositegp_get_prev_site (int id)
 Get previous geosite struct from list. More...
 
int gp_num_sites (void)
 Get number of loaded point sets. More...
 
geositegp_get_last_site (void)
 Get last point set. More...
 
geositegp_get_new_site (void)
 Create new geosite instance and add it to list. More...
 
void gp_update_drapesurfs (void)
 Update drape surfaces. More...
 
int gp_set_defaults (geosite *gp)
 Set default value for geosite struct. More...
 
int gp_init_site (geosite *gp)
 Initialize geosite struct. More...
 
void gp_delete_site (int id)
 Delete point set and remove from list. More...
 
int gp_free_site (geosite *fp)
 Free allocated geosite struct. More...
 
void gp_free_sitemem (geosite *fp)
 Free geosite (lower level) More...
 
void gp_set_drapesurfs (geosite *gp, int hsurfs[], int nsurfs)
 Set drape surfaces. More...
 

Detailed Description

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

(C) 1999-2008, 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
Bill Brown USACERL, GMSL/University of Illinois (January 1994)
Doxygenized by Martin Landa <landa.martin gmail.com> (May 2008)

Definition in file gp.c.

Macro Definition Documentation

◆ FIRST_SITE_ID

#define FIRST_SITE_ID   21720

Definition at line 20 of file gp.c.

Referenced by gp_get_new_site().

Function Documentation

◆ gp_delete_site()

void gp_delete_site ( int  id)

Delete point set and remove from list.

Parameters
idpoint set id

Definition at line 235 of file gp.c.

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

Referenced by GP_delete_site().

◆ gp_free_site()

int gp_free_site ( geosite fp)

Free allocated geosite struct.

Parameters
fppointer to geosite struct
Returns
1 on success
-1 on failure

Definition at line 258 of file gp.c.

References G_debug(), G_free(), gp_free_sitemem(), g_site::gsite_id, g_site::next, and NULL.

Referenced by gp_delete_site().

◆ gp_free_sitemem()

void gp_free_sitemem ( geosite fp)

Free geosite (lower level)

Parameters
fppointer to geosite struct

Definition at line 307 of file gp.c.

Referenced by gp_free_site().

◆ gp_get_last_site()

geosite* gp_get_last_site ( void  )

Get last point set.

Returns
pointer to geosite struct
NULL if no point set is available

Definition at line 93 of file gp.c.

References G_debug(), g_site::gsite_id, g_site::next, and NULL.

Referenced by gp_get_new_site().

◆ gp_get_new_site()

geosite* gp_get_new_site ( void  )

Create new geosite instance and add it to list.

Returns
pointer to geosite struct
NULL on error

Definition at line 116 of file gp.c.

References FIRST_SITE_ID, G_debug(), G_malloc, G_zero(), gp_get_last_site(), g_site::gsite_id, g_site::hstyle, g_site::next, NULL, and g_site::style.

◆ gp_get_prev_site()

geosite* gp_get_prev_site ( int  id)

Get previous geosite struct from list.

Parameters
idpoint set id
Returns
pointer to geosite struct
NULL on failure

Definition at line 55 of file gp.c.

References G_debug(), g_site::gsite_id, g_site::next, and NULL.

◆ gp_get_site()

geosite* gp_get_site ( int  id)

◆ gp_init_site()

int gp_init_site ( geosite gp)

Initialize geosite struct.

Todo:
Currently does nothing
Parameters
gppointer to geosite struct
Returns
-1 on failure
0 on success

Definition at line 219 of file gp.c.

References G_debug().

◆ gp_num_sites()

int gp_num_sites ( void  )

Get number of loaded point sets.

Returns
number of point sets

Definition at line 75 of file gp.c.

References G_debug(), and g_site::next.

Referenced by GP_num_sites().

◆ gp_set_defaults()

int gp_set_defaults ( geosite gp)

Set default value for geosite struct.

Parameters
gppointer to geosite struct
Returns
1 on success
-1 on failure

Definition at line 186 of file gp.c.

References g_vect_style::color, G_debug(), GS_get_longdim(), g_site::gsite_id, g_site::hstyle, NULL, g_vect_style::size, ST_X, g_site::style, g_vect_style::symbol, g_site::tstyle, and g_vect_style::width.

◆ gp_set_drapesurfs()

void gp_set_drapesurfs ( geosite gp,
int  hsurfs[],
int  nsurfs 
)

Set drape surfaces.

Parameters
gppointer to geosite struct
hsurflist of surfaces (id)
nsurfnumber of surfaces

Definition at line 352 of file gp.c.

References g_site::drape_surf_id, and MAX_SURFS.

◆ gp_update_drapesurfs()

void gp_update_drapesurfs ( void  )

Update drape surfaces.

Call after surface is deleted

Definition at line 154 of file gp.c.

References g_site::drape_surf_id, gs_get_surf(), g_site::n_surfs, g_site::next, and NULL.