~ubuntu-branches/ubuntu/intrepid/plplot/intrepid

« back to all changes in this revision

Viewing changes to doc/docbook/src/plshade1.3plplot

  • Committer: Bazaar Package Importer
  • Author(s): Rafael Laboissiere
  • Date: 2006-11-04 10:19:34 UTC
  • mfrom: (2.1.8 edgy)
  • Revision ID: james.westby@ubuntu.com-20061104101934-mlirvdg4gpwi6i5q
Tags: 5.6.1-10
* Orphaning the package
* debian/control: Changed the maintainer to the Debian QA Group

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
.\" This page was automatically generated.  Do not edit!
2
2
.\" 
3
 
.TH PLSHADE1 3plplot  "June, 2004" "" "PLplot API"
 
3
.TH PLSHADE1 3plplot  "May, 2006" "" "PLplot API"
4
4
.SH NAME
5
5
\fBplshade1\fP - Shade individual region on the basis of value 
6
6
.SH SYNOPSIS
65
65
\fIfill\fP (void (*) (PLINT, PLFLT *, PLFLT *), input) 
66
66
Routine used to fill the region.  Use \fBplfill\fP(3plplot).  Future version of plplot may have other fill routines. 
67
67
.TP
68
 
\fIrectangular\fP (PLINT, input) 
69
 
Set \fIrectangular\fP to 1 if rectangles map to rectangles after coordinate transformation with \fIpltrl\fP.  Otherwise, set \fIrectangular\fP to 0. If \fIrectangular\fP is set to 1, plshade tries to save time by filling large rectangles.  This optimization fails if the coordinate transformation distorts the shape of rectangles. For example a plot in polor coordinates has to have rectangular set to 0. 
 
68
\fIrectangular\fP (PLBOOL, input) 
 
69
Set \fIrectangular\fP to true if rectangles map to rectangles after coordinate transformation with \fIpltrl\fP.  Otherwise, set \fIrectangular\fP to false. If \fIrectangular\fP is set to true, plshade tries to save time by filling large rectangles.  This optimization fails if the coordinate transformation distorts the shape of rectangles. For example a plot in polor coordinates has to have \fIrectangular\fP set to false. 
70
70
.TP
71
71
\fIpltr\fP (void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer) , input) 
72
72
Pointer to function that defines transformation between indices in array \fIz\fP and the world coordinates (C only).  Transformation functions are provided in the PLplot library: \fBpltr0\fP(3plplot) for identity mapping, and \fBpltr1\fP(3plplot) and \fBpltr2\fP(3plplot) for arbitrary mappings respectively defined by one- and two-dimensional arrays.  In addition, user-supplied routines for the transformation can be used as well.  Examples of all of these approaches are given in the PLplot documentation. The transformation function should have the form given by any of \fBpltr0\fP(3plplot), \fBpltr1\fP(3plplot), or \fBpltr2\fP(3plplot).