GEOMETRY (geometry) functions


LIBRARY ROUTINE

lgcmaplegend - generate a color legend

LIBRARY CALL

int lgcmaplegend (kobject       input,
		  kgeom_object *output,
		  char *name,
		  int reverse,
		  int outline,
		  int horiz_vert,
		  float *length,
		  float *thickness,
		  float *xpos,
		  float *ypos,
		  int do_labels,
		  int num_labels,
		  char *sprintf_format,
		  int do_title,
		  char *title_string,
		  float *title_x_offset,
		  float *title_y_offset,
		  int title_font_size,
		  char *title_font_family)

INPUT

OUTPUT

RETURN VALUE

CHILL (1) on success, WHACKED (0) on failure

DESCRIPTION

This function is used to contruct geometry representing a color legend showing the colors contained in a vis colormap. The length and thickness of the legend can be controlled, along with its 2d position in space. The legend can be oriented either vertically or horizontally. An outline around the distinct colors in the legend may be optionally included. The colors in the legend can be reversed.

ADDITIONAL INFORMATION

none

EXAMPLES

none

SIDE EFFECTS

none

RESTRICTIONS

none

MODIFICATION

* Wed Mar 6 14:01:05 PST 1996 - this routine now generates a colormap legend using 2-space coordinates. it should be noted that downstream modules, unless they explicitly check for this attribute, will be given 3space coordinates with a z-value of 0.0.

FILES

$GEOMETRY/objects/library/geometry/src/lgcmaplegend.c

SEE ALSO

geometry(3)

COPYRIGHT

Copyright (C) 1996,1997 , The Regents of the University of California. All rights reserved.