Renders a movie using the av or gifski packages. Moves the camera around a 3D visualization
using either a standard orbit, or accepts vectors listing user-defined values for each camera parameter. If the latter,
the values must be equal in length to frames (or of length 1, in which the value will be fixed).
render_movie(
filename,
type = "orbit",
frames = 360,
fps = 30,
phi = 30,
theta = 0,
zoom = NULL,
fov = NULL,
width = NULL,
height = NULL,
title_text = NULL,
title_offset = c(20, 20),
title_color = "black",
title_size = 30,
title_font = "sans",
title_bar_color = NA,
title_bar_alpha = 0.5,
image_overlay = NULL,
vignette = FALSE,
vignette_color = "black",
vignette_radius = 1.3,
title_just = "northwest",
audio = NULL,
progbar = interactive(),
...
)Filename. If not appended with .mp4, it will be appended automatically. If the file extension is gif,
the gifski package will be used to generate the animation.
Default orbit, which orbits the 3D object at the user-set camera settings phi, zoom, and fov.
Other options are oscillate (sine wave around theta value, covering 90 degrees), or custom (which uses the values from the
theta, phi, zoom, and fov vectors passed in by the user).
Default 360. Number of frames to render.
Default 30. Frames per second. Recommmend either 30 or 60 for web.
Defaults to current view. Azimuth values, in degrees.
Default to current view. Theta values, in degrees.
Defaults to the current view. Zoom value, between 0 and 1.
Defaults to the current view. Field of view values, in degrees.
Default NULL, uses the window size by default. Width of the movie. Note that the frames will still
be captured at the resolution (and aspect ratio) of the rgl window.
Default NULL, uses the window size by default. Height of the movie. Note that the frames will still
be captured at the resolution (and aspect ratio) of the rgl window.
Default NULL. Text. Adds a title to the movie, using magick::image_annotate.
Default c(20,20). Distance from the top-left (default, gravity direction in
image_annotate) corner to offset the title.
Default black. Font color.
Default 30. Font size in pixels.
Default sans. String with font family such as "sans", "mono", "serif", "Times", "Helvetica",
"Trebuchet", "Georgia", "Palatino" or "Comic Sans".
Default NA. If a color, this will create a colored bar under the title.
Default 0.5. Transparency of the title bar.
Default NULL. Either a string indicating the location of a png image to overlay
over the whole movie (transparency included), or a 4-layer RGBA array. This image will be resized to the
dimension of the movie if it does not match exactly.
Default FALSE. If TRUE or numeric, a camera vignetting effect will be added to the image.
1 is the darkest vignetting, while 0 is no vignetting. If vignette is a length-2 vector, the second entry will
control the blurriness of the vignette effect.
Default "black". Color of the vignette.
Default 1.3. Radius of the vignette, as a porportion of the image dimensions.
Default left. Justification of the title.
Default NULL. Optional file with audio to add to the video.
Default TRUE if interactive, FALSE otherwise. If FALSE, turns off progress bar.
Will display a progress bar when adding an overlay or title.
Additional parameters to pass to magick::image_annotate.
if(interactive()) {
filename_movie = tempfile()
#By default, the function produces a 12 second orbit at 30 frames per second, at 30 degrees azimuth.
# \donttest{
montereybay %>%
sphere_shade(texture="imhof1") %>%
plot_3d(montereybay, zscale=50, water = TRUE, watercolor="imhof1",
waterlinecolor="white", waterlinealpha=0.5)
#Un-comment the following to run:
#render_movie(filename = filename_movie)
# }
filename_movie = tempfile()
#You can change to an oscillating orbit. The magnification is increased and azimuth angle set to 30.
#A title has also been added using the title_text argument.
# \donttest{
#Un-comment the following to run:
#render_movie(filename = filename_movie, type = "oscillate",
# frames = 60, phi = 30, zoom = 0.8, theta = -90,
# title_text = "Monterey Bay: Oscillating")
# }
filename_movie = tempfile()
#Finally, you can pass your own set of values to the
#camera parameters as a vector with type = "custom".
phivechalf = 30 + 60 * 1/(1 + exp(seq(-7, 20, length.out = 180)/2))
phivecfull = c(phivechalf, rev(phivechalf))
thetavec = -90 + 45 * sin(seq(0,359,length.out = 360) * pi/180)
zoomvec = 0.45 + 0.2 * 1/(1 + exp(seq(-5, 20, length.out = 180)))
zoomvecfull = c(zoomvec, rev(zoomvec))
# \donttest{
#Un-comment the following to run
#render_movie(filename = filename_movie, type = "custom",
# frames = 360, phi = phivecfull, zoom = zoomvecfull, theta = thetavec)
# }
}