NCL Home > Documentation > HLUs > API

NhlGetBB

The Fortran name of this function is NhlFGetBB.

This function returns the coordinates of the left, right, top, and bottom edges of a View class object's bounding box in NDC units.

C Synopsis

#include <ncarg/hlu/hlu.h>
#include <hfile for View class object>

NhlErrorTypes NhlGetBB(
		int		pid,
		NhlBoundingBox	*thebox
		)

Fortran Synopsis

      subroutine NhlFGetBB(pid, top, bottom, left, right, ierr)
      integer pid, ierr
      real top, bottom, left, right

C Arguments

pid (input)
Id of object whose bounding box is requested.
thebox (output)
Pointer to a struct of type NhlBoundingBox containing on output the NDC values of the top, bottom, left, and right edges of the bounding box of the View class object.

Fortran Arguments

pid (input)
Id of object whose bounding box is requested.
top (output)
On output contains the NDC value of the top edge of the bounding box of the View class object.
bottom (output)
On output contains the NDC value of the bottom edge of the bounding box of the View class object.
left (output)
On output contains the NDC value of the left edge of the bounding box of the View class object.
right (output)
On output contains the NDC value of the right edge of the bounding box of the View class object.
ierr (output)
Error code.

Types

Type name:		<none>
Definition:
typedef struct _NhlBoundingBox {
		int	set;
		float	t;
		float	b;
		float	l;
		float	r;
} NhlBoundingBox;

Type name:		NhlTErrorTypes
Definition:
typedef enum _NhlErrType{
	NhlFATAL	= -4,	/* "FATAL"	*/
	NhlWARNING	= -3,	/* "WARNING"	*/
	NhlINFO		= -2,	/* "INFO"	*/
	NhlNOERROR	= -1	/* "NOERROR"	*/
} NhlErrorTypes;