\HeaderA{grid.grab}{Grab the current grid output}{grid.grab}
\aliasA{grid.grabExpr}{grid.grab}{grid.grabExpr}
\keyword{dplot}{grid.grab}
\begin{Description}\relax
Creates a gTree object from the current grid display list
or from a scene generated by user-specified code.
\end{Description}
\begin{Usage}
\begin{verbatim}
grid.grab(warn = 2, wrap = FALSE, ...)
grid.grabExpr(expr, warn = 2, wrap = FALSE, ...)
\end{verbatim}
\end{Usage}
\begin{Arguments}
\begin{ldescription}
\item[\code{expr}] An expression to be evaluated.  Typically,
some calls to grid drawing functions. 
\item[\code{warn}] An integer specifying the amount of warnings
to emit.  0 means no warnings, 1 means warn when it is
certain that the grab will not faithfully represent the
original scene. 2 means warn if there's any possibility
that the grab will not faithfully represent the
original scene.

\item[\code{wrap}] A logical indicating how the output should
be captured. If \code{TRUE}, each non-grob element on the
display list is captured by wrapping it in a grob.  

\item[\code{...}] arguments passed to gTree, for example, a
name and/or class for the gTree that is created.
\end{ldescription}
\end{Arguments}
\begin{Details}\relax
There are four ways to capture grid output as a gTree.

There are two functions for capturing output:
use \code{grid.grab} to capture an existing drawing
and \code{grid.grabExpr} to capture the output from
an expression (without drawing anything).

For each of these functions, the output can be captured in
two ways.  One way tries to be clever and make a
gTree with a childrenvp slot containing all viewports on
the display list (including those
that are popped) and every
grob on the display list as a child of the new
gTree;  each child has a vpPath in the vp slot so that it is
drawn in the appropriate viewport.
In other words, the gTree contains all elements on the display
list, but in a slightly altered form.

The other way, \code{wrap=TRUE},
is to create a grob for every element on the
display list (and make all of those grobs children of the
gTree).

The first approach creates a more compact and elegant gTree,
which is more flexible to work with,
but is not guaranteed to faithfully replicate all possible
grid output.  The second approach is more brute force, and
harder to work with, but
should always faithfully replicate the original output.
\end{Details}
\begin{Value}
A gTree object.
\end{Value}
\begin{SeeAlso}\relax
\code{\LinkA{gTree}{gTree}}
\end{SeeAlso}
\begin{Examples}
\begin{ExampleCode}
pushViewport(viewport(w=.5, h=.5))
grid.rect()
grid.points(stats::runif(10), stats::runif(10))
popViewport()
grab <- grid.grab()
grid.newpage()
grid.draw(grab)
\end{ExampleCode}
\end{Examples}

