Automatically plots the molecule with a camera position and field of view that includes the full model. For more control over the scene, pass the scene to `rayrender::render_scene()` or `rayvertex::rasterize_scene()` and specify the camera position manually.
Arguments
- scene
Raymesh scene of molecule model.
- width
Default `800`. Image width in pixels.
- height
Default `800`. Image height in pixels.
- fov
Default `NULL`, automatically calculated. Camera field of view.
- lookat
Default `NULL`, automatically calculated as `c(0,0,0)`. Camera target point.
- lookfrom
Default `NULL`, automatically calculated from the scene bounds. Camera position.
- angle
Default `c(0,0,0)`. Degrees to rotate the model around the X, Y, and Z axes. If this is a single number, it is interpreted as `c(0, angle, 0)` and only rotates around the Y axis.
- order_rotation
Default `c(1,2,3)`. What order to apply the rotations specified in `angle`.
- lights
Default `top`. If `none`, removes all lights. If `bottom`, lights scene with light underneath model. If `both`, adds lights both above and below model. This can also be a matrix of light information generated with `rayvertex`.
- lightintensity
Default `80`. Light intensity for pathtraced scenes.
- pathtrace
Default `TRUE`. If `TRUE`, convert the raymesh scene to a `rayrender` raymesh and pathtrace it. Scene-generator rayrender materials are passed to `rayrender::raymesh_model()` with `override_material = TRUE` when available. If `FALSE`, rasterize the raymesh scene with `rayvertex`.
- plot
Default `TRUE`. If `TRUE`, plot the rendered image to the current graphics device. If `FALSE`, only return the rendered rayimage array.
- scene_elements
Default `NULL`. Additional backend scene elements to add after automatic camera calculation and model rotation. For `pathtrace = TRUE`, elements may be rayrender scenes or rayvertex raymesh scenes. For `pathtrace = FALSE`, elements must be rayvertex raymesh scenes.
- ...
Other arguments to pass to `rayrender::render_scene()` or `rayvertex::rasterize_scene()`. Arguments that only apply to the other backend are ignored. For pathtraced scenes, `background` sets both `backgroundlow` and `backgroundhigh` in `rayrender::render_scene()` and turns on `ambient_light`. For raster scenes, `background` is passed through to `rayvertex::rasterize_scene()`.
Value
Rendered image
Examples
compact_model = read_pdb(download_pdb("6k16", out_dir = tempdir()))
compact_scene = compact_model |>
generate_ribbon_scene(
material = rayrender::diffuse,
show_hetero_atoms = FALSE
)
# Start with render_model's default camera, top lighting, and calculated FOV.
compact_scene |>
render_model(pathtrace = TRUE, width = 800, height = 800, samples = 32)
# Use `plot = FALSE` when you want the image array without drawing it.
compact_image = compact_scene |>
render_model(
pathtrace = TRUE,
width = 800,
height = 800,
samples = 32,
plot = FALSE
)
# This render uses an explicit camera, scalar Y rotation, a solid
# background, weaker top light, and rayrender sampling options. The
# camera orientation was extracted interactively in rayrender by
# pressing the "P" key.
compact_scene |>
render_model(
pathtrace = TRUE,
width = 800,
height = 800,
fov = 72,
lookat = c(-1.93, 11.99, 8.47),
lookfrom = c(-25.50, 26.52, 14.99),
aperture = 2,
angle = 35,
background = "grey2",
lights = "top",
lightintensity = 50,
samples = 32,
sample_method = "sobol_blue",
clamp_value = 10
)
# Vector rotation and a custom rotation order show the same scene from a
# different orientation with lights above and below.
compact_scene |>
render_model(
pathtrace = TRUE,
angle = c(20, 90, 90),
lights = "both",
fov = 28,
samples = 32,
sample_method = "sobol_blue"
)
# Disable render_model's automatic lights and add your own.
tmp_exr = tempfile(fileext=".exr")
skymodelr::generate_sky(filename=tmp_exr, hosek = FALSE)
#> Error: The Prague sky model coefficient file 'SkyModelDatasetGround.dat' is not installed. Run download_sky_data(sea_level = TRUE, wide_spectrum = FALSE) explicitly to download it.
scene_elements = rayrender::generate_studio(
depth = -30,
distance = -35,
material = rayrender::diffuse(color="grey50")
)
compact_scene |>
render_model(
pathtrace = TRUE,
lights = "none",
background = "grey12",
samples = 32,
fov = 25,
sample_method = "sobol_blue",
rotate_env = 180,
scene_elements = scene_elements,
environment_light = tmp_exr,
iso=10
)
#> Warning: file '/tmp/Rtmp0RXH6o/file1e75384c92e1.exr' cannot be found, not using background image.
# Extra rayrender scene elements can be added after the automatic camera and
# model rotation are set, which is useful for fixed reference marks.
compact_scene |>
render_model(
pathtrace = TRUE,
angle = 35,
scene_elements = rayrender::sphere(
x = -10,
y = -10,
z = -10,
radius = 0.5,
material = rayrender::light(intensity = 15)
),
samples = 32,
sample_method = "sobol_blue"
)
# Raster scenes use rayvertex lighting. This example passes a directional
# light matrix through render_model to rasterize_scene().
raster_scene = compact_model |>
generate_ribbon_scene()
raster_scene |>
render_model(
pathtrace = FALSE,
background = "grey12",
lights = rayvertex::directional_light(c(0.2, 1, -1))
)
