gis/set_window.c

Go to the documentation of this file.

/*!
  \file lib/gis/set_window.c
  
  \brief GIS Library - Set window (map region)
  
  (C) 2001-2009, 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 Original author CERL
*/

#include <grass/gis.h>
#include <grass/glocale.h>

#include "G.h"

#include "gis_local_proto.h"

/*!
  \brief Get the current working window (region)

  The current working window values are returned in the structure
  \p window.

  Previous calls to G_set_window() affects values returned by this function.
  Previous calls to G_put_window() affects values returned by this function
  only if the current working window is not initialized.

  \param[out] window pointer to window structure to be set

  \sa G_set_window(), G_get_window()
*/
void G_get_set_window(struct Cell_head *window)
{
    G__init_window();
    *window = G__.window;
}

/*!
  \brief Establishes \p window as the current working window (region).

  This function adjusts the \p window before setting the region
  so you don't have to call G_adjust_Cell_head().

  \note Only the current process is affected.

  \param window window to become operative window

  \sa G_get_set_window(), G_put_window()
*/
void G_set_window(struct Cell_head *window)
{
    /* adjust window, check for valid window */
    G_adjust_Cell_head(window, 0, 0);
    
    /* copy the window to the current window */
    G__.window = *window;
    G__.window_set = 1;
}