Package {rayrender}

Type:	Package
Title:	Build and Raytrace 3D Scenes
Version:	0.42.0
Date:	2026-09-15
Maintainer:	Tyler Morgan-Wall <tylermw@gmail.com>
Description:	Render scenes using pathtracing. Build 3D scenes out of spheres, cubes, planes, disks, triangles, cones, curves, line segments, cylinders, ellipsoids, and 3D models in the 'Wavefront' OBJ file format or the PLY Polygon File Format. Supports several material types, textures, multicore rendering, and tone-mapping. Based on the "Ray Tracing in One Weekend" book series. Peter Shirley (2018) https://raytracing.github.io.
License:	GPL-3
Copyright:	file inst/COPYRIGHTS
Depends:	R (≥ 4.3.0)
Imports:	Rcpp (≥ 1.0.0), parallel, png, raster, decido, rayimage (≥ 0.27.1), stats, progress, rayvertex (≥ 0.15.0), withr, vctrs, cli, pillar, skymodelr (≥ 0.6.3),
Suggests:	ambient, knitr, rmarkdown, sf, spData, dplyr, Rvcg, testthat (≥ 3.2.3), tibble, tree3d, rayshader (≥ 0.38.13), xml2, rgl
LinkingTo:	Rcpp, RcppThread (≥ 2.4.0), progress, spacefillr (≥ 0.3.0), testthat, libopenexr (≥ 3.4.12-6), libimath (≥ 3.2.2), skymodelr (≥ 0.6.3)
URL:	https://www.rayrender.net, https://github.com/tylermorganwall/rayrender, http://www.rayrender.net/
SystemRequirements:	C++20
Biarch:	true
Encoding:	UTF-8
Config/testthat/edition:	3
Config/build/compilation-database:	true
Config/roxygen2/version:	8.0.0
NeedsCompilation:	yes
Packaged:	2026-09-15 15:28:59 UTC; tyler
Author:	Tyler Morgan-Wall [aut, cph, cre], Syoyo Fujita [ctb, cph], Vilya Harvey [ctb, cph]
Repository:	CRAN
Date/Publication:	2026-09-16 02:30:02 UTC

Generate Rotation Matrix Axis

Description

Generate Rotation Matrix Axis

Usage

RotateAxis(theta, axis)

Arguments

Value

matrix

Generate Rotation Matrix X

Description

Generate Rotation Matrix X

Usage

RotateX(theta)

Arguments

Value

number

Generate Rotation Matrix Y

Description

Generate Rotation Matrix Y

Usage

RotateY(theta)

Arguments

Value

number

Generate Rotation Matrix Z

Description

Generate Rotation Matrix Z

Usage

RotateZ(theta)

Arguments

Value

number

Add Camera

Description

Adds a camera to a 'ray_scene'.

Usage

add_camera(scene, camera, name = NULL, active = TRUE, replace = FALSE)

Arguments

Value

A modified 'ray_scene'.

Examples

scene = generate_ground(material=diffuse(color="grey20")) |>
  add_object(sphere()) |>
  add_camera(camera(
    name = "main",
    lookfrom = c(0, 1, -10),
    lookat = c(0, 0, 0),
    fov = 35
  ))

render_scene(scene, samples = 16)

Add an Infinite Light

Description

Add an Infinite Light

Usage

add_infinite_light(scene, light, name = NULL, replace = FALSE)

Arguments

Value

A modified scene.

Add Object

Description

Add Object

Usage

add_object(scene, objects = NULL)

Arguments

Value

Tibble of object locations and properties.

Examples

#Generate the ground and add some objects
scene = generate_ground(depth=-0.5,material = diffuse(checkercolor="blue")) |>
  add_object(cube(x=0.7,
                  material=diffuse(noise=5,noisecolor="purple",color="black",noisephase=45),
                  angle=c(0,-30,0))) |>
  add_object(sphere(x=-0.7,radius=0.5,material=metal(color="gold")))
render_scene(scene,parallel=TRUE)

Add Points to Polygon

Description

Add Points to Polygon

Usage

add_points_polygon(polygon, added_points = 0L)

Arguments

Value

matrix

Animate Objects

Description

This function animates an object between two states. This animates objects separately from the transformations set in 'group_objects()' and in the object transformations themselves. This creates motion blur, controlled by the shutter open/close options in 'render_scene()'.

Usage

animate_objects(
  scene,
  start_time = 0,
  end_time = 1,
  start_pivot_point = c(0, 0, 0),
  start_position = c(0, 0, 0),
  start_angle = c(0, 0, 0),
  start_order_rotation = c(1, 2, 3),
  start_scale = c(1, 1, 1),
  start_axis_rotation = NA,
  end_pivot_point = c(0, 0, 0),
  end_position = c(0, 0, 0),
  end_angle = c(0, 0, 0),
  end_order_rotation = c(1, 2, 3),
  end_scale = c(1, 1, 1),
  end_axis_rotation = NA
)

Arguments

Value

Tibble of animated object.

Examples

#Render a pig
generate_studio() |>
  add_object(pig(y=-1.2,scale=0.5,angle=c(0,110,0)))|>
  add_object(sphere(y=5,x=5,z=-5,radius=2,material=light())) |>
  render_scene(samples=16,sample_method = "sobol_blue")
#Render a moving pig
generate_studio() |>
  add_object(
    animate_objects(
      pig(y=-1.2,scale=0.5,angle=c(0,110,0)),
      start_position = c(-0.1,0,0), end_position = c(0.1,0.2,0))
  ) |>
  add_object(sphere(y=5,x=5,z=-5,radius=2,material=light())) |>
  render_scene(samples=16,sample_method = "sobol_blue",clamp_value = 10)

#Render a shrinking pig
generate_studio() |>
  add_object(
    animate_objects(
      pig(y=-1.2,scale=0.5,angle=c(0,110,0)),
      start_scale = c(1,1,1), end_scale = c(0.5,0.5,0.5))
  ) |>
  add_object(sphere(y=5,x=5,z=-5,radius=2,material=light())) |>
  render_scene(samples=16,sample_method = "sobol_blue",clamp_value = 10)
#Render a spinning pig
generate_studio() |>
  add_object(
    animate_objects(
      pig(y=-1.2,scale=0.5,angle=c(0,110,0)),
      start_angle = c(0,-30,0), end_angle = c(0,30,0))
  ) |>
  add_object(sphere(y=5,x=5,z=-5,radius=2,material=light())) |>
  render_scene(samples=16,sample_method = "sobol_blue",clamp_value = 10)

#Shorten the open shutter time frame
generate_studio() |>
  add_object(
    animate_objects(
      pig(y=-1.2,scale=0.5,angle=c(0,110,0)),
      start_angle = c(0,-30,0), end_angle = c(0,30,0))
  ) |>
  add_object(sphere(y=5,x=5,z=-5,radius=2,material=light())) |>
  render_scene(samples=16,sample_method = "sobol_blue",clamp_value = 10,
               shutteropen=0.4, shutterclose = 0.6)
#Change the time frame when the shutter is open
generate_studio() |>
  add_object(
    animate_objects(
      pig(y=-1.2,scale=0.5,angle=c(0,110,0)),
      start_angle = c(0,-30,0), end_angle = c(0,30,0))
  ) |>
  add_object(sphere(y=5,x=5,z=-5,radius=2,material=light())) |>
  render_scene(samples=16,sample_method = "sobol_blue",clamp_value = 10,
               shutteropen=0, shutterclose = 0.1)
#Shorten the time span in which the movement occurs (which, in effect,
#increases the speed of the transition).
generate_studio() |>
  add_object(
    animate_objects(start_time = 0, end_time=0.1,
      pig(y=-1.2,scale=0.5,angle=c(0,110,0)),
      start_angle = c(0,-30,0), end_angle = c(0,30,0))
  ) |>
  add_object(sphere(y=5,x=5,z=-5,radius=2,material=light())) |>
  render_scene(samples=16,sample_method = "sobol_blue",clamp_value = 10,
               shutteropen=0, shutterclose = 0.1)

Default Animation Plot Behavior

Description

Default Animation Plot Behavior

Usage

animation_default_plot_scene(
  plot_scene,
  plot_scene_supplied,
  filename_supplied,
  preview
)

Arrow Object

Description

Composite object (cone + segment)

Usage

arrow(
  start = c(0, 0, 0),
  end = c(0, 1, 0),
  radius_top = 0.2,
  radius_tail = 0.1,
  tail_proportion = 0.5,
  direction = NA,
  from_center = TRUE,
  material = diffuse(),
  flipped = FALSE,
  scale = c(1, 1, 1)
)

Arguments

Value

Single row of a tibble describing the cone in the scene.

Examples

#Draw a simple arrow from x = -1 to x = 1
generate_studio() |>
  add_object(arrow(start = c(-1,0,0), end = c(1,0,0), material=glossy(color="red"))) |>
  add_object(sphere(y=5,material=light(intensity=20))) |>
  render_scene(clamp_value=10,  samples=16)
#Change the proportion of tail to top
generate_studio(depth=-2) |>
  add_object(arrow(start = c(-1,-1,0), end = c(1,-1,0), tail_proportion = 0.5,
                   material=glossy(color="red"))) |>
  add_object(arrow(start = c(-1,0,0), end = c(1,0,0), tail_proportion = 0.75,
                   material=glossy(color="red"))) |>
  add_object(arrow(start = c(-1,1,0), end = c(1,1,0), tail_proportion = 0.9,
                   material=glossy(color="red"))) |>
  add_object(sphere(y=5,z=-5,x=2,material=light(intensity=30))) |>
  render_scene(clamp_value=10, fov=25,  samples=16)
#Change the radius of the tail/top segments
generate_studio(depth=-1.5) |>
  add_object(arrow(start = c(-1,-1,0), end = c(1,-1,0), tail_proportion = 0.75,
                   radius_top = 0.1, radius_tail=0.03,
                   material=glossy(color="red"))) |>
  add_object(arrow(start = c(-1,0,0), end = c(1,0,0), tail_proportion = 0.75,
                   radius_top = 0.2, radius_tail=0.1,
                   material=glossy(color="red"))) |>
  add_object(arrow(start = c(-1,1,0), end = c(1,1,0), tail_proportion = 0.75,
                   radius_top = 0.3, radius_tail=0.2,
                   material=glossy(color="red"))) |>
  add_object(sphere(y=5,z=-5,x=2,material=light(intensity=30))) |>
  render_scene(clamp_value=10, samples=16)
#We can also specify arrows via a midpoint and direction:
generate_studio(depth=-1) |>
  add_object(arrow(start = c(-1,-0.5,0), direction = c(0,0,1),
                   material=glossy(color="green"))) |>
  add_object(arrow(start = c(1,-0.5,0), direction = c(0,0,-1),
                   material=glossy(color="red"))) |>
  add_object(arrow(start = c(0,-0.5,1), direction = c(1,0,0),
                   material=glossy(color="yellow"))) |>
  add_object(arrow(start = c(0,-0.5,-1), direction = c(-1,0,0),
                   material=glossy(color="purple"))) |>
  add_object(sphere(y=5,z=-5,x=2,material=light(intensity=30))) |>
  render_scene(clamp_value=10, samples=16,
               lookfrom=c(0,5,10), lookat=c(0,-0.5,0), fov=16)
#Plot a 3D vector field for a gravitational well:

r = 1.5
theta_vals = seq(0,2*pi,length.out = 16)[-16]
phi_vals = seq(0,pi,length.out = 16)[-16][-1]
arrow_list = list()
counter = 1
for(theta in theta_vals) {
  for(phi in phi_vals) {
    rval = c(r*sin(phi)*cos(theta),r*cos(phi),r*sin(phi)*sin(theta))
    arrow_list[[counter]] = arrow(rval, direction = -1/2*rval/sqrt(sum(rval*rval))^3,
                                  tail_proportion = 0.66, radius_top=0.03, radius_tail=0.01,
                                  material = diffuse(color="red"))
    counter = counter + 1
  }
}
vector_field = do.call(rbind,arrow_list)
sphere(material=diffuse(noise=1,color="blue",noisecolor="darkgreen")) |>
  add_object(vector_field) |>
  add_object(sphere(y=0,x=10,z=-5,material=light(intensity=200))) |>
  render_scene(fov=20, ambient=TRUE, samples=16,
               backgroundlow="black",backgroundhigh="white")

Bezier Curve Object

Description

Bezier curve, defined by 4 control points.

Usage

bezier_curve(
  p1 = c(0, 0, 0),
  p2 = c(-1, 0.33, 0),
  p3 = c(1, 0.66, 0),
  p4 = c(0, 1, 0),
  x = 0,
  y = 0,
  z = 0,
  width = 0.1,
  width_end = NA,
  u_min = 0,
  u_max = 1,
  type = "cylinder",
  normal = c(0, 0, -1),
  normal_end = NA,
  material = diffuse(),
  angle = c(0, 0, 0),
  order_rotation = c(1, 2, 3),
  flipped = FALSE,
  scale = c(1, 1, 1)
)

Arguments

Value

Single row of a tibble describing the cube in the scene.

Examples

#Generate the default curve:
generate_studio(depth=-0.2) |>
  add_object(bezier_curve(material=diffuse(color="red"))) |>
  add_object(sphere(y=3,z=-5,x=2,radius=0.3,
                    material=light(intensity=200, spotlight_focus = c(0,0.5,0)))) |>
  render_scene(clamp_value = 10, lookat = c(0,0.5,0), fov=13,
               samples=16)

#Change the control points to change the direction of the curve. Here, we place spheres
#at the control point locations.
generate_studio(depth=-0.2) |>
  add_object(bezier_curve(material=diffuse(color="red"))) |>
  add_object(sphere(radius=0.075,material=glossy(color="green"))) |>
  add_object(sphere(radius=0.075,x=-1,y=0.33,material=glossy(color="green"))) |>
  add_object(sphere(radius=0.075,x=1,y=0.66,material=glossy(color="green"))) |>
  add_object(sphere(radius=0.075,y=1,material=glossy(color="green"))) |>
  add_object(sphere(y=3,z=-5,x=2,radius=0.3,
                    material=light(intensity=200, spotlight_focus = c(0,0.5,0)))) |>
  render_scene(clamp_value = 10, lookat = c(0,0.5,0), fov=15,
               samples=16)
#We can make the curve flat (always facing the camera) by setting the type to `flat`
generate_studio(depth=-0.2) |>
  add_object(bezier_curve(type="flat", material=glossy(color="red"))) |>
  add_object(sphere(y=3,z=-5,x=2,radius=0.3,
                    material=light(intensity=200, spotlight_focus = c(0,0.5,0)))) |>
  render_scene(clamp_value = 10, lookat = c(0,0.5,0), fov=13,
               samples=16)
#We can also plot a ribbon, which is further specified by a start and end orientation with
#two surface normals.
generate_studio(depth=-0.2) |>
  add_object(bezier_curve(type="ribbon", width=0.2,
                   p1 = c(0,0,0), p2 = c(0,0.33,0), p3 = c(0,0.66,0), p4 = c(0.3,1,0),
                   normal_end = c(0,0,1),
                   material=glossy(color="red"))) |>
  add_object(sphere(y=3,z=-5,x=2,radius=0.3,
                    material=light(intensity=200, spotlight_focus = c(0,0.5,0)))) |>
  render_scene(clamp_value = 10, lookat = c(0,0.5,0), fov=13,
               samples=16)
#Create a single curve and copy and rotate it around the y-axis to create a wavy fountain effect:
scene_curves = list()
for(i in 1:90) {
  scene_curves[[i]] = bezier_curve(p1 = c(0,0,0),p2 = c(0,5-sinpi(i*16/180),2),
                            p3 = c(0,5-0.5 * sinpi(i*16/180),4),p4 = c(0,0,6),
                            angle=c(0,i*4,0), type="cylinder",
                            width = 0.1, width_end =0.1,material=glossy(color="red"))
}
all_curves = do.call(rbind, scene_curves)
generate_ground(depth=0,material=diffuse(checkercolor="grey20")) |>
  add_object(all_curves) |>
  add_object(sphere(y=7,z=0,x=0,material=light(intensity=100))) |>
  render_scene(lookfrom = c(12,20,50),samples=100,
               lookat=c(0,1,0), fov=15, clamp_value = 10)

Calculate Control Points

Description

Calculate Control Points

Usage

calculate_control_points(s_mat)

Calculate Control Points (straight)

Description

Calculate Control Points (straight)

Usage

calculate_control_points_straight(s_mat)

Get Distance Along Bezier Curve

Description

Get Distance Along Bezier Curve

Usage

calculate_distance_along_bezier_curve(cps, breaks = 20)

Arguments

Value

Data frame of points along curve, along with distances

Linearize and Calculate Final Points (with constant stepsize)

Description

Linearize and Calculate Final Points (with constant stepsize)

Usage

calculate_final_path(
  linearized_cp,
  steps,
  constant_step = TRUE,
  curvature_adjust = FALSE,
  curvature_scale = 1,
  offset = 0,
  progress = FALSE,
  string = ""
)

Arguments

Value

Matrix of points along curve

Calculate Final Angle

Description

Calculate Final Angle

Usage

calculate_final_twist(full_control_points, breaks, t_vals, t_vec, s_vec, r_vec)

Calculate Path Interval

Description

Calculate Path Interval

Usage

calculate_path_interval(linearized_cp, current_dist)

Arguments

Value

List containing the row and interpolation value.

Camera

Description

Creates a rayrender camera that can be attached to a 'ray_scene' with 'add_camera()'.

Usage

camera(
  lookfrom = c(0, 1, -10),
  lookat = c(0, 0, 0),
  camera_up = c(0, 1, 0),
  fov = 20,
  aperture = 0.1,
  focal_distance = NULL,
  ortho_dimensions = c(1, 1),
  motion = NULL,
  keyframe_motion_args = list(),
  name = "camera",
  filename = NA_character_,
  camera_description_file = NA,
  camera_scale = 1,
  iso = 100,
  film_size = 22,
  shutteropen = 0,
  shutterclose = 1,
  camera_motion_blur = FALSE,
  shutter_speed = 2
)

Arguments

Value

A 'ray_camera' object.

Examples

# Static camera attached to the scene, equivalent to passing lookfrom/lookat
# directly to render_scene().
scene = generate_ground(depth = -0.5, material = diffuse(checkercolor = "blue")) |>
  add_object(sphere(y = 0.5, radius = 0.5, material = diffuse(color = "red"))) |>
  add_camera(camera(
    name = "main",
    lookfrom = c(7, 1.5, 10),
    lookat = c(0, 0.5, 0),
    fov = 15,
    filename = NA_character_
  ))
render_scene(scene, samples = 16, parallel = TRUE)

# Shutter speed is frame-relative: higher values sample a smaller fraction
# of camera/object motion without changing exposure.
fast_shutter_camera = camera(
  lookfrom = c(7, 1.5, 10),
  lookat = c(0, 0.5, 0),
  shutter_speed = 4
)

# Animated camera attached to the scene, equivalent to passing camera_motion
# directly to render_animation().
camera_pos = list(c(0, 1, 15), c(5, -5, 5), c(-5, 5, -5), c(0, 1, -15))
camera_motion = generate_camera_motion(
  positions = camera_pos,
  lookats = camera_pos,
  offset_lookat = 1,
  fovs = 80,
  frames = 12,
  type = "bezier"
)
animated_scene = generate_ground(material = diffuse(checkercolor = "grey20"), depth = -10) |>
  add_object(sphere(y = 50, radius = 10, material = light(intensity = 30))) |>
  add_object(path(camera_pos, y = -0.2, material = diffuse(color = "red"))) |>
  add_camera(camera(
    name = "flythrough_blur",
    motion = camera_motion,
    camera_motion_blur = TRUE,
    shutter_speed = 2
  )) |>
  add_camera(camera(
    name = "flythrough_no_blur",
    motion = camera_motion,
    camera_motion_blur = FALSE
  )) |>
  add_camera(camera(
    name = "flythrough_medium_blur",
    motion = camera_motion,
    camera_motion_blur = FALSE,
    shutter_speed = 4
  ))
#We can render these individual cameras by calling out their specific name in render_scene()
#With no blur
render_scene(
  animated_scene,
  camera = "flythrough_no_blur",
  mode = "animation",
  samples = 16,
  start_frame = 1,
  end_frame = 2,
  sample_method = "sobol_blue",
  clamp_value = 10,
  width = 400,
  height = 400
)
#Now, with blur
render_scene(
  animated_scene,
  camera = "flythrough_blur",
  mode = "animation",
  samples = 16,
  start_frame = 1,
  end_frame = 2,
  sample_method = "sobol_blue",
  clamp_value = 10,
  width = 400,
  height = 400
)
#Now, with less blur
#' #Now, with blur
render_scene(
  animated_scene,
  camera = "flythrough_medium_blur",
  mode = "animation",
  samples = 16,
  start_frame = 1,
  end_frame = 2,
  sample_method = "sobol_blue",
  clamp_value = 10,
  width = 400,
  height = 400
)

Check Image Texture

Description

Check Image Texture

Usage

check_image_texture(image_texture)

Clamp Values

Description

Clamp Values

Usage

clamp(v, min = 0, max = Inf)

Clamp negative environment RGB values

Description

Clamp negative environment RGB values

Usage

clamp_negative_environment_rgb(image)

Arguments

Value

Environment image with non-negative RGB channels.

Close Damped Camera Motion

Description

Close Damped Camera Motion

Usage

close_damped_camera_motion(motion_matrix)

Arguments

Value

Closed motion matrix.

Procedural Cloud Object

Description

Create a cloud volume with billowing Perlin-noise density. Add it to a scene with add_object(); rendering automatically selects integrator_type = "nee". Requires the suggested package ambient to generate the density field.

Usage

cloud(
  x = 0,
  y = 0,
  z = 0,
  width = 100,
  height = 25,
  depth = 75,
  style = c("cumulus", "stratus"),
  seed = 42,
  resolution = 128,
  coverage = 0.5,
  detail = 0.35,
  optical_depth = 8,
  g = 0.65,
  angle = c(0, 0, 0),
  order_rotation = c(1, 2, 3),
  scale = c(1, 1, 1),
  t = 0,
  animation_seed = 1,
  haze = FALSE,
  haze_density_threshold = 0.05
)

Arguments

Details

The local bounding box is centered at zero before object transforms, spanning -c(width, height, depth) / 2 to c(width, height, depth) / 2. The density fades to vacuum at all six faces; the box has no visible surface. An unrotated, unscaled cloud with base altitude b has y = b + height / 2. The center describes the box, not the irregular density's center of mass.

Positions and dimensions use scene units. Setting the dimensions rebuilds the field and normalizes extinction by height. Applying scale stretches the existing volume without renormalizing extinction, so stretching it along a ray increases that ray's optical depth. Standard group_objects(), animate_objects(), and create_instances() operations transform the cloud using the same object machinery as other closed shapes.

Evolution adds small, bounded perturbations to the broad and fine noise fields using separately seeded four-dimensional simplex noise (space and time). Subtracting the perturbation at time zero anchors the original shape. Broad domes, the base profile, and edge fades stay fixed while local density swells and erodes. Evolution is procedural rather than a fluid simulation; cloud mass is not conserved. Use x, y, and z for bulk movement.

Rebuild the cloud with a new t value for each rendered frame. animate_objects() animates its transform; it does not evolve the density within a frame or during the shutter interval.

Cloud scattering is separate from sky_light()'s clear-air atmospheric haze. Avoid intersecting, non-nested cloud boxes, including their empty edge cells: these are separate medium boundaries. Use one larger field for a connected bank. The attached grid_medium() is stored in object$shape_info[[1]]$medium for further density or scattering adjustments.

Value

A single-row ray_scene containing an invisible box with an attached cloud density grid.

See Also

sky_light(), grid_medium(), set_medium()

Examples

  # The default cloud is centered at the origin. Raise a cloud by its center
  # to put its base above the ground, then rotate the entire density field.
  puff = cloud(y = 20, width = 60, height = 20, depth = 40,
               angle = c(0, 25, 0), resolution = 64, optical_depth = 4)
  scene = generate_ground(material = diffuse("#699447")) |>
    add_object(puff) |>
    add_object(sphere(x = -50, y = 80, z = -30, radius = 15,
                      material = light(intensity = 40)))
  render_scene(scene, lookfrom = c(80, 35, -100), lookat = c(0, 20, 0),
               fov = 35, integrator_type = "nee", samples = 64,
               clamp_value = Inf, aperture = 0)

  # Reuse the shape at another position, or change the style and its detail.
  bank = cloud(x = 0, y = w0, z = 6, style = "stratus", seed = 17,
               width = 80, height = 10, depth = 50,
               coverage = 0.7, detail = 0.2, optical_depth = 6, g = 0.6)
  scaled = cloud(scale = c(1.5, 1, 0.75), angle = c(10, 30, 0),
                 order_rotation = c(2, 1, 3), resolution = 64)
generate_ground(material = diffuse("#699447")) |>
    add_object(bank) |>
    add_object(sphere(x = -50, y = 80, z = -30, radius = 15,
                      material = light(intensity = 40))) |>
 render_scene(lookfrom = c(80, 100, -100), lookat = c(0, 20, 0),
               fov = 35, integrator_type = "nee", samples = 64,
               clamp_value = Inf, aperture = 0)

generate_ground(material = diffuse("#699447")) |>
    add_object(scaled) |>
    add_object(sphere(x = -50, y = 80, z = -30, radius = 15,
                      material = light(intensity = 40))) |>
 render_scene(lookfrom = c(80, 100, -100), lookat = c(0, 20, 0),
               fov = 35, integrator_type = "nee", samples = 64,
               clamp_value = Inf, aperture = 0)
  # Keep seeds and position fixed to evolve the cloud locally over time.
  # Rebuilding a frame at the same t value always gives the same cloud.
  for (frame in 0:3) {
    set.seed(2026)
    generate_ground(material = diffuse("#699447")) |>
      add_object(cloud(y = 20, width = 60, height = 20, depth = 40,
      seed = 42, t = frame / 3, animation_seed = 17,
      resolution = 64, optical_depth = 4)) |>
      add_object(sphere(x = -50, y = 80, z = -30, radius = 15,
        material = light(intensity = 40))) |>
    render_scene(lookfrom = c(80, 35, -100), lookat = c(0, 20, 0),
      width = 256, height = 160, fov = 35, integrator_type = "nee",
      samples = 64, iso = 100, aperture = 0)
  }

Cone Object

Description

Cone Object

Usage

cone(
  start = c(0, 0, 0),
  end = c(0, 1, 0),
  radius = 0.5,
  direction = NA,
  from_center = TRUE,
  material = diffuse(),
  angle = c(0, 0, 0),
  flipped = FALSE,
  scale = c(1, 1, 1)
)

Arguments

Value

Single row of a tibble describing the cone in the scene.

Examples

#Generate a cone in a studio, pointing upwards:
generate_studio() |>
 add_object(cone(start=c(0,-1,0), end=c(0,1,0), radius=1,material=diffuse(color="red"))) |>
 add_object(sphere(y=5,x=5,material=light(intensity=40))) |>
 render_scene(samples=16,clamp_value=10)
 #Change the radius, length, and direction
generate_studio() |>
 add_object(cone(start=c(0,0,0), end=c(0,-1,0), radius=0.5,material=diffuse(color="red"))) |>
 add_object(sphere(y=5,x=5,material=light(intensity=40))) |>
 render_scene(samples=16,clamp_value=10)
#Give custom start and end points (and customize the color/texture)
generate_studio() |>
 add_object(cone(start=c(-1,0.5,-1), end=c(0,0,0), radius=0.5,material=diffuse(color="red"))) |>
 add_object(cone(start=c(1,0.5,-1), end=c(0,0,0), radius=0.5,material=diffuse(color="green"))) |>
 add_object(cone(start=c(0,1,-1), end=c(0,0,0), radius=0.5,material=diffuse(color="orange"))) |>
 add_object(cone(start=c(-1,-0.5,0), end=c(1,-0.5,0), radius=0.25,
   material = diffuse(color="red",gradient_color="green"))) |>
 add_object(sphere(y=5,x=5,material=light(intensity=40))) |>
 render_scene(samples=16,clamp_value=10)
#Specify cone via direction and location, instead of start and end positions
#Length is derived from the magnitude of the direction.
gold_mat = microfacet(roughness=0.1,eta=c(0.216,0.42833,1.3184), kappa=c(3.239,2.4599,1.8661))
generate_studio() |>
  add_object(cone(start = c(-1,0,0), direction = c(-0.5,0.5,0), material = gold_mat)) |>
  add_object(cone(start = c(1,0,0), direction = c(0.5,0.5,0), material = gold_mat)) |>
  add_object(cone(start = c(0,0,-1), direction = c(0,0.5,-0.5), material = gold_mat)) |>
  add_object(cone(start = c(0,0,1), direction = c(0,0.5,0.5), material = gold_mat)) |>
  add_object(sphere(y=5,material=light())) |>
  add_object(sphere(y=3,x=-3,z=-3,material=light(color="red"))) |>
  add_object(sphere(y=3,x=3,z=-3,material=light(color="green"))) |>
  render_scene(lookfrom=c(0,4,-10), clamp_value=10, samples=16)
 #Render the position from the base, instead of the center of the cone:
 noise_mat = material = glossy(color="purple",noisecolor="blue", noise=5)
 generate_studio() |>
  add_object(cone(start = c(0,-1,0), from_center = FALSE, radius=1, direction = c(0,2,0),
    material = noise_mat)) |>
  add_object(cone(start = c(-1.5,-1,0), from_center = FALSE, radius=0.5, direction = c(0,1,0),
    material = noise_mat)) |>
  add_object(cone(start = c(1.5,-1,0), from_center = FALSE, radius=0.5, direction = c(0,1,0),
    material = noise_mat)) |>
  add_object(cone(start = c(0,-1,1.5), from_center = FALSE, radius=0.5, direction = c(0,1,0),
    material = noise_mat)) |>
  add_object(sphere(y=5,x=5,material=light(intensity=40))) |>
  render_scene(lookfrom=c(0,4,-10), clamp_value=10,fov=25, samples=16)

Convert Color

Description

Convert Color

Usage

convert_color(color, as_hex = FALSE)

Arguments

Value

Color vector

Examples

#none

Create Instances of an Object

Description

This creates multiple instances of the ‘ray_scene' passed, each with it’s own transformation applied (measured from the origin of the ray_scene). This means the scene only uses the memory of the object once and each copy only requires a 4x4 matrix in memory.

Usage

create_instances(
  ray_scene,
  x = 0,
  y = 0,
  z = 0,
  angle_x = 0,
  angle_y = 0,
  angle_z = 0,
  scale_x = 1,
  scale_y = 1,
  scale_z = 1,
  material = diffuse(),
  order_rotation = c(1, 2, 3)
)

Arguments

Value

Single row of a tibble describing the instance in the scene.

Examples

# Generate the base scene
base_scene = generate_ground(material = diffuse(checkercolor = "grey20")) |>
  add_object(sphere(z = -100, radius = 10, material = light(intensity = 70)))

# Start with a single sphere with an R in it
sphere_scene = sphere(y = 0, material = glossy(color = "#2b6eff", reflectance = 0.05)) |>
  add_object(obj_model(r_obj(simple_r = TRUE), z = -0.9, y = -0.2,
  scale_obj = 0.45, angle = c(0,180,0), material = diffuse())) |>
  group_objects(scale = 0.1)

# Render the scene
sphere_scene |>
  add_object(base_scene) |>
  render_scene(lookat = c(0, 1, 0), width = 800, sample_method = "sobol_blue", aperture = 0.2,
               height = 800, samples = 16, clamp_value = 20)

# Create instances at different x positions, with random rotations applied
create_instances(sphere_scene,
                 x = seq(-1.5, 1.5, length.out = 10),
                 angle_x = 90 * (runif(10) - 0.5),
                 angle_y = 90 * (runif(10) - 0.5),
                 angle_z = 90 * (runif(10) - 0.5)) |>
  add_object(base_scene) |>
  render_scene(lookat = c(0, 1, 0), width = 800, sample_method = "sobol_blue",
               height = 800, samples = 16, clamp_value = 20)

# Create instances at different x/z positions, with random scaling factors
create_instances(sphere_scene,
                 x = seq(-1.5, 1.5, length.out = 10),
                 y = seq(0, 1.5, length.out = 10),
                 scale_x = 0.5 + runif(10),
                 scale_y = 0.5 + runif(10),
                 scale_z = 0.5 + runif(10)) |>
  add_object(base_scene) |>
  render_scene(lookat = c(0, 1, 0), width = 800, sample_method = "sobol_blue",
               height = 800, samples = 16, clamp_value = 20)

# Create instances of instances
create_instances(sphere_scene,
                 x = seq(-1.5, 1.5, length.out = 10),
                 angle_y = 90 * (runif(10) - 0.5)) |>
  create_instances(y = seq(0, 2, length.out = 10)) |>
  add_object(base_scene) |>
  render_scene(lookat = c(0, 1, 0), width = 800, sample_method = "sobol_blue",
               height = 800, samples = 16, clamp_value = 20)

# Create instances of instances of instances of instances
create_instances(sphere_scene,
                 x = seq(-1.5, 1.5, length.out = 10),
                 angle_y = 90 * (runif(10) - 0.5)) |>
  create_instances(y = seq(0, 1, length.out = 5)) |>
  create_instances(y = seq(0, 2, length.out = 20) * 10,
                   angle_y = seq(0, 360, length.out = 20)) |>
  create_instances(x = c(-5, 0, 5),
                   scale_y = c(0.5, 1, 0.75)) |>
  add_object(base_scene) |>
  render_scene(lookat = c(0, 10, 0), lookfrom = c(0, 10, -50),
               width = 800, sample_method = "sobol_blue", fov = 30,
               height = 800, samples = 16, clamp_value = 20)

# Generate a complex scene in a Cornell box and replicate it in a 3x3 grid
# Here, a single `data.frame` with all three coordinates is passed to the `x` argument.
tempfileplot = tempfile()
png(filename = tempfileplot, height = 1600, width = 1600)
plot(iris$Petal.Length, iris$Sepal.Width, col = iris$Species, pch = 18, cex = 12)
dev.off()
image_array = png::readPNG(tempfileplot)

# Note that if a instanced scene has importance sampled lights and there are many instances,
# it will be slow to render.
generate_cornell(importance_sample=FALSE) |>
  add_object(ellipsoid(x = 555 / 2, y = 100, z = 555 / 2, a = 50, b = 100, c = 50,
             material = metal(color = "lightblue"))) |>
  add_object(cube(x = 100, y = 130 / 2, z = 200, xwidth = 130,
                  ywidth = 130, zwidth = 130, angle = c(0, 10, 0),
                  material = diffuse(checkercolor = "purple", checkerperiod = 30))) |>
  add_object(pig(x = 100, y = 190, z = 200, scale = 40, angle = c(0, 30, 0))) |>
  add_object(sphere(x = 420, y = 555 / 8, z = 100, radius = 555 / 8,
                    material = dielectric(color = "orange"))) |>
  add_object(yz_rect(x = 5, y = 300, z = 555 / 2, zwidth = 400, ywidth = 400,
                     material = diffuse(image_texture = image_array))) |>
  add_object(yz_rect(x = 555 / 2, y = 300, z = 555 - 5, zwidth = 400, ywidth = 400,
                     material = diffuse(image_texture = image_array), angle = c(0, 90, 0))) |>
  add_object(yz_rect(x = 555 - 5, y = 300, z = 555 / 2, zwidth = 400, ywidth = 400,
                     material = diffuse(image_texture = image_array), angle = c(0, 180, 0))) |>
  create_instances(x = expand.grid(x = seq(-1, 1, by = 1) * 570 - 555 / 2,
                                   y = seq(-1, 1, by = 1) * 570 - 555 / 2,
                                   z = 0)) |>
  render_scene(lookfrom = c(0, 0, -800) * 3, fov = 40,
               samples = 16, sample_method = "sobol_blue",
               parallel = TRUE, width = 800, height = 800)

Cross product (vec)

Description

Cross product (vec)

Usage

cross_prod(x, y)

Arguments

Value

3D Numeric value for vector in space

CSG Box

Description

CSG Box

Usage

csg_box(x = 0, y = 0, z = 0, width = c(1, 1, 1), corner_radius = 0)

Arguments

Value

List describing the box in the scene.

Examples

#Generate a box
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_box(), material=glossy(color="#FF69B4"))) |>
  add_object(sphere(y=5,x=5,radius=3,material=light(intensity=5))) |>
  render_scene(clamp_value=10, samples=16,lookfrom=c(7,3,7))
#Change the width
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_box(width = c(2,1,0.5)), material=glossy(color="#FF69B4"))) |>
  add_object(sphere(y=5,x=5,radius=3,material=light(intensity=5))) |>
  render_scene(clamp_value=10, samples=16,lookfrom=c(7,3,7))
#Subtract two boxes to make stairs
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_combine(
    csg_box(),
    csg_box(x=0.5,y=0.5,width=c(1,1,1.1)),operation="subtract"),
   material=glossy(color="#FF69B4"))) |>
  add_object(sphere(y=5,x=5,radius=3,material=light(intensity=5))) |>
  render_scene(clamp_value=10, samples=16,lookfrom=c(7,3,7),fov=13)

CSG Capsule

Description

CSG Capsule

Usage

csg_capsule(start = c(0, 0, 0), end = c(0, 1, 0), radius = 1)

Arguments

Value

List describing the capsule in the scene.

Examples

#Generate a basic capsule:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_capsule(radius=0.5),material=glossy(color="red"))) |>
  render_scene(clamp_value=10, samples=16,fov=20)
#Change the orientation by specifying a start and end
generate_ground(material=diffuse(color="dodgerblue4",checkercolor="grey10")) |>
  add_object(csg_object(csg_capsule(start = c(-1,0.5,-2), end = c(1,0.5,-2),
  radius=0.5),material=glossy(checkercolor="red"))) |>
  render_scene(clamp_value=10, samples=16,fov=20,
               lookat=c(0,0.5,-2),lookfrom=c(3,3,10))
#Show the effect of changing the radius
generate_ground(material=diffuse(color="dodgerblue4",checkercolor="grey10")) |>
  add_object(csg_object(
    csg_combine(
    csg_capsule(start = c(-1,0.5,-2), end = c(1,0.5,-2), radius=0.5),
    csg_capsule(start = c(-0.5,1.5,-2), end = c(0.5,1.5,-2), radius=0.25)),
    material=glossy(checkercolor="red"))) |>
  render_scene(clamp_value=10, samples=16,fov=20,
               lookat=c(0,0.5,-2),lookfrom=c(-3,3,10))
#Render a capsule in a Cornell box
generate_cornell() |>
  add_object(csg_object(
    csg_capsule(start = c(555/2-100,555/2,555/2), end = c(555/2+100,555/2,555/2), radius=100),
    material=glossy(color="dodgerblue4"))) |>
  render_scene(clamp_value=10, samples=16)

CSG Combine

Description

Note: Subtract operations aren't commutative: the second object is subtracted from the first.

Usage

csg_combine(object1, object2, operation = "union", radius = 0.5)

Arguments

Value

List describing the combined csg object in the scene.

Examples

#Combine two spheres:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_combine(
     csg_sphere(x=-0.4,z=-0.4),
     csg_sphere(x=0.4,z=0.4), operation="union"),
  material=glossy(color="dodgerblue4"))) |>
  add_object(sphere(y=5,x=5,radius=3,material=light(intensity=10))) |>
  render_scene(clamp_value=10, samples=16,fov=20,lookfrom=c(-3,5,10))
#Subtract one sphere from another:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_combine(
     csg_sphere(x=-0.4,z=-0.4),
     csg_sphere(x=0.4,z=0.4), operation="subtract"),
  material=glossy(color="dodgerblue4"))) |>
  add_object(sphere(y=5,x=5,radius=3,material=light(intensity=10))) |>
  render_scene(clamp_value=10, samples=16,fov=20,lookfrom=c(-3,5,10))
#Get the intersection of two spheres:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_combine(
     csg_sphere(x=-0.4,z=-0.4),
     csg_sphere(x=0.4,z=0.4), operation="intersection"),
  material=glossy(color="dodgerblue4"))) |>
  add_object(sphere(y=5,x=5,radius=3,material=light(intensity=10))) |>
  render_scene(clamp_value=10, samples=16,fov=20,lookfrom=c(-3,5,10))
#Get the blended union of two spheres:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_combine(
     csg_sphere(x=-0.4,z=-0.4),
     csg_sphere(x=0.4,z=0.4), operation="blend"),
  material=glossy(color="dodgerblue4"))) |>
  add_object(sphere(y=5,x=5,radius=3,material=light(intensity=10))) |>
  render_scene(clamp_value=10, samples=16,fov=20,lookfrom=c(-3,5,10))
#Get the blended subtraction of two spheres:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_combine(
     csg_sphere(x=-0.4,z=-0.4),
     csg_sphere(x=0.4,z=0.4), operation="subtractblend"),
  material=glossy(color="dodgerblue4"))) |>
  add_object(sphere(y=5,x=5,radius=3,material=light(intensity=10))) |>
  render_scene(clamp_value=10, samples=16,fov=20,lookfrom=c(-3,5,10))
#Change the blending radius:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_combine(
     csg_sphere(x=-0.4,z=-0.4),
     csg_sphere(x=0.4,z=0.4), operation="blend", radius=0.2),
  material=glossy(color="dodgerblue4"))) |>
  add_object(sphere(y=5,x=5,radius=3,material=light(intensity=10))) |>
  render_scene(clamp_value=10, samples=16,fov=20,lookfrom=c(-3,5,10))
#Change the subtract blending radius:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_combine(
     csg_sphere(x=-0.4,z=-0.4),
     csg_sphere(x=0.4,z=0.4), operation="subtractblend", radius=0.2),
  material=glossy(color="dodgerblue4"))) |>
  add_object(sphere(y=5,x=5,radius=3,material=light(intensity=10))) |>
  render_scene(clamp_value=10, samples=16,fov=20,lookfrom=c(-3,5,10))
#Get the mixture of various objects:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_combine(
     csg_sphere(),
     csg_box(), operation="mix"),
  material=glossy(color="dodgerblue4"))) |>
  add_object(csg_object(csg_translate(csg_combine(
     csg_box(),
     csg_torus(), operation="mix"),z=-2.5),
  material=glossy(color="red"))) |>
  add_object(csg_object(csg_translate(csg_combine(
     csg_pyramid(),
     csg_box(), operation="mix"),z=2.5),
  material=glossy(color="green"))) |>
  add_object(sphere(y=10,x=-5,radius=3,material=light(intensity=10))) |>
  render_scene(clamp_value=10, samples=16,fov=20,lookfrom=c(-15,10,10))

CSG Cone

Description

CSG Cone

Usage

csg_cone(start = c(0, 0, 0), end = c(0, 1, 0), radius = 0.5)

Arguments

Value

List describing the box in the scene.

Examples

#Generate a basic cone:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_cone(),material=glossy(color="red"))) |>
  render_scene(clamp_value=10, samples=16,fov=20)
#Change the orientation by specifying a start and end
generate_ground(material=diffuse(color="dodgerblue4",checkercolor="grey10")) |>
  add_object(csg_object(csg_cone(start = c(-1,0.5,-2), end = c(1,0.5,-2),
  radius=0.5),material=glossy(checkercolor="red"))) |>
  render_scene(clamp_value=10, samples=16,fov=20,
               lookat=c(0,0.5,-2),lookfrom=c(3,3,10))
#Show the effect of changing the radius
generate_ground(material=diffuse(color="dodgerblue4",checkercolor="grey10")) |>
  add_object(csg_object(
    csg_combine(
    csg_cone(start = c(-1,0.5,-2), end = c(1,0.5,-2), radius=0.5),
    csg_cone(start = c(-0.5,1.5,-2), end = c(0.5,1.5,-2), radius=0.2)),
    material=glossy(checkercolor="red"))) |>
  render_scene(clamp_value=10, samples=16,fov=20,
               lookat=c(0,0.5,-2),lookfrom=c(-3,3,10))
#Render a glass cone in a Cornell box
generate_cornell() |>
  add_object(csg_object(
    csg_cone(start = c(555/2,0,555/2), end = c(555/2,555/2+100,555/2), radius=100),
    material=dielectric(attenuation=c(1,1,0.3)/100))) |>
  render_scene(clamp_value=10, samples=16)

CSG Cylinder

Description

CSG Cylinder

Usage

csg_cylinder(
  start = c(0, 0, 0),
  end = c(0, 1, 0),
  radius = 1,
  corner_radius = 0
)

Arguments

Value

List describing the cylinder in the scene.

Examples

#Generate a basic cylinder:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_cylinder(radius=0.25),material=glossy(color="red"))) |>
  render_scene(clamp_value=10, samples=16,fov=20)
#Change the orientation by specifying a start and end
generate_ground(material=diffuse(color="dodgerblue4",checkercolor="grey10")) |>
  add_object(csg_object(csg_cylinder(start = c(-1,0.5,-2), end = c(1,0.5,-2),
    radius=0.5),material=glossy(checkercolor="red"))) |>
  render_scene(clamp_value=10, samples=16,fov=20,
               lookat=c(0,0.5,-2),lookfrom=c(3,3,10))
#Show the effect of changing the radius
generate_ground(material=diffuse(color="dodgerblue4",checkercolor="grey10")) |>
  add_object(csg_object(
    csg_combine(
    csg_cylinder(start = c(-1,0.5,-2), end = c(1,0.5,-2), radius=0.5),
    csg_cylinder(start = c(-0.5,1.5,-2), end = c(0.5,1.5,-2), radius=0.25)),
    material=glossy(checkercolor="red"))) |>
  render_scene(clamp_value=10, samples=16,fov=20,
               lookat=c(0,0.5,-2),lookfrom=c(-3,3,10))
#Render a red marble cylinder in a Cornell box
generate_cornell(light=FALSE) |>
  add_object(csg_object(
    csg_cylinder(start = c(555/2,0,555/2), end = c(555/2,350,555/2), radius=100),
    material=glossy(color="darkred",noisecolor="white",noise=0.03))) |>
    add_object(sphere(y=555,x=5,z=5, radius=5,
               material=light(intensity=10000,
                              spotlight_focus = c(555/2,555/2,555/2),spotlight_width = 45))) |>
  render_scene(clamp_value=4)

CSG Ellipsoid

Description

CSG Ellipsoid

Usage

csg_ellipsoid(x = 0, y = 0, z = 0, axes = c(0.5, 1, 0.5))

Arguments

Value

List describing the ellipsoid in the scene.

Examples

#Generate a basic ellipsoid:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_ellipsoid(),material=glossy(color="red"))) |>
  render_scene(clamp_value=10, samples=16,fov=20)
#Three different ellipsoids:
generate_ground(material=diffuse(checkercolor="grey20")) |>
 add_object(csg_object(csg_group(list(
   csg_ellipsoid(x=-1.2, axes = c(0.2,0.5,0.5)),
   csg_ellipsoid(x=0, axes = c(0.5,0.2,0.5)),
   csg_ellipsoid(x=1.2, axes = c(0.5,0.5,0.2)))),
   material=glossy(color="red"))) |>
 render_scene(clamp_value=10, samples=16,fov=20,lookfrom=c(0,5,10))
#Generate a glass ellipsoid:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_ellipsoid(),material=dielectric(attenuation = c(1,1,0.3)))) |>
  render_scene(clamp_value=10, samples=16,fov=20)
#Generate a glass ellipsoid in a Cornell box:
generate_cornell() |>
  add_object(csg_object(csg_ellipsoid(x=555/2,y=555/2,z=555/2,axes=c(100,150,200)),
    material=dielectric(attenuation = c(1,0.3,1)/200))) |>
  render_scene(clamp_value=10, samples=16)

CSG Elongate

Description

This operation elongates an existing CSG object in a direction.

Usage

csg_elongate(object, x = 0, y = 0, z = 0, elongate = c(0, 0, 0), robust = TRUE)

Arguments

Value

List describing the triangle in the scene.

Examples

#Elongate a sphere to create a capsule in 1D or a rounded rectangle in 2D:
generate_ground(material=diffuse(checkercolor="grey20",color="dodgerblue4")) |>
 add_object(csg_object(csg_sphere(z=-3,x=-3),
                        material=glossy(color="purple"))) |>
 add_object(csg_object(csg_elongate(csg_sphere(z=-3,x=3),x=3,z=-3, elongate = c(0.8,0,0)),
                        material=glossy(color="red"))) |>
 add_object(csg_object(csg_elongate(csg_sphere(z=2),z=2, elongate = c(0.8,0,0.8)),
                        material=glossy(color="white"))) |>
 add_object(sphere(y=10,radius=3,material=light(intensity=8))) |>
 render_scene(clamp_value=10, samples=16,fov=40,lookfrom=c(0,10,10))
#Elongate a torus:
generate_ground(material=diffuse(checkercolor="grey20",color="dodgerblue4")) |>
 add_object(csg_object(csg_torus(z=-3,x=-3),
                        material=glossy(color="purple"))) |>
 add_object(csg_object(csg_elongate(csg_torus(z=-3,x=3),x=3,z=-3, elongate = c(0.8,0,0)),
                        material=glossy(color="red"))) |>
 add_object(csg_object(csg_elongate(csg_torus(z=2),z=2, elongate = c(0.8,0,0.8)),
                        material=glossy(color="white"))) |>
 add_object(sphere(y=10,radius=3,material=light(intensity=8))) |>
 render_scene(clamp_value=10, samples=16,fov=40,lookfrom=c(0,10,10))
#Elongate a cylinder:
generate_ground(material=diffuse(checkercolor="grey20",color="dodgerblue4")) |>
 add_object(csg_object(csg_cylinder(start=c(-3,0,-3), end = c(-3,1,-3)),
                        material=glossy(color="purple"))) |>
 add_object(csg_object(csg_elongate(csg_cylinder(start=c(3,0,-3), end = c(3,1,-3)), x=3, z=-3,
                       elongate = c(0.8,0,0)),
                       material=glossy(color="red"))) |>
 add_object(csg_object(csg_elongate(csg_cylinder(start=c(0,0,3), end = c(0,1,3)), z=3,
                       elongate = c(0.8,0,0.8)),
                       material=glossy(color="white"))) |>
 add_object(sphere(y=10,radius=3,material=light(intensity=8))) |>
 render_scene(clamp_value=10, samples=16,fov=40,lookfrom=c(0,10,10))
#Elongate a pyramid:
generate_ground(material=diffuse(checkercolor="grey20",color="dodgerblue4")) |>
 add_object(csg_object(csg_pyramid(z=-3,x=-3),
                        material=glossy(color="purple"))) |>
 add_object(csg_object(csg_elongate(csg_pyramid(z=-3,x=3),x=3,z=-3, elongate = c(0.8,0,0)),
                        material=glossy(color="red"))) |>
 add_object(csg_object(csg_elongate(csg_pyramid(z=2),z=2, elongate = c(0.8,0,0.8)),
                        material=glossy(color="white"))) |>
 add_object(sphere(y=10,radius=3,material=light(intensity=8))) |>
 render_scene(clamp_value=10, samples=16,fov=40,lookfrom=c(0,10,10))
#Change the elongation point to start the elongation on the side of the pyramid:
generate_ground(material=diffuse(checkercolor="grey20",color="dodgerblue4")) |>
 add_object(csg_object(csg_pyramid(z=-3,x=-3),
                        material=glossy(color="purple"))) |>
 add_object(csg_object(csg_elongate(csg_pyramid(z=-3,x=3),x=2.75,z=-2.75, elongate = c(0.8,0,0)),
                        material=glossy(color="red"))) |>
 add_object(csg_object(csg_elongate(csg_pyramid(z=2),z=2.25, elongate = c(0.8,0,0.8)),
                        material=glossy(color="white"))) |>
 add_object(sphere(y=10,radius=3,material=light(intensity=8))) |>
 render_scene(clamp_value=10, samples=16,fov=40,
              lookfrom=c(5,5,10),lookat=c(0,0,-1.5))

CSG Group

Description

CSG Group

Usage

csg_group(object_list)

Arguments

Value

List describing the group in the scene.

Examples

#Group four spheres together and merge them with a box:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_combine(
  csg_group(list(csg_sphere(x=1,z=1, radius=0.5),csg_sphere(x=-1,z=1, radius=0.5),
                 csg_sphere(x=1,z=-1, radius=0.5),csg_sphere(x=-1,z=-1, radius=0.5))),
  csg_box(y=0.5, width=c(2,0.2,2)), operation="blend"), material=glossy(color="red"))) |>
  add_object(sphere(y=10,x=-5,radius=3,material=light(intensity=10))) |>
  render_scene(clamp_value=10, samples=16,lookfrom=c(5,5,10))

Constructive Solid Geometry Object

Description

This object takes an object constructed using the 'csg_*' functions. The object is drawn using ray marching/sphere tracing.

Usage

csg_object(
  object,
  x = 0,
  y = 0,
  z = 0,
  material = diffuse(),
  angle = c(0, 0, 0),
  order_rotation = c(1, 2, 3),
  flipped = FALSE,
  scale = c(1, 1, 1)
)

Arguments

Details

Note: For dielectric objects, any other objects not included in the CSG object and nested inside will be ignored.

Value

Single row of a tibble describing the sphere in the scene.

Examples

#We will combine these three objects:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_box(), material=glossy(color="red"))) |>
  add_object(csg_object(csg_sphere(radius=0.707), material=glossy(color="green"))) |>
  add_object(csg_object(csg_group(list(csg_cylinder(start=c(-1,0,0), end=c(1,0,0), radius=0.4),
                   csg_cylinder(start=c(0,-1,0), end=c(0,1,0), radius=0.4),
                   csg_cylinder(start=c(0,0,-1), end=c(0,0,1), radius=0.4))),
                   material=glossy(color="blue"))) |>
  add_object(sphere(y=5,x=3,radius=1,material=light(intensity=30))) |>
  render_scene(clamp_value=10, fov=15,lookfrom=c(5,5,10),
               samples=16, sample_method="sobol_blue")
#Standard CSG sphere + box - crossed cylinder combination:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_combine(
    csg_combine(
      csg_box(),
      csg_sphere(radius=0.707),
      operation="intersection"),
    csg_group(list(csg_cylinder(start=c(-1,0,0), end=c(1,0,0), radius=0.4),
                   csg_cylinder(start=c(0,-1,0), end=c(0,1,0), radius=0.4),
                   csg_cylinder(start=c(0,0,-1), end=c(0,0,1), radius=0.4))),
    operation="subtract"),
    material=glossy(color="red"))) |>
  add_object(sphere(y=5,x=3,radius=1,material=light(intensity=30))) |>
  render_scene(clamp_value=10, fov=10,lookfrom=c(5,5,10),
               samples=16, sample_method="sobol_blue")
#Blend them all instead:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_combine(
    csg_combine(
      csg_box(),
      csg_sphere(radius=0.707),
      operation="blend"),
    csg_group(list(csg_cylinder(start=c(-1,0,0), end=c(1,0,0), radius=0.4),
                   csg_cylinder(start=c(0,-1,0), end=c(0,1,0), radius=0.4),
                   csg_cylinder(start=c(0,0,-1), end=c(0,0,1), radius=0.4))),
    operation="blend"),
    material=glossy(color="purple"))) |>
  add_object(sphere(y=5,x=3,radius=1,material=light(intensity=30))) |>
  render_scene(clamp_value=10, fov=15,lookfrom=c(5,5,10),
               samples=16, sample_method="sobol_blue")

CSG Onion

Description

Note: This operation has no overt effect on the external appearance of an object–it carves regions on the interior. Thus, you will only see an effect with a transparent material or when you carve into the object.

Usage

csg_onion(object, thickness = 0.1)

Arguments

Value

List describing the triangle in the scene.

Examples

#Cut and onion a sphere:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_combine(
    csg_onion(csg_sphere(z=2,x=2,radius=1), thickness = 0.2),
    csg_box(y=1,width=c(10,2,10)), operation = "subtract"),
    material=glossy(color="red"))) |>
    add_object(csg_object(csg_combine(
      csg_onion(csg_sphere(radius=1), thickness = 0.4),
      csg_box(y=1,width=c(10,2,10)), operation = "subtract"),
      material=glossy(color="purple"))) |>
    add_object(csg_object(csg_combine(
      csg_onion(csg_sphere(z=-2.5,x=-2.5,radius=1), thickness = 0.6),
      csg_box(y=1,width=c(10,2,10)), operation = "subtract"),
      material=glossy(color="green"))) |>
 add_object(sphere(y=5,x=5,radius=2,material=light())) |>
 render_scene(clamp_value=10, samples=16,lookat=c(0,-0.5,0),
              lookfrom=c(3,5,10),fov=35)
#Multiple onion layers:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_combine(
    csg_onion(csg_onion(csg_onion(csg_sphere(radius=1), 0.4), 0.2),0.1),
    csg_box(y=1,width=c(10,2,10)), operation = "subtract"),
    material=glossy(color="purple"))) |>
  add_object(sphere(y=5,x=5,radius=2,material=light())) |>
  render_scene(clamp_value=10, samples=16,lookat=c(0,-0.5,0),
               lookfrom=c(3,5,10),fov=20)
#Onion with dielectric sphere to make a bubble:
generate_cornell() |>
  add_object(csg_object(
    csg_onion(csg_sphere(x=555/2,y=555/2,z=555/2, radius=150), 5),
    material=dielectric(attenuation=c(1,1,0.3)/100))) |>
  render_scene(clamp_value=10, samples=16)
#Multiple onion operations to make a bubble within a bubble:
generate_cornell() |>
  add_object(csg_object(
    csg_onion(csg_onion(csg_sphere(x=555/2,y=555/2,z=555/2, radius=150), 10),5),
    material=dielectric(attenuation=c(1,1,0.3)/100))) |>
  render_scene(clamp_value=10, samples=16)

CSG Plane

Description

Note: This shape isn't closed, so there may be odd lighting issues if it's oriented the wrong way.

Usage

csg_plane(x = 0, y = 0, z = 0, normal = c(0, 1, 0), width_x = 4, width_z = 4)

Arguments

Value

List describing the plane in the scene.

Examples

#Generate a plane
csg_object(csg_plane(width_x=4, width_z=4), material=diffuse(checkercolor="purple")) |>
  add_object(sphere(y=5,x=5,material=light(intensity=40))) |>
  render_scene(clamp_value=10, samples=16)
#Combine the plane with a sphere
csg_object(csg_combine(
    csg_sphere(radius=0.5),
    csg_plane(width_x=4, width_z=4,y=-0.5),
    operation="blend"),material=diffuse(checkercolor="purple")) |>
  add_object(sphere(y=5,x=5,material=light(intensity=40))) |>
  render_scene(clamp_value=10, samples=16)
#Re-orient the plane using the normal and
csg_object(csg_combine(
    csg_sphere(radius=0.5),
    csg_plane(normal = c(1,1,0),width_x=4, width_z=4,y=-0.5),
    operation="blend"),material=diffuse(checkercolor="purple")) |>
  add_object(sphere(y=5,x=5,material=light(intensity=40))) |>
  render_scene(clamp_value=10, samples=16)

CSG Pyramid

Description

Note: This primitive slows down immensely for large values of base and height. Try using csg_scale() with this object for large pyramids instead.

Usage

csg_pyramid(x = 0, y = 0, z = 0, height = 1, base = 1)

Arguments

Value

List describing the box in the scene.

Examples

#Generate a simple pyramid:
generate_ground() |>
  add_object(csg_object(csg_pyramid(y=-0.99),
                        material=glossy(color="red"))) |>
  add_object(sphere(y=5,x=5,z=5,material=light(intensity=20))) |>
  render_scene(clamp_value=10, samples=16,lookfrom=c(-3,1,10),
               fov=15, lookat=c(0,-0.5,0))
#Make a taller pyramid
generate_ground() |>
  add_object(csg_object(csg_pyramid(y=-0.95, height=1.5),
                        material=glossy(color="red"))) |>
  add_object(sphere(y=5,x=5,z=5,material=light(intensity=20))) |>
  render_scene(clamp_value=10, samples=16,lookfrom=c(-3,1,10),
               fov=15, lookat=c(0,-0.5,0))
#Make a wider pyramid
generate_ground() |>
  add_object(csg_object(csg_pyramid(y=-0.95, base=1.5),
                        material=glossy(color="red"))) |>
  add_object(sphere(y=5,x=5,z=5,material=light(intensity=20))) |>
  render_scene(clamp_value=10, samples=16,lookfrom=c(-3,1,10),
               fov=15, lookat=c(0,-0.5,0))

CSG Rotate

Description

CSG Rotate

Usage

csg_rotate(
  object,
  pivot_point = c(0, 0, 0),
  angles = c(0, 0, 0),
  order_rotation = c(1, 2, 3),
  up = c(0, 1, 0),
  axis_x = NULL,
  axis_z = NULL
)

Arguments

Value

List describing the triangle in the scene.

Examples

#Rotate a pyramid (translating it upwards because the object is scaled from the center):
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_pyramid(z=1,y=-0.99),
                        material=glossy(color="red"))) |>
  add_object(csg_object(csg_rotate(csg_pyramid(z=-1.5,y=-0.99),
                        pivot_point = c(0,-0.99,-1.5),angle=c(0,45,0)),
                        material=glossy(color="green"))) |>
  add_object(sphere(y=5,x=5,z=5,material=light(intensity=40))) |>
  render_scene(lookfrom=c(-3,4,10), fov=15,
               lookat=c(0,-0.5,0),clamp_value=10)
#Rotate by specifying a new up vector:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_pyramid(z=1,y=-0.99),
                        material=glossy(color="red"))) |>
  add_object(csg_object(csg_rotate(csg_pyramid(z=-1.5,y=-0.49),
                        pivot_point = c(0,-0.49,-1.5), up =c(1,1,0)),
                        material=glossy(color="green"))) |>
  add_object(sphere(y=5,x=5,z=5,material=light(intensity=40))) |>
  render_scene(lookfrom=c(-3,4,10), fov=15,
               lookat=c(0,-0.5,0),clamp_value=10)

CSG Round

Description

CSG Round

Usage

csg_round(object, radius = 0.1)

Arguments

Value

List describing the triangle in the scene.

Examples

#Generate a rounded pyramid:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_pyramid(x=-1,y=-0.99,z=1),
                        material=glossy(color="red"))) |>
  add_object(csg_object(csg_round(csg_pyramid(x=1,y=-0.89)),
                        material=glossy(color="blue"))) |>
  add_object(csg_object(csg_round(csg_pyramid(x=0,z=-2,y=-0.5), radius=0.5),
                        material=glossy(color="green"))) |>
  add_object(sphere(y=5,x=5,z=5,radius=1,material=light(intensity=50))) |>
  render_scene(lookfrom=c(-3,4,10), fov=22,
               lookat=c(0,-0.5,0),clamp_value=10)
#Round a blend of two objects
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_round(csg_combine(
    csg_pyramid(x=-0.5,y=-0.99,z=1.5),
    csg_pyramid(x=0.5,y=-0.99,z=2), operation="blend"), radius=0),
                        material=glossy(color="red"))) |>
  add_object(csg_object(csg_round(csg_combine(
    csg_pyramid(x=-0.5,y=-0.79,z=-1.5),
    csg_pyramid(x=0.5,y=-0.79,z=-1), operation="blend"), radius=0.2),
                        material=glossy(color="green"))) |>
  add_object(sphere(y=5,x=5,z=5,radius=1,material=light(intensity=50))) |>
  render_scene(lookfrom=c(-3,5,10), fov=22,
               lookat=c(0,-0.5,0),clamp_value=10)

CSG Rounded Cone

Description

CSG Rounded Cone

Usage

csg_rounded_cone(
  start = c(0, 0, 0),
  end = c(0, 1, 0),
  radius = 0.5,
  upper_radius = 0.2
)

Arguments

Value

List describing the box in the scene.

Examples

#Generate a basic rounded cone:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_rounded_cone(),material=glossy(color="red"))) |>
  render_scene(clamp_value=10, samples=16,fov=20)
#Change the orientation by specifying a start and end
generate_ground(material=diffuse(color="dodgerblue4",checkercolor="grey10")) |>
  add_object(csg_object(csg_rounded_cone(start = c(-1,0.5,-2), end = c(1,0.5,-2),
  radius=0.5),material=glossy(checkercolor="red"))) |>
  render_scene(clamp_value=10, samples=16,fov=20,
               lookat=c(0,0.5,-2),lookfrom=c(3,3,10))
#Show the effect of changing the radius
generate_ground(material=diffuse(color="dodgerblue4",checkercolor="grey10")) |>
  add_object(csg_object(
    csg_combine(
    csg_rounded_cone(start = c(-1,0.5,-2), end = c(1,0.5,-2), radius=0.5),
    csg_rounded_cone(start = c(-0.5,1.5,-2), end = c(0.5,1.5,-2), radius=0.2,upper_radius = 0.5)),
    material=glossy(checkercolor="red"))) |>
  render_scene(clamp_value=10, samples=16,fov=20,
               lookat=c(0,0.5,-2),lookfrom=c(-3,3,10))
#Render a glass rounded cone in a Cornell box
generate_cornell() |>
  add_object(csg_object(
    csg_rounded_cone(start = c(555/2,555/2-100,555/2), end = c(555/2,555/2+100,555/2), radius=100),
    material=dielectric(attenuation=c(1,1,0.3)/100))) |>
  render_scene(clamp_value=10, samples=16)

CSG Scale

Description

CSG Scale

Usage

csg_scale(object, scale = 1)

Arguments

Value

List describing the triangle in the scene.

Examples

#Scale a pyramid (translating it upwards because the object is scaled from the center):
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_pyramid(z=1,y=-0.99),
                        material=glossy(color="red"))) |>
  add_object(csg_object(csg_scale(csg_pyramid(z=-1,y=-0.5),2),
                        material=glossy(color="green"))) |>
  add_object(sphere(y=5,x=5,z=5,material=light(intensity=40))) |>
  render_scene(lookfrom=c(-3,4,10), fov=20,
               lookat=c(0,-0.5,-0.5),clamp_value=10)

CSG Sphere

Description

CSG Sphere

Usage

csg_sphere(x = 0, y = 0, z = 0, radius = 1)

Arguments

Value

List describing the sphere in the scene.

Examples

#Generate a simple sphere:
generate_ground() |>
  add_object(csg_object(csg_sphere(),
                        material=glossy(color="purple"))) |>
  render_scene(clamp_value=10, samples=16)
#Generate a bigger sphere in the cornell box.
generate_cornell() |>
  add_object(csg_object(csg_sphere(x=555/2,y=555/2,z=555/2,radius=100),
                        material=glossy(checkercolor="purple", checkerperiod=100))) |>
  render_scene(clamp_value=10, samples=16)
#Combine two spheres of different sizes
generate_cornell() |>
  add_object(csg_object(
    csg_combine(
      csg_sphere(x=555/2,y=555/2-50,z=555/2,radius=100),
      csg_sphere(x=555/2,y=555/2+50,z=555/2,radius=80)),
    material=glossy(color="purple"))) |>
  render_scene(clamp_value=10, samples=16)
#Subtract two spheres to create an indented region
generate_cornell() |>
  add_object(csg_object(
    csg_combine(
      csg_sphere(x=555/2,y=555/2-50,z=555/2,radius=100),
      csg_sphere(x=555/2+30,y=555/2+20,z=555/2-90,radius=40),
      operation="subtract"),
    material=glossy(color="grey20"))) |>
  render_scene(clamp_value=10, samples=16)
#Use csg_combine(operation="blend") to melt the two together
generate_cornell() |>
  add_object(csg_object(
    csg_combine(
      csg_sphere(x=555/2,y=555/2-50,z=555/2,radius=100),
      csg_sphere(x=555/2,y=555/2+50,z=555/2,radius=80),
      operation="blend", radius=20),
    material=glossy(color="purple"))) |>
  render_scene(clamp_value=10, samples=16)

CSG Torus

Description

CSG Torus

Usage

csg_torus(x = 0, y = 0, z = 0, radius = 1, minor_radius = 0.5)

Arguments

Value

List describing the torus in the scene.

Examples

#Generate a torus:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_torus(), material=glossy(color="dodgerblue4"))) |>
  add_object(sphere(y=5,x=5,radius=3,material=light(intensity=10))) |>
  render_scene(clamp_value=10, samples=16,lookfrom=c(0,5,10),fov=30)
#Change the radius of the torus:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_torus(radius=2), material=glossy(color="dodgerblue4"))) |>
  add_object(sphere(y=5,x=5,radius=3,material=light(intensity=10))) |>
  render_scene(clamp_value=10, samples=16,lookfrom=c(0,5,10),fov=30)
#Change the minor radius of the torus:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_torus(radius=2, minor_radius=0.25),
                        material=glossy(color="dodgerblue4"))) |>
  add_object(sphere(y=5,x=5,radius=3,material=light(intensity=10))) |>
  render_scene(clamp_value=10, samples=16,lookfrom=c(0,5,10),fov=30)
#Generate a rotated torus in the Cornell Box
generate_cornell() |>
  add_object(csg_object(csg_rotate(
    csg_torus(x=555/2,y=555/2,z=555/2,radius=100, minor_radius=50),
    pivot_point = c(555/2,555/2,555/2), up =c(0,1,-1)),
                        material=glossy(color="dodgerblue4"))) |>
  render_scene(clamp_value=10, samples=16)

CSG Translate

Description

CSG Translate

Usage

csg_translate(object, x = 0, y = 0, z = 0)

Arguments

Value

List describing the triangle in the scene.

Examples

#Translate a simple object:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_torus(), material=glossy(color="dodgerblue4"))) |>
  add_object(csg_object(csg_translate(csg_torus(),x=-2,y=1,z=-2),
                        material=glossy(color="red"))) |>
  add_object(sphere(y=5,x=5,radius=3,material=light(intensity=10))) |>
  render_scene(clamp_value=10, samples=16,lookfrom=c(0,5,10),fov=30,
               lookat=c(-1,0.5,-1))
#Translate a blended object:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_combine(
    csg_torus(),
    csg_torus(y=1, radius=0.8), operation="blend"), material=glossy(color="dodgerblue4"))) |>
  add_object(csg_object(csg_translate(
    csg_combine(
      csg_torus(),
      csg_torus(y=1, radius=0.8), operation="blend"),
    x=-3,y=1,z=-3),
    material=glossy(color="red"))) |>
  add_object(sphere(y=5,x=5,radius=3,material=light(intensity=10))) |>
  render_scene(clamp_value=10, samples=16,lookfrom=c(0,5,10),fov=30,
               lookat=c(-1.5,0.5,-1.5))

CSG Triangle

Description

CSG Triangle

Usage

csg_triangle(v1 = c(0, 1, 0), v2 = c(1, 0, 0), v3 = c(-1, 0, 0))

Arguments

Value

List describing the triangle in the scene.

Examples

#Generate a basic triangle:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_triangle(),material=diffuse(color="red"))) |>
  add_object(sphere(y=5,z=-3,material=light(intensity=30))) |>
  render_scene(clamp_value=10, samples=16,fov=20)
#Change a vertex:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_triangle(v1 = c(1,1,0)),material=diffuse(color="green"))) |>
  add_object(sphere(y=5,z=-3,material=light(intensity=30))) |>
  render_scene(clamp_value=10, samples=16,fov=20)
#Change all three vertices:
generate_ground(material=diffuse(checkercolor="grey20")) |>
  add_object(csg_object(csg_triangle(v1 = c(0.5,1,0), v2 = c(1,-0.5,0), v3 = c(-1,0.5,0)),
                        material=diffuse(color="blue"))) |>
  add_object(sphere(y=5,z=3,material=light(intensity=30))) |>
  render_scene(clamp_value=10, samples=16,fov=20,lookfrom=c(0,5,10))

Cube Object

Description

Cube Object

Usage

cube(
  x = 0,
  y = 0,
  z = 0,
  width = 1,
  xwidth = 1,
  ywidth = 1,
  zwidth = 1,
  material = diffuse(),
  angle = c(0, 0, 0),
  order_rotation = c(1, 2, 3),
  flipped = FALSE,
  scale = c(1, 1, 1)
)

Arguments

Value

Single row of a tibble describing the cube in the scene.

Examples

#Generate a cube in the cornell box.
generate_cornell() |>
  add_object(cube(x = 555/2, y = 100, z = 555/2,
                  xwidth = 200, ywidth = 200, zwidth = 200, angle = c(0, 30, 0))) |>
  render_scene(lookfrom = c(278, 278, -800) ,lookat = c(278, 278, 0), fov = 40,
               ambient_light = FALSE, samples = 16, parallel = TRUE, clamp_value = 5)
#Generate a gold cube in the cornell box
generate_cornell() |>
  add_object(cube(x = 555/2, y = 100, z = 555/2,
                  xwidth = 200, ywidth = 200, zwidth = 200, angle = c(0, 30, 0),
                  material = metal(color = "gold", fuzz = 0.2))) |>
  render_scene(lookfrom = c(278, 278, -800) ,lookat = c(278, 278, 0), fov = 40,
               ambient_light = FALSE, samples = 16, parallel = TRUE, clamp_value = 5)

#Generate a rotated dielectric box in the cornell box
generate_cornell() |>
  add_object(cube(x = 555/2, y = 200, z = 555/2,
                  xwidth = 200, ywidth = 100, zwidth = 200, angle = c(-30, 30, -30),
                  material = dielectric())) |>
  render_scene(lookfrom = c(278, 278, -800) ,lookat = c(278, 278, 0), fov = 40,
               ambient_light = FALSE, samples = 16, parallel = TRUE, clamp_value = 5)

Cubic-in-out

Description

Cubic-in-out

Usage

cubicInOut(t)

Arguments

Value

number

Cylinder Object

Description

Cylinder Object

Usage

cylinder(
  x = 0,
  y = 0,
  z = 0,
  radius = 1,
  length = 1,
  phi_min = 0,
  phi_max = 360,
  material = diffuse(),
  angle = c(0, 0, 0),
  order_rotation = c(1, 2, 3),
  flipped = FALSE,
  scale = c(1, 1, 1),
  capped = TRUE
)

Arguments

Value

Single row of a tibble describing the cylinder in the scene.

Examples

#Generate a cylinder in the cornell box. Add a cap to both ends.

generate_cornell() |>
  add_object(cylinder(x = 555/2, y = 250, z = 555/2,
                      length = 300, radius = 100, material = metal())) |>
  render_scene(lookfrom = c(278, 278, -800) ,lookat = c(278, 278, 0), fov = 40,
               ambient_light = FALSE, samples = 16, parallel = TRUE, clamp_value = 5)
#Rotate the cylinder
generate_cornell() |>
  add_object(cylinder(x = 555/2, y = 250, z = 555/2,
                      length = 300, radius = 100, angle = c(0, 0, 45),
                      material = diffuse())) |>
  render_scene(lookfrom = c(278, 278, -800) ,lookat = c(278, 278, 0), fov = 40,
               ambient_light = FALSE, samples = 16, parallel = TRUE, clamp_value = 5)

# Only render a subtended arc of the cylinder, flipping the normals.
generate_cornell(lightintensity=3) |>
  add_object(cylinder(x = 555/2, y = 250, z = 555/2, capped = FALSE,
                      length = 300, radius = 100, angle = c(45, 0, 0), phi_min = 0, phi_max = 180,
                      material = diffuse(), flipped = TRUE)) |>
  render_scene(lookfrom = c(278, 278, -800) ,lookat = c(278, 278, 0), fov = 40,
               ambient_light = FALSE, samples = 16, parallel = TRUE, clamp_value = 5)

Damp Camera Motion

Description

Damp Camera Motion

Usage

damp_camera_motion(motion, damp_magnitude, closed = FALSE)

Arguments

Value

Damped motion data frame.

Damp Closed Camera Motion

Description

Damp Closed Camera Motion

Usage

damp_camera_motion_closed(motion_matrix, damp_magnitude)

Arguments

Value

Damped motion matrix.

Damp Open Camera Motion

Description

Damp Open Camera Motion

Usage

damp_camera_motion_open(motion_matrix, damp_magnitude)

Arguments

Value

Damped motion matrix.

Dielectric (glass) Material

Description

Dielectric (glass) Material

Usage

dielectric(
  color = "white",
  refraction = 1.5,
  attenuation = c(0, 0, 0),
  attenuation_intensity = 1,
  priority = 0,
  importance_sample = FALSE,
  bump_texture = "",
  bump_intensity = 1
)

Arguments

Value

Single row of a tibble describing the dielectric material.

Examples

#Generate a checkered ground
scene = generate_ground(depth=-0.5, material = diffuse(checkercolor="grey30",checkerperiod=2))
render_scene(scene,parallel=TRUE, samples=16)

#Add a glass sphere
scene |>
  add_object(sphere(x=-0.5,radius=0.5,material=dielectric())) |>
  render_scene(parallel=TRUE,samples=16)

#Add a rotated colored glass cube
scene |>
  add_object(sphere(x=-0.5,radius=0.5,material=dielectric())) |>
  add_object(cube(x=0.5,xwidth=0.5,material=dielectric(color="darkgreen"),angle=c(0,-45,0))) |>
  render_scene(parallel=TRUE,samples=16)

#Add an area light behind and at an angle and turn off the ambient lighting
scene |>
  add_object(sphere(x=-0.5,radius=0.5,material=dielectric())) |>
  add_object(cube(x=0.5,xwidth=0.5,material=dielectric(color="darkgreen"),angle=c(0,-45,0))) |>
  add_object(yz_rect(z=-3,y=1,x=0,zwidth=3,ywidth=1.5,
                     material=light(intensity=15),
                     angle=c(0,-90,45), order_rotation = c(3,2,1))) |>
  render_scene(parallel=TRUE,aperture=0, ambient_light=FALSE,samples=16)

#Color glass using Beer-Lambert attenuation, which attenuates light on a per-channel
#basis as it travels through the material. This effect is what gives some types of glass
#a green glow at the edges. We will get this effect by setting a lower attenuation value
#for the `green` (second) channel in the dielectric `attenuation` argument.
generate_ground(depth=-0.5,material=diffuse(checkercolor="grey30",checkerperiod=2)) |>
  add_object(sphere(z=5,x=-0.5,y=1,material=light(intensity=10))) |>
  add_object(cube(y=0.3,ywidth=0.1,xwidth=2,zwidth=2,
                  material=dielectric(attenuation=c(1.2,0.2,1.2)),angle=c(45,110,0))) |>
  render_scene(parallel=TRUE, samples = 16)

#If you have overlapping dielectrics, the `priority` value can help disambiguate what
#object wins. Here, I place a bubble inside a cube by setting a lower priority value and
#making the inner sphere have a index of refraction of 1. I also place spheres at the corners.
generate_ground(depth=-0.51,material=diffuse(checkercolor="grey30",checkerperiod=2)) |>
  add_object(cube(material = dielectric(priority=2, attenuation = c(10,3,10)))) |>
  add_object(sphere(radius=0.49,material = dielectric(priority=1, refraction=1))) |>
  add_object(sphere(radius=0.25,x=0.5,z=-0.5,y=0.5,
                    material = dielectric(priority=0,attenuation = c(10,3,10) ))) |>
  add_object(sphere(radius=0.25,x=-0.5,z=0.5,y=0.5,
                    material = dielectric(priority=0,attenuation = c(10,3,10)))) |>
  render_scene(parallel=TRUE, samples = 16,lookfrom=c(5,1,5))

# We can also use this as a basic Constructive Solid Geometry interface by setting
# the index of refraction equal to empty space, 1. This will subtract out those regions.
# Here I make a concave lens by subtracting two spheres from a cube.
generate_ground(depth=-0.51,material=diffuse(checkercolor="grey30",checkerperiod=2,sigma=90)) |>
  add_object(cube(material = dielectric(attenuation = c(3,3,1),priority=1))) |>
  add_object(sphere(radius=1,x=1.01,
                    material = dielectric(priority=0,refraction=1))) |>
  add_object(sphere(radius=1,x=-1.01,
                    material = dielectric(priority=0,refraction=1))) |>
  add_object(sphere(y=10,x=3,material=light(intensit=150))) |>
  render_scene(parallel=TRUE, samples = 16,lookfrom=c(5,3,5))

Diffuse Material

Description

Diffuse Material

Usage

diffuse(
  color = "#ffffff",
  checkercolor = NA,
  checkerperiod = 3,
  noise = 0,
  noisephase = 0,
  noiseintensity = 10,
  noisecolor = "#000000",
  gradient_color = NA,
  gradient_transpose = FALSE,
  gradient_point_start = NA,
  gradient_point_end = NA,
  gradient_type = "hsv",
  image_texture = "",
  image_repeat = 1,
  alpha_texture = "",
  bump_texture = "",
  bump_intensity = 1,
  fog = FALSE,
  fogdensity = 0.01,
  sigma = NULL,
  importance_sample = FALSE
)

Arguments

Value

Single row of a tibble describing the diffuse material.

Examples

#Generate the cornell box and add a single white sphere to the center
scene = generate_cornell() |>
  add_object(sphere(x=555/2,y=555/2,z=555/2,radius=555/8,material=diffuse()))
render_scene(scene, lookfrom=c(278,278,-800),lookat = c(278,278,0), samples=16,
             aperture=0, fov=40, ambient_light=FALSE, parallel=TRUE)

#Add a checkered rectangular cube below
scene = scene |>
  add_object(cube(x=555/2,y=555/8,z=555/2,xwidth=555/2,ywidth=555/4,zwidth=555/2,
  material = diffuse(checkercolor="purple",checkerperiod=20)))
render_scene(scene, lookfrom=c(278,278,-800),lookat = c(278,278,0), samples=16,
             aperture=0, fov=40, ambient_light=FALSE, parallel=TRUE)

#Add a marbled sphere
scene = scene |>
  add_object(sphere(x=555/2+555/4,y=555/2,z=555/2,radius=555/8,
  material = diffuse(noise=1/20)))
render_scene(scene, lookfrom=c(278,278,-800),lookat = c(278,278,0), samples=16,
             aperture=0, fov=40, ambient_light=FALSE, parallel=TRUE)

#Add an orange volumetric (fog) cube
scene = scene |>
  add_object(cube(x=555/2-555/4,y=555/2,z=555/2,xwidth=555/4,ywidth=555/4,zwidth=555/4,
  material = diffuse(fog=TRUE, fogdensity=0.05,color="orange")))
render_scene(scene, lookfrom=c(278,278,-800),lookat = c(278,278,0), samples=16,
             aperture=0, fov=40, ambient_light=FALSE, parallel=TRUE)

#' #Add an line segment with a color gradient
scene = scene |>
  add_object(segment(start = c(555,450,450),end=c(0,450,450),radius = 50,
                     material = diffuse(color="#1f7326", gradient_color = "#a60d0d")))
render_scene(scene, lookfrom=c(278,278,-800),lookat = c(278,278,0), samples=16,
             aperture=0, fov=40, ambient_light=FALSE, parallel=TRUE)

Disk Object

Description

Disk Object

Usage

disk(
  x = 0,
  y = 0,
  z = 0,
  radius = 1,
  inner_radius = 0,
  material = diffuse(),
  angle = c(0, 0, 0),
  order_rotation = c(1, 2, 3),
  flipped = FALSE,
  scale = c(1, 1, 1)
)

Arguments

Value

Single row of a tibble describing the disk in the scene.

Examples

#Generate a disk in the cornell box.
generate_cornell() |>
  add_object(disk(x = 555/2, y = 50, z = 555/2, radius = 150,
                  material = diffuse(color = "orange"))) |>
  render_scene(lookfrom = c(278, 278, -800) ,lookat = c(278, 278, 0), fov = 40,
               ambient_light = FALSE, samples = 16, parallel = TRUE, clamp_value = 5)
#Rotate the disk.
generate_cornell() |>
  add_object(disk(x = 555/2, y = 555/2, z = 555/2, radius = 150, angle = c(-45, 0, 0),
                  material = diffuse(color = "orange"))) |>
  render_scene(lookfrom = c(278, 278, -800) , lookat = c(278, 278, 0), fov = 40,
               ambient_light = FALSE, samples = 16, parallel = TRUE, clamp_value = 5)
#Pass a value for the inner radius.
generate_cornell() |>
  add_object(disk(x = 555/2, y = 555/2, z = 555/2,
                  radius = 150, inner_radius = 75, angle = c(-45, 0, 0),
                  material = diffuse(color = "orange"))) |>
  render_scene(lookfrom = c(278, 278, -800) ,lookat = c(278, 278, 0), fov = 40,
               ambient_light = FALSE, samples = 16, parallel = TRUE, clamp_value = 5)

Ellipsoid Object

Description

Note: this is just a scaled sphere.

Usage

ellipsoid(
  x = 0,
  y = 0,
  z = 0,
  a = 1,
  b = 1,
  c = 1,
  material = diffuse(),
  angle = c(0, 0, 0),
  order_rotation = c(1, 2, 3),
  flipped = FALSE,
  scale = c(1, 1, 1)
)

Arguments

Value

Single row of a tibble describing the ellipsoid in the scene.

Examples

#Generate an ellipsoid in a Cornell box
generate_cornell() |>
  add_object(ellipsoid(x = 555/2, y = 555/2, z = 555/2,
                       a = 100, b = 50, c = 50)) |>
  render_scene(lookfrom = c(278, 278, -800) ,lookat = c(278, 278, 0), fov = 40,
               ambient_light = FALSE, samples = 16, parallel = TRUE, clamp_value = 5)

#Change the axes to make it taller rather than wide:
generate_cornell() |>
  add_object(ellipsoid(x = 555/2, y = 555/2, z = 555/2,
                       a = 100, b = 200, c = 100, material = metal())) |>
  render_scene(lookfrom = c(278, 278, -800) ,lookat = c(278, 278, 0), fov = 40,
               ambient_light = FALSE, samples = 16, parallel = TRUE, clamp_value = 5)

#Rotate it and make it dielectric:
generate_cornell() |>
  add_object(ellipsoid(x = 555/2, y = 555/2, z = 555/2,
                       a = 100, b = 200, c = 100, angle = c(0, 0, 45),
                       material = dielectric())) |>
  render_scene(lookfrom = c(278, 278, -800) ,lookat = c(278, 278, 0), fov = 40,
               ambient_light = FALSE, samples = 16, parallel = TRUE, clamp_value = 5)

Resolve environment light white point

Description

Resolve environment light white point

Usage

environment_light_white_xyz(white_point)

Arguments

Value

Numeric XYZ white point with Y = 1.

Evaluate Bezier

Description

Evaluate Bezier

Usage

eval_bezier(cp, t)

Arguments

Value

3D Numeric value for point in space

Evaluate Deriv Bezier

Description

Evaluate Deriv Bezier

Usage

eval_bezier_2nd_deriv(cp, t)

Arguments

Value

3D Numeric value for point in space

Evaluate Deriv Bezier

Description

Evaluate Deriv Bezier

Usage

eval_bezier_deriv(cp, t)

Arguments

Value

3D Numeric value for point in space

Cubic-in-out

Description

Cubic-in-out

Usage

expInOut(t)

Arguments

Value

number

Extruded Path Object

Description

Note: Bump mapping with non-diffuse materials does not work correctly, and smoothed normals will be flat when using a bump map.

Usage

extruded_path(
  points,
  x = 0,
  y = 0,
  z = 0,
  polygon = NA,
  polygon_end = NA,
  breaks = NA,
  closed = FALSE,
  closed_smooth = TRUE,
  polygon_add_points = 0,
  twists = 0,
  texture_repeats = 1,
  straight = FALSE,
  precomputed_control_points = FALSE,
  width = 1,
  width_end = NA,
  width_ease = "spline",
  smooth_normals = FALSE,
  u_min = 0,
  u_max = 1,
  linear_step = FALSE,
  end_caps = c(TRUE, TRUE),
  material = diffuse(),
  material_caps = NA,
  angle = c(0, 0, 0),
  order_rotation = c(1, 2, 3),
  flipped = FALSE,
  scale = c(1, 1, 1)
)

Arguments

Value

Single row of a tibble describing the cube in the scene.

Examples

#Specify the points for the path to travel though and the ground material
points = list(c(0,0,1),c(-0.5,0,-1),c(0,1,-1),c(1,0.5,0),c(0.6,0.3,1))
ground_mat = material=diffuse(color="grey50",
                              checkercolor = "grey20",checkerperiod = 1.5)
#Default path shape is a circle
generate_studio(depth=-0.4,material=ground_mat) |>
  add_object(extruded_path(points = points, width=0.25,
                           material=diffuse(color="red"))) |>
  add_object(sphere(y=3,z=-5,x=2,material=light(intensity=15))) |>
  render_scene(lookat=c(0.3,0.5,0.5),fov=12, width=800,height=800, clamp_value = 10,
               aperture=0.025, samples=16, sample_method="sobol_blue")
#Change the width evenly along the tube
generate_studio(depth=-0.4,material=ground_mat) |>
  add_object(extruded_path(points = points, width=0.25,
                           width_end = 0.5,
                           material=diffuse(color="red"))) |>
  add_object(sphere(y=3,z=-5,x=2,material=light(intensity=15))) |>
  render_scene(lookat=c(0.3,0.5,0.5),fov=12, width=800,height=800, clamp_value = 10,
               aperture=0.025, samples=16, sample_method="sobol_blue")
#Change the width along the full length of the tube
generate_studio(depth=-0.4,material=ground_mat) |>
  add_object(extruded_path(points = points,
                           width=0.25*sinpi(0:72*20/180),
                           material=diffuse(color="red"))) |>
  add_object(sphere(y=3,z=-5,x=2,material=light(intensity=15))) |>
  render_scene(lookat=c(0.3,0.5,0.5),fov=12, width=800,height=800, clamp_value = 10,
               aperture=0.025, samples=16, sample_method="sobol_blue")
#Specify the exact parametric x positions for the width values:
custom_width = data.frame(x=c(0,0.2,0.5,0.8,1), y=c(0.25,0.5,0,0.5,0.25))
generate_studio(depth=-0.4,material=ground_mat) |>
  add_object(extruded_path(points = points,
                           width=custom_width,
                           material=diffuse(color="red"))) |>
  add_object(sphere(y=3,z=-5,x=2,material=light(intensity=15))) |>
  render_scene(lookat=c(0.3,0.5,0.5),fov=12, width=800,height=800, clamp_value = 10,
               aperture=0.025, samples=16, sample_method="sobol_blue")
#Generate a star polygon
angles = seq(360,0,length.out=21)
xx = c(rep(c(1,0.75,0.5,0.75),5),1) * sinpi(angles/180)/4
yy = c(rep(c(1,0.75,0.5,0.75),5),1) * cospi(angles/180)/4
star_polygon = data.frame(x=xx,y=yy)

#Extrude a path using a star polygon
generate_studio(depth=-0.4,material=ground_mat) |>
  add_object(extruded_path(points = points, width=0.5,
                           polygon = star_polygon,
                           material=diffuse(color="red"))) |>
  add_object(sphere(y=3,z=-5,x=2,material=light(intensity=15))) |>
  render_scene(lookat=c(0.3,0.5,1),fov=12, width=800,height=800, clamp_value = 10,
               aperture=0.025, samples=16, sample_method="sobol_blue")
#Specify a circle polygon
angles = seq(360,0,length.out=21)
xx = sinpi(angles/180)/4
yy = cospi(angles/180)/4
circ_polygon = data.frame(x=xx,y=yy)

#Transform from the circle polygon to the star polygon and change the end cap material
generate_studio(depth=-0.4,material=ground_mat) |>
  add_object(extruded_path(points = points, width=0.5,
                           polygon=circ_polygon, polygon_end = star_polygon,
                           material_cap  = diffuse(color="white"),
                           material=diffuse(color="red"))) |>
  add_object(sphere(y=3,z=-5,x=2,material=light(intensity=15))) |>
  render_scene(lookat=c(0.3,0.5,0.5),fov=12, width=800,height=800, clamp_value = 10,
               aperture=0.025, samples=16, sample_method="sobol_blue")
#Add three and a half twists along the path, and make sure the breaks are evenly spaced
generate_studio(depth=-0.4,material=ground_mat) |>
  add_object(extruded_path(points = points, width=0.5, twists = 3.5,
                           polygon=star_polygon, linear_step = TRUE, breaks=360,
                           material_cap  = diffuse(color="white"),
                           material=diffuse(color="red"))) |>
  add_object(sphere(y=3,z=-5,x=2,material=light(intensity=15))) |>
  render_scene(lookat=c(0.3,0.5,0),fov=12, width=800,height=800, clamp_value = 10,
               aperture=0.025, samples=16, sample_method="sobol_blue")
#Smooth the normals for a less sharp appearance:
generate_studio(depth=-0.4,material=ground_mat) |>
  add_object(extruded_path(points = points, width=0.5, twists = 3.5,
                           polygon=star_polygon,
                           linear_step = TRUE, breaks=360,
                           smooth_normals = TRUE,
                           material_cap  = diffuse(color="white"),
                           material=diffuse(color="red"))) |>
  add_object(sphere(y=3,z=-5,x=2,material=light(intensity=15))) |>
  render_scene(lookat=c(0.3,0.5,0),fov=12, width=800,height=800, clamp_value = 10,
               aperture=0.025, samples=16, sample_method="sobol_blue")
#Only generate part of the curve, specified by the u_min and u_max arguments
generate_studio(depth=-0.4,material=ground_mat) |>
  add_object(extruded_path(points = points, width=0.5, twists = 3.5,
                           u_min = 0.2, u_max = 0.8,
                           polygon=star_polygon, linear_step = TRUE, breaks=360,
                           material_cap  = diffuse(color="white"),
                           material=diffuse(color="red"))) |>
  add_object(sphere(y=3,z=-5,x=2,material=light(intensity=15))) |>
  render_scene(lookat=c(0.3,0.5,0),fov=12, width=800,height=800, clamp_value = 10,
               aperture=0.025, samples=16, sample_method="sobol_blue")
#Render a Mobius strip with 1.5 turns
points = list(c(0,0,0),c(0.5,0.5,0),c(0,1,0),c(-0.5,0.5,0))
square_polygon = matrix(c(-1, -0.1, 0,
                           1, -0.1, 0,
                           1,  0.1, 0,
                          -1,  0.1, 0)/10, ncol=3,byrow = T)

generate_studio(depth=-0.2,
               material=diffuse(color = "dodgerblue4", checkercolor = "#002a61",
                                checkerperiod = 1)) |>
 add_object(extruded_path(points = points,  polygon=square_polygon, closed = TRUE,
                          linear_step = TRUE, twists = 1.5, breaks = 720,
                          material = diffuse(noisecolor = "black", noise = 10,
                                             noiseintensity = 10))) |>
 add_object(sphere(y=20,x=0,z=-21,material=light(intensity = 1000))) |>
 render_scene(lookat=c(0,0.5,0), fov=10, samples=16, sample_method = "sobol_blue",
              width = 800, height=800)
#Create a green glass tube with the dielectric priority interface
#and fill it with a purple neon tube light
generate_ground(depth=-0.4,material=diffuse(color="grey50",
                                            checkercolor = "grey20",checkerperiod = 1.5)) |>
  add_object(extruded_path(points = points, width=0.7, linear_step = TRUE,
                           polygon = star_polygon, twists = 2, closed = TRUE,
                           polygon_end = star_polygon, breaks=500,
                           material=dielectric(priority = 1, refraction = 1.2,
                                               attenuation=c(1,0.3,1),
                                               attenuation_intensity=20))) |>
  add_object(extruded_path(points = points, width=0.4, linear_step = TRUE,
                           polygon = star_polygon,twists = 2, closed = TRUE,
                           polygon_end = star_polygon, breaks=500,
                           material=dielectric(priority = 0,refraction = 1))) |>
  add_object(extruded_path(points = points, width=0.05, closed = TRUE,
                           material=light(color="purple", intensity = 5,
                                          importance_sample = FALSE))) |>
  add_object(sphere(y=10,z=-5,x=0,radius=5,material=light(color = "white",intensity = 5))) |>
  render_scene(lookat=c(0,0.5,1),fov=10,
               width=800,height=800, clamp_value = 10,
               aperture=0.025, samples=16, sample_method="sobol_blue")

Extruded Polygon Object

Description

Extruded Polygon Object

Usage

extruded_polygon(
  polygon = NULL,
  x = 0,
  y = 0,
  z = 0,
  plane = "xz",
  top = 1,
  bottom = 0,
  holes = NULL,
  angle = c(0, 0, 0),
  order_rotation = c(1, 2, 3),
  material = diffuse(),
  center = FALSE,
  flip_horizontal = FALSE,
  flip_vertical = FALSE,
  data_column_top = NULL,
  data_column_bottom = NULL,
  scale_data = 1,
  scale = c(1, 1, 1)
)

Arguments

Value

Multiple row tibble describing the extruded polygon in the scene.

Examples

angles = seq(0, 360, by = 36)
xx = rev(c(rep(c(1, 0.5), 5), 1) * sinpi(angles / 180))
yy = rev(c(rep(c(1, 0.5), 5), 1) * cospi(angles / 180))
star_polygon = data.frame(x = xx, y = yy)

generate_ground(
	depth = 0,
	material = diffuse(color = "grey50", checkercolor = "grey20")
) |>
	add_object(extruded_polygon(
		star_polygon,
		top = 0.5,
		bottom = 0,
		material = diffuse(color = "red", sigma = 90)
	)) |>
	add_object(sphere(
		y = 4,
		x = -3,
		z = -3,
		material = light(intensity = 30)
	)) |>
	render_scene(
		parallel = TRUE,
		lookfrom = c(0, 2, 3),
		samples = 16,
		lookat = c(0, 0.5, 0),
		fov = 60
	)

#Now, let's add a hole to the center of the polygon. We'll make the polygon
#hollow by shrinking it, combining it with the normal size polygon,
#and specify with the `holes` argument that everything after `nrow(star_polygon)`
#in the following should be used to draw a hole:

hollow_star = rbind(star_polygon, 0.8 * star_polygon)

generate_ground(
	depth = -0.01,
	material = diffuse(color = "grey50", checkercolor = "grey20")
) |>
	add_object(extruded_polygon(
		hollow_star,
		top = 0.25,
		bottom = 0,
		holes = nrow(star_polygon) + 1,
		material = diffuse(color = "red", sigma = 90)
	)) |>
	add_object(sphere(
		y = 4,
		x = -3,
		z = -3,
		material = light(intensity = 30)
	)) |>
	render_scene(
		parallel = TRUE,
		lookfrom = c(0, 2, 4),
		samples = 16,
		lookat = c(0, 0, 0),
		fov = 30
	)

# Render one in the y-x plane as well by changing the `plane` argument,
# as well as offset it slightly.
generate_ground(
	depth = -0.01,
	material = diffuse(color = "grey50", checkercolor = "grey20")
) |>
	add_object(extruded_polygon(
		hollow_star,
		top = 0.25,
		bottom = 0,
		holes = nrow(star_polygon),
		material = diffuse(color = "red", sigma = 90)
	)) |>
	add_object(extruded_polygon(
		hollow_star,
		top = 0.25,
		bottom = 0,
		y = 1.2,
		z = -1.2,
		holes = nrow(star_polygon) + 1,
		plane = "yx",
		material = diffuse(color = "green", sigma = 90)
	)) |>
	add_object(sphere(y = 4, x = -3, material = light(intensity = 30))) |>
	render_scene(
		parallel = TRUE,
		lookfrom = c(0, 2, 4),
		samples = 16,
		lookat = c(0, 0.9, 0),
		fov = 40
	)

# Now add the zy plane:
generate_ground(
	depth = -0.01,
	material = diffuse(color = "grey50", checkercolor = "grey20")
) |>
	add_object(extruded_polygon(
		hollow_star,
		top = 0.25,
		bottom = 0,
		holes = nrow(star_polygon) + 1,
		material = diffuse(color = "red", sigma = 90)
	)) |>
	add_object(extruded_polygon(
		hollow_star,
		top = 0.25,
		bottom = 0,
		y = 1.2,
		z = -1.2,
		holes = nrow(star_polygon) + 1,
		plane = "yx",
		material = diffuse(color = "green", sigma = 90)
	)) |>
	add_object(extruded_polygon(
		hollow_star,
		top = 0.25,
		bottom = 0,
		y = 1.2,
		x = 1.2,
		holes = nrow(star_polygon) + 1,
		plane = "zy",
		material = diffuse(color = "blue", sigma = 90)
	)) |>
	  add_object(sphere(y = 4, x = 3, material = light(intensity = 30))) |>
     render_scene(
       parallel = TRUE,
       lookfrom = c(4, 2, 4),
       samples = 16,
       lookat = c(0, 0.9, 0),
       fov = 40
     )

#We can also directly pass in sf polygons:
if (length(find.package("spData", quiet = TRUE)) > 0) {
	us_states = spData::us_states
	texas = us_states[us_states$NAME == "Texas", ]
	#Fix no sfc class in us_states geometry data
	class(texas$geometry) = c("list", "sfc")
}

#This uses the raw coordinates, unless `center = TRUE`, which centers the bounding box
#of the polygon at the origin.
generate_ground(
	depth = -0.01,
	material = diffuse(color = "grey50", checkercolor = "grey20")
) |>
	add_object(extruded_polygon(
		texas,
		center = TRUE,
		material = diffuse(color = "#ff2222", sigma = 90)
	)) |>
	add_object(sphere(
		y = 30,
		x = -30,
		radius = 10,
		material = light(color = "lightblue", intensity = 40)
	)) |>
	render_scene(
		parallel = TRUE,
		lookfrom = c(0, 10, -10),
		samples = 16,
		fov = 60
	)

#Here we use the raw coordinates, but offset the polygon manually.
generate_ground(
	depth = -0.01,
	material = diffuse(color = "grey50", checkercolor = "grey20")
) |>
	add_object(extruded_polygon(
		us_states,
		x = 96,
		z = -40,
		top = 2,
		material = diffuse(color = "#ff2222", sigma = 90)
	)) |>
	add_object(sphere(
		y = 30,
		x = -100,
		radius = 10,
		material = light(color = "dodgerblue", intensity = 200)
	)) |>
	add_object(sphere(
		y = 30,
		x = 100,
		radius = 10,
		material = light(color = "orange", intensity = 200)
	)) |>
	render_scene(
		parallel = TRUE,
		lookfrom = c(0, 120, -120),
		samples = 160,
		fov = 20
	)

#We can also set the map the height of each polygon to a column in the sf object,
#scaling it down by the maximum population state.

generate_ground(
	depth = 0,
	material = diffuse(color = "grey50", checkercolor = "grey20", sigma = 90)
) |>
	add_object(extruded_polygon(
		us_states,
		x = 96,
		z = -45,
		data_column_top = "total_pop_15",
		scale_data = 1 / max(us_states$total_pop_15) * 5,
		material = diffuse(color = "#ff2222", sigma = 90)
	)) |>
	add_object(sphere(
		y = 30,
		x = -100,
		z = 60,
		radius = 10,
		material = light(color = "dodgerblue", intensity = 250)
	)) |>
	add_object(sphere(
		y = 30,
		x = 100,
		z = -60,
		radius = 10,
		material = light(color = "orange", intensity = 200)
	)) |>
	render_scene(
		parallel = TRUE,
		lookfrom = c(60, 50, -40),
		lookat = c(0, -5, 0),
		samples = 160,
		fov = 30
	)

Flip Left-Right

Description

Flip Left-Right

Usage

fliplr(x)

Arguments

Value

Flipped matrix

Examples

#Fake example

Flip Up-Down

Description

Flip Up-Down

Usage

flipud(x)

Arguments

Value

Flipped matrix

Examples

#Fake example

Generate Camera Movement

Description

Takes a series of key frame camera positions and smoothly interpolates between them. Generates a data.frame that can be passed to 'render_animation()'.

Usage

generate_camera_motion(
  positions,
  lookats = NULL,
  apertures = 0,
  fovs = 40,
  focal_distances = NULL,
  ortho_dims = NULL,
  camera_ups = NULL,
  type = "spline",
  frames = 30,
  closed = FALSE,
  aperture_linear = TRUE,
  fov_linear = TRUE,
  focal_linear = TRUE,
  ortho_linear = TRUE,
  constant_step = TRUE,
  curvature_adjust = "none",
  curvature_scale = 30,
  offset_lookat = 0,
  damp_motion = FALSE,
  damp_magnitude = 0.1,
  progress = TRUE,
  smooth_orientation = TRUE
)

Arguments

Value

Data frame of camera positions, orientations, apertures, focal distances, and field of views

Examples

#Create and animate flying through a scene on a simulated roller coaster
set.seed(3)
elliplist = list()
ellip_colors = rainbow(8)
for(i in 1:1200) {
  elliplist[[i]] = ellipsoid(x=10*runif(1)-5,y=10*runif(1)-5,z=10*runif(1)-5,
                             angle = 360*runif(3), a=0.1,b=0.05,c=0.1,
                             material=glossy(color=sample(ellip_colors,1)))
}
ellip_scene = do.call(rbind, elliplist)

camera_pos = list(c(0,1,15),c(5,-5,5),c(-5,5,-5),c(0,1,-15))

#Plot the camera path and render from above using the path object:
generate_ground(material=diffuse(checkercolor="grey20"),depth=-10) |>
  add_object(ellip_scene) |>
  add_object(sphere(y=50,radius=10,material=light(intensity=30))) |>
  add_object(path(camera_pos, material=diffuse(color="red"))) |>
  render_scene(lookfrom=c(0,20,0), width=800,height=800,samples=16,
               camera_up = c(0,0,1),
               fov=80)
#Side view
generate_ground(material=diffuse(checkercolor="grey20"),depth=-10) |>
  add_object(ellip_scene) |>
  add_object(sphere(y=50,radius=10,material=light(intensity=30))) |>
  add_object(path(camera_pos, material=diffuse(color="red"))) |>
  render_scene(lookfrom=c(20,0,0),width=800,height=800,samples=16,
                 fov=80)
#View from the start
generate_ground(material=diffuse(checkercolor="grey20"),depth=-10) |>
  add_object(ellip_scene) |>
  add_object(sphere(y=50,radius=10,material=light(intensity=30))) |>
  add_object(path(camera_pos, material=diffuse(color="red"))) |>
  render_scene(lookfrom=c(0,1.5,16),width=800,height=800,samples=16,
                 fov=80)
#Generate Camera movement, setting the lookat position to be same as camera position, but offset
#slightly in front. We'll render 12 frames, but you'd likely want more in a real animation.

camera_motion =  generate_camera_motion(positions = camera_pos, lookats = camera_pos,
                                        offset_lookat = 1, fovs=80, frames=12,
                                        type="bezier")

#This returns a data frame of individual camera positions, interpolated by cubic bezier curves.
camera_motion

#Pass NA filename to plot to the device. We'll keep the path and offset it slightly to see
#where we're going. This results in a "roller coaster" effect.
generate_ground(material=diffuse(checkercolor="grey20"),depth=-10) |>
  add_object(ellip_scene) |>
  add_object(sphere(y=50,radius=10,material=light(intensity=30))) |>
  add_object(obj_model(r_obj(simple_r = TRUE),x=10,y=-10,scale_obj=3, angle=c(0,315,0),
                       material=dielectric(attenuation=c(1,1,0.3)))) |>
  add_object(pig(x=-7,y=10,z=-5,scale=1,angle=c(0,-45,80),emotion="angry")) |>
  add_object(pig(x=0,y=-0.25,z=-15,scale=1,angle=c(0,225,-22), order_rotation = c(3,2,1),
                 emotion="angry", spider=TRUE)) |>
  add_object(path(camera_pos, y=-0.2,material=diffuse(color="red"))) |>
  render_animation(filename = NA, camera_motion = camera_motion, samples=16,
                   sample_method="sobol_blue",
                   clamp_value=10, width=400, height=400)

Generate Cornell Box

Description

Generate Cornell Box

Usage

generate_cornell(
  light = TRUE,
  lightintensity = 5,
  lightcolor = "white",
  lightwidth = 332,
  lightdepth = 343,
  light_position = c(555/2, 554, 555/2),
  sigma = 0,
  leftcolor = "#1f7326",
  rightcolor = "#a60d0d",
  roomcolor = "#bababa",
  importance_sample = TRUE
)

Arguments

Value

Tibble containing the scene description of the Cornell box.

Examples

#Generate and render the default Cornell box.
render_scene(generate_cornell(),
             samples=16,aperture=0, fov=40, ambient_light=FALSE, parallel=TRUE)
#Make a much smaller light in the center of the room.
render_scene(generate_cornell(lightwidth=200,lightdepth=200),
             samples=16,aperture=0, fov=40, ambient_light=FALSE, parallel=TRUE)
#Place a sphere in the middle of the box.
scene = generate_cornell(lightwidth=200,lightdepth=200) |>
  add_object(sphere(x=555/2,y=555/2,z=555/2,radius=555/4))
render_scene(scene, samples=16,aperture=0, fov=40, ambient_light=FALSE, parallel=TRUE)
#Reduce "fireflies" by setting a clamp_value in render_scene()
render_scene(scene, samples=16,aperture=0, fov=40, ambient_light=FALSE,
             parallel=TRUE,clamp_value=3)
# Change the color scheme of the cornell box
generate_cornell(leftcolor="purple", rightcolor="yellow") |>
  render_scene(samples=16,aperture=0, fov=40, ambient_light=FALSE,
               parallel=TRUE,clamp_value=3)

Generate Ground

Description

Generates a large sphere that can be used as the ground for a scene.

Usage

generate_ground(
  depth = -1,
  spheresize = 1000,
  material = diffuse(color = "grey50")
)

Arguments

Value

Single row of a tibble describing the ground.

Examples

#Generate the ground and add some objects
scene = generate_ground(depth=-0.5,
                        material = diffuse(noise=1,noisecolor="blue",noisephase=10)) |>
  add_object(cube(x=0.7,material=diffuse(color="red"),angle=c(0,-15,0))) |>
  add_object(sphere(x=-0.7,radius=0.5,material=dielectric(color="white")))
render_scene(scene, parallel=TRUE,lookfrom=c(0,2,10))

# Make the sphere representing the ground larger and make it a checkered surface.
scene = generate_ground(depth=-0.5, spheresize=10000,
                        material = diffuse(checkercolor="grey20")) |>
  add_object(cube(x=0.7,material=diffuse(color="red"),angle=c(0,-15,0))) |>
  add_object(sphere(x=-0.7,radius=0.5,material=dielectric(color="white")))
render_scene(scene, parallel=TRUE,lookfrom=c(0,1,10))

Generate Rotation Matrix (order)

Description

Generate Rotation Matrix (order)

Usage

generate_rotation_matrix(angles, order_rotation)

Arguments

Value

number

Generate Studio

Description

Generates a curved studio backdrop.

Usage

generate_studio(
  depth = -1,
  distance = -10,
  width = 100,
  height = 100,
  curvature = 8,
  material = diffuse()
)

Arguments

Value

Tibble representing the scene.

Examples

#Generate the ground and add some objects
scene = generate_studio(depth=-1, material = diffuse(color="white")) |>
   add_object(obj_model(r_obj(),y=-0.5,x=0.5, scale=1.2,
                        material=glossy(color="darkred"),angle=c(0,20,0))) |>
   add_object(sphere(x=-0.5,radius=0.5,material=dielectric())) |>
   add_object(sphere(y=3,x=-2,z=-20,material=light(intensity=600)))
render_scene(scene, parallel = TRUE, lookfrom = c(0,2,-10), lookat=c(0,-0.25,0),
             fov = 14, clamp_value = 10, samples = 16)

#Zooming out to show the full default scene
render_scene(scene, parallel=TRUE,lookfrom=c(0,200,-400),clamp_value=10,samples=16)

Generate Translation Matrix

Description

Generate Translation Matrix

Usage

generate_translation_matrix(delta)

Arguments

Value

number

Get Camera

Description

Gets a camera from a 'ray_scene'.

Usage

get_camera(scene, camera = NULL)

Arguments

Value

A 'ray_camera' object.

Examples

scene = generate_ground(material=diffuse(color="grey20")) |>
  add_camera(camera(name = "wide", fov = 55), active = FALSE) |>
  add_camera(camera(name = "main", fov = 35), active = TRUE)

# Returns the active camera.
get_camera(scene)

# Returns a named camera.
get_camera(scene, "wide")

Get an Infinite Light

Description

Get an Infinite Light

Usage

get_infinite_light(scene, name)

Arguments

Value

A 'ray_infinite_light' object.

get_material_enum

Description

get_material_enum

Usage

get_material_enum(material)

get_material_name

Description

get_material_name

Usage

get_material_name(material)

Get Saved Keyframes

Description

Get a dataframe of the saved keyframes (using the interactive renderer) to pass to 'generate_camera_motion()'

Usage

get_saved_keyframes()

Value

Data frame of keyframes

Examples

#This will return an empty data frame if no keyframes have been set.
get_saved_keyframes()

Get time

Description

Get time

Usage

get_time(init = TRUE)

Value

Nothing

Glossy Material

Description

Glossy Material

Usage

glossy(
  color = "white",
  gloss = 1,
  reflectance = 0.05,
  microfacet = "tbr",
  checkercolor = NA,
  checkerperiod = 3,
  noise = 0,
  noisephase = 0,
  noiseintensity = 10,
  noisecolor = "#000000",
  gradient_color = NA,
  gradient_transpose = FALSE,
  gradient_point_start = NA_real_,
  gradient_point_end = NA_real_,
  gradient_type = "hsv",
  image_texture = "",
  image_repeat = 1,
  alpha_texture = "",
  bump_texture = "",
  bump_intensity = 1,
  roughness_texture = "",
  roughness_range = c(1e-04, 0.2),
  roughness_flip = FALSE,
  importance_sample = FALSE
)

Arguments

Value

Single row of a tibble describing the glossy material.

Examples

#Generate a glossy sphere
generate_ground(material=diffuse(sigma=90)) |>
  add_object(sphere(y=0.2,material=glossy(color="#2b6eff"))) |>
  add_object(sphere(y=2.8,material=light())) |>
  render_scene(parallel=TRUE,clamp_value=10,samples=16,sample_method="sobol_blue")
#Change the color of the underlying diffuse layer
generate_ground(material=diffuse(sigma=90)) |>
  add_object(sphere(y=0.2,x=-2.1,material=glossy(color="#fc3d03"))) |>
  add_object(sphere(y=0.2,material=glossy(color="#2b6eff"))) |>
  add_object(sphere(y=0.2,x=2.1,material=glossy(color="#2fed4f"))) |>
  add_object(sphere(y=8,z=-5,radius=3,material=light(intensity=20))) |>
  render_scene(parallel=TRUE,clamp_value=10,samples=16,fov=40,sample_method="sobol_blue")
#Change the amount of gloss
generate_ground(material=diffuse(sigma=90)) |>
  add_object(sphere(y=0.2,x=-2.1,material=glossy(gloss=1,color="#fc3d03"))) |>
  add_object(sphere(y=0.2,material=glossy(gloss=0.5,color="#2b6eff"))) |>
  add_object(sphere(y=0.2,x=2.1,material=glossy(gloss=0,color="#2fed4f"))) |>
  add_object(sphere(y=8,z=-5,radius=3,material=light(intensity=20))) |>
  render_scene(parallel=TRUE,clamp_value=10,samples=16,fov=40,sample_method="sobol_blue")
#Add gloss to a pattern
generate_ground(material=diffuse(sigma=90)) |>
  add_object(sphere(y=0.2,x=-2.1,material=glossy(noise=2,noisecolor="black"))) |>
  add_object(sphere(y=0.2,material=glossy(color="#ff365a",checkercolor="#2b6eff"))) |>
  add_object(sphere(y=0.2,x=2.1,material=glossy(color="blue",gradient_color="#2fed4f"))) |>
  add_object(sphere(y=8,z=-5,radius=3,material=light(intensity=20))) |>
  render_scene(parallel=TRUE,clamp_value=10,samples=16,fov=40,sample_method="sobol_blue")
#Add an R and a fill light (this may look familiar)
generate_ground(material=diffuse()) |>
  add_object(sphere(y=0.2,material=glossy(color="#2b6eff",reflectance=0.05))) |>
  add_object(obj_model(r_obj(simple_r = TRUE),
                       z=-1,y=-0.05,scale=0.45,angle=c(0,180,0),material=diffuse())) |>
  add_object(sphere(y=6,z=-1,radius=4,material=light(intensity=3))) |>
  add_object(sphere(z=-15,material=light(intensity=50))) |>
  render_scene(parallel=TRUE,clamp_value=10,samples=16,sample_method="sobol_blue")

Dense Grid Participating Medium

Description

Density samples are cell centered and trilinearly interpolated. Array indices correspond to x, y, z, with x varying fastest. Outside 'bounds' the medium is vacuum. Inside the bounds, interpolation clamps to the outermost samples.

Usage

grid_medium(
  density,
  sigma_a = 0,
  sigma_s = 1,
  density_scale = 1,
  g = 0,
  bounds = rbind(c(-0.5, -0.5, -0.5), c(0.5, 0.5, 0.5)),
  emission = 0,
  temperature = NULL,
  emission_scale = 1,
  temperature_scale = 1,
  temperature_offset = 0,
  medium_transform = diag(4),
  haze = TRUE,
  haze_density_threshold = NULL
)

Arguments

Value

A reusable 'ray_medium' description.

Examples

if (requireNamespace("ambient", quietly = TRUE)) {
  noise_field = ambient::noise_perlin(
    dim = c(24, 24, 24), frequency = 0.02, octaves = 8, gain = 0.1
  )
  noise_field[noise_field < 0] = 0
  smoke = grid_medium(noise_field, g = 0.2, sigma_a = 10)
  scene = set_medium(cube(), smoke) |>
    add_object(sphere(x = 3, material = light(intensity = 10)))
  render_scene(
    scene, integrator_type = "nee", width = 64, height = 64,
    samples = 4, parallel = FALSE, plot_scene = FALSE
  )
}

Group Objects

Description

Group and transform objects together.

Usage

group_objects(
  scene,
  pivot_point = c(0, 0, 0),
  translate = c(0, 0, 0),
  angle = c(0, 0, 0),
  order_rotation = c(1, 2, 3),
  scale = c(1, 1, 1),
  axis_rotation = NA
)

Arguments

Value

Tibble of grouped object locations and properties.

Examples

#Generate the ground and add some objects
scene = generate_cornell() |>
        add_object(cube(x=555/2,y=555/8,z=555/2,width=555/4)) |>
        add_object(cube(x=555/2,y=555/4+555/16,z=555/2,width=555/8))
render_scene(scene,lookfrom=c(278,278,-800),lookat = c(278,278,0), aperture=0,
             samples=16, fov=50, parallel=TRUE, clamp_value=5)

#Group the entire room and rotate around its center, but keep the cubes in the same place.
scene2 = group_objects(generate_cornell(),
                       pivot_point=c(555/2,555/2,555/2),
                       angle=c(0,30,0)) |>
         add_object(cube(x=555/2,y=555/8,z=555/2,width=555/4)) |>
        add_object(cube(x=555/2,y=555/4+555/16,z=555/2,width=555/8))

render_scene(scene2,lookfrom=c(278,278,-800),lookat = c(278,278,0), aperture=0,
             samples=16, fov=50, parallel=TRUE, clamp_value=5)
#Now group the cubes instead of the Cornell box, and rotate/translate them together
twocubes = cube(x=555/2,y=555/8,z=555/2,width=555/4) |>
           add_object(cube(x=555/2, y=555/4 + 555/16, z=555/2, width=555/8))
scene3 = generate_cornell() |>
         add_object(group_objects(twocubes, translate = c(0,50,0),angle = c(0,45,0),
         pivot_point = c(555/2,0,555/2)))

render_scene(scene3,lookfrom=c(278,278,-800),lookat = c(278,278,0), aperture=0,
             samples=16, fov=50, parallel=TRUE, clamp_value=5)
#Flatten and stretch the cubes together on two axes
scene4 = generate_cornell() |>
         add_object(group_objects(twocubes, translate = c(0,-40,0),
                                  angle = c(0,45,0), scale = c(2,0.5,1),
                                  pivot_point = c(555/2,0,555/2)))

render_scene(scene4,lookfrom=c(278,278,-800),lookat = c(278,278,0), aperture=0,
             samples=16, fov=50, parallel=TRUE, clamp_value=5)
#Add another layer of grouping, including the Cornell box
scene4 |>
  group_objects(pivot_point = c(555/2,555/2,555/2),scale=c(1.5,0.5,0.3), angle=c(-20,0,20)) |>
  render_scene(lookfrom=c(278,278,-800),lookat = c(278,278,0), aperture=0,
             samples=509, fov=50, parallel=TRUE, clamp_value=5)

Hair Material

Description

Hair Material

Usage

hair(
  pigment = 1.3,
  red_pigment = 0,
  color = NA,
  sigma_a = NA,
  eta = 1.55,
  beta_m = 0.3,
  beta_n = 0.3,
  alpha = 2
)

Arguments

Value

Single row of a tibble describing the hair material.

Examples

#Create a hairball
#Generate rendom points on a sphere
lengthval = 0.5
theta = acos(2*runif(10000)-1.0);
phi = 2*pi*(runif(10000))
bezier_list = list()

#Grow the hairs
for(i in 1:length(phi)) {
  pointval = c(sin(theta[i]) * sin(phi[i]),
               cos(theta[i]),
               sin(theta[i]) * cos(phi[i]))
  bezier_list[[i]] = bezier_curve(width=0.01, width_end=0.008,
                                  p1 = pointval,
                                  p2 = (1+(lengthval*0.33))*pointval,
                                  p3 = (1+(lengthval*0.66))*pointval,
                                  p4 = (1+(lengthval)) * pointval,
                                  material=hair(pigment = 0.3, red_pigment = 1.3,
                                                beta_m = 0.3, beta_n= 0.3),
                                  type="flat")
}
hairball = dplyr::bind_rows(bezier_list)

generate_ground(depth=-2,material=diffuse(color="grey20")) |>
  add_object(sphere()) |>
  add_object(hairball) |>
  add_object(sphere(y=20,z=20,radius=5,material=light(color="white",intensity = 100))) |>
  render_scene(samples=16, lookfrom=c(0,3,10),clamp_value = 10,
               fov=20, width=800, height=800)

#Specify the color directly and increase hair roughness
for(i in 1:length(phi)) {
  pointval = c(sin(theta[i]) * sin(phi[i]),
               cos(theta[i]),
               sin(theta[i]) * cos(phi[i]))
  bezier_list[[i]] = bezier_curve(width=0.01, width_end=0.008,
                                  p1 = pointval,
                                  p2 = (1+(lengthval*0.33))*pointval,
                                  p3 = (1+(lengthval*0.66))*pointval,
                                  p4 = (1+(lengthval)) * pointval,
                                  material=hair(color="purple",
                                                beta_m = 0.5, beta_n= 0.5),
                                  type="flat")
}
hairball = dplyr::bind_rows(bezier_list)
generate_ground(depth=-2,material=diffuse(color="grey20")) |>
  add_object(sphere()) |>
  add_object(hairball) |>
  add_object(sphere(y=20,z=20,radius=5,material=light(color="white",intensity = 100))) |>
  render_scene(samples=16, lookfrom=c(0,3,10),clamp_value = 10,
               fov=20, width=800, height=800)

Check for Denoiser Support

Description

Returns TRUE if rayrender was compiled with Open Image Denoise (OIDN) support.

Usage

has_denoiser()

Value

Logical value.

Examples

has_denoiser()

Homogeneous Participating Medium

Description

Describe a medium independently of the surface that contains it. Attach it to closed objects with [set_medium()]. Rendering automatically selects integrator_type = "nee" for scenes containing attached media.

Usage

homogeneous_medium(
  sigma_a = 0,
  sigma_s = 1,
  density_scale = 1,
  g = 0,
  emission = 0,
  temperature = NULL,
  emission_scale = 1,
  temperature_scale = 1,
  temperature_offset = 0,
  medium_transform = diag(4),
  haze = TRUE,
  haze_density_threshold = NULL
)

Arguments

Value

A reusable 'ray_medium' description.

Examples

fog = homogeneous_medium(sigma_s = 5, g = 0.65)
scene = set_medium(cube(width=1.2), fog) |>
add_object(sphere(y=1,x=1,radius=0.3,material=light(intensity=20))) |>
add_object(generate_studio(material=diffuse(color="dodgerblue")	))
render_scene(scene, integrator_type = "nee", sample_method="sobol")

# Foggy cornell box
fog = homogeneous_medium(sigma_s = 0.1, sigma_a = 0.1, g = 0, density_scale = 0.01, temperature = 0)
 scene = generate_cornell(
 lightwidth = 10,
 lightdepth = 10,
 lightintensity = 3000
) |>
 add_object(set_medium(
   cube(x = 555 / 2, y = 555 / 2, z = 555 / 2, width = 554),
   fog
 ))
render_scene(
 scene,
 integrator_type = "nee",
 fov = 40,
 samples = 256
)

Image-Based Infinite Light

Description

Creates an infinite light from an equirectangular environment image. Attach lights with add_infinite_light(). Their radiance adds together in the background, reflections, and illumination of surfaces and volumes.

Usage

infinite_light(filename, intensity = 1, rotation = 0, name = "environment")

Arguments

Details

Infinite lights are scene metadata, like cameras, and do not add geometry or change scene bounds. Grouping geometry does not transform them. add_object() preserves lights when combining scenes and rejects duplicate names. Scene lights suppress automatic fallback illumination, including when all their intensities are zero. An explicit environment_light render argument adds another image light; intensity_env controls that legacy light only. rotate_env and interactive environment rotation rotate all infinite lights together, in addition to each light's own rotation.

Additive lighting lets you keep an existing HDRI and attach independently adjustable fill lights. At each direction, the background radiance is the sum of the lights after applying their intensities and rotations. For example, a cool fill can reveal detail in blue materials under a warm environment. Keep exposure fixed when comparing the result to see the added illumination.

Value

A ray_infinite_light object.

Examples

# Write explicitly linear RGB radiance to EXR, including values greater than 1.
write_environment = function(image) {
  file = tempfile(fileext = ".exr")
  image = rayimage::ray_read_image(
    image,
    normalize = FALSE,
    source_linear = TRUE,
    assume_colorspace = rayimage::CS_SRGB
  )
  rayimage::ray_write_image(image, file, clamp = FALSE)
  file
}

# 1. Add an independently adjustable fill to an existing environment.
# These constant-color maps make the color and brightness changes easy to see.
warm = cool = array(0, c(32, 64, 3))
warm_rgb = c(0.8, 0.3, 0.1)
cool_rgb = c(0.1, 0.3, 0.8)
for (channel in 1:3) {
  warm[,, channel] = warm_rgb[channel]
  cool[,, channel] = cool_rgb[channel]
}
warm_file = write_environment(warm)
cool_file = write_environment(cool)

# The included R logo retains its blue lettering and gray surround.
# The ground and oblique camera reveal contact shadows and the beveled edges.
base_scene = obj_model(r_obj(), scale = 2.5) |>
  add_object(generate_ground(
    depth = -0.96,
    material = diffuse(color = "grey20")
  )) |>
  add_camera(camera(
    lookfrom = c(2.5, 1.2, -6),
    lookat = c(0, -0.05, 0),
    fov = 28,
    aperture = 0
  ))
warm_scene = base_scene |>
  add_infinite_light(infinite_light(warm_file, name = "warm"))
set.seed(724)
render_scene(
  warm_scene,
  width = 600,
  height = 500,
  samples = 128,
  integrator_type = "nee",
  bloom = FALSE
)

# The two lights contribute warm + 0.5 * cool. The extra cool radiance
# lifts the blue lettering and shifts the background color.
# Keep exposure fixed between renders to see both the color and brightness change.
# The same approach adds fill to a photographic HDRI without editing that image.
additive_scene = warm_scene |>
  add_infinite_light(infinite_light(cool_file, intensity = 0.5, name = "cool"))
set.seed(724)
render_scene(
  additive_scene,
  width = 600,
  height = 500,
  samples = 128,
  integrator_type = "nee",
  bloom = FALSE
)

# 2. Warm and cool fills on opposite sides, like two broad studio softboxes.
# Each EXR is dark except for a bright patch above the horizon. The patch is
# one-quarter across the map. Rotations of 30 and 210 degrees put the patches
# on opposite sides. A dim neutral environment keeps the front readable.
u = (seq_len(256) - 0.5) / 256
v = (seq_len(128) - 0.5) / 128
# Longitude wraps around: keep the softbox continuous at the EXR's edges.
du = ((u - 0.25 + 0.5) %% 1) - 0.5
softbox = outer(
  exp(-((v - 0.32) / 0.18)^2),
  exp(-(du / 0.12)^2)
)
warm_side = cool_side = array(0, c(128, 256, 3))
for (channel in 1:3) {
  warm_side[,, channel] = 8 * warm_rgb[channel] * softbox
  cool_side[,, channel] = 8 * cool_rgb[channel] * softbox
}
neutral_file = write_environment(array(0.08, c(32, 64, 3)))
warm_side_file = write_environment(warm_side)
cool_side_file = write_environment(cool_side)
fill_scene = base_scene |>
  add_infinite_light(infinite_light(neutral_file, name = "neutral")) |>
  add_infinite_light(infinite_light(
    warm_side_file,
    rotation = 30,
    name = "warm_fill"
  )) |>
  add_infinite_light(infinite_light(
    cool_side_file,
    rotation = 210,
    intensity = 0.75,
    name = "cool_fill"
  ))
set.seed(724)
render_scene(
  fill_scene,
  width = 600,
  height = 500,
  samples = 128,
  integrator_type = "nee",
  bloom = FALSE
)

# Change either fill's intensity or rotation independently to shape the lighting.
# This gives independent control over both sides while retaining the base light.

Print time

Description

Print time

Usage

init_time()

Value

Nothing

Determines if rendering in knitr

Description

Determines if rendering in knitr

Usage

is_rendering_in_knitr()

Value

boolean

Lambertian Material (deprecated)

Description

Lambertian Material (deprecated)

Usage

lambertian(...)

Arguments

Value

Single row of a tibble describing the diffuse material.

Examples

#Deprecated lambertian material. Will display a warning.
scene = generate_cornell() |>
  add_object(sphere(x=555/2,y=555/2,z=555/2,radius=555/8,material=lambertian()))
  render_scene(scene, lookfrom=c(278,278,-800),lookat = c(278,278,0), samples=16,
             aperture=0, fov=40, ambient_light=FALSE, parallel=TRUE)

Lerp

Description

Lerp

Usage

lerp(t, v1, v2)

Arguments

Value

Linearly interpolated value

Light Material

Description

Light Material

Usage

light(
  color = "#ffffff",
  intensity = 10,
  importance_sample = TRUE,
  spotlight_focus = NA,
  spotlight_width = 30,
  spotlight_start_falloff = 15,
  invisible = FALSE,
  image_texture = "",
  image_repeat = 1,
  gradient_color = NA,
  gradient_transpose = FALSE,
  gradient_point_start = NA,
  gradient_point_end = NA,
  gradient_type = "hsv"
)

Arguments

Value

Single row of a tibble describing the light material.

Examples

#Generate the cornell box without a light and add a single white sphere to the center
scene = generate_cornell(light=FALSE) |>
  add_object(sphere(x=555/2,y=555/2,z=555/2,radius=555/8,material=light()))
render_scene(scene, lookfrom=c(278,278,-800),lookat = c(278,278,0), samples=16,
             aperture=0, fov=40, ambient_light=FALSE, parallel=TRUE)

#Remove the light for direct camera rays, but keep the lighting
scene = generate_cornell(light=FALSE) |>
  add_object(sphere(x=555/2,y=555/2,z=555/2,radius=555/8,
             material=light(intensity=15,invisible=TRUE)))
render_scene(scene, lookfrom=c(278,278,-800),lookat = c(278,278,0), samples=16,
             aperture=0, fov=40, ambient_light=FALSE, parallel=TRUE)

#All gather around the orb
scene = generate_ground(material = diffuse(checkercolor="grey50")) |>
  add_object(sphere(radius=0.25,material=light(intensity=90,color="#f11"))) |>
  add_object(obj_model(r_obj(), scale=2.5,z=-3,x=-1.25,y=0, angle=c(0,235,0))) |>
  add_object(pig(scale=0.3, x=1.5,z=-2,y=-1.5,angle=c(0,-135,0)))
render_scene(scene, samples=16, parallel=TRUE, clamp_value=10, lookfrom=c(0,0,10))

List Cameras

Description

Lists cameras attached to a 'ray_scene'.

Usage

list_cameras(scene)

Arguments

Value

A data frame with one row per camera.

Examples

scene = generate_ground(material=diffuse(color="grey20")) |>
  add_camera(camera(name = "wide", fov = 55, filename = "wide.png")) |>
  add_camera(camera(name = "detail", fov = 20, filename = "detail.png"))

list_cameras(scene)

List Infinite Lights

Description

List Infinite Lights

Usage

list_infinite_lights(scene)

Arguments

Value

A named list of 'ray_infinite_light' objects.

'mesh3d' model

Description

Load an 'mesh3d' (or 'shapelist3d') object, as specified in the 'rgl' package.

Usage

mesh3d_model(
  mesh,
  x = 0,
  y = 0,
  z = 0,
  swap_yz = FALSE,
  reverse = FALSE,
  subdivision_levels = 1,
  verbose = FALSE,
  displacement_texture = "",
  displacement_intensity = 1,
  displacement_vector = FALSE,
  recalculate_normals = FALSE,
  override_material = FALSE,
  material = diffuse(),
  angle = c(0, 0, 0),
  order_rotation = c(1, 2, 3),
  flipped = FALSE,
  scale = c(1, 1, 1)
)

Arguments

Value

Single row of a tibble describing the mesh3d model in the scene.

Examples

#Load a mesh3d object (from the Rvcg) and render it:
  library(Rvcg)
  data(humface)

  generate_studio() |>
    add_object(mesh3d_model(humface,y=-0.3,x=0,z=0,
                          material=glossy(color="dodgerblue4"), scale = 1/70,
                          angle = c(0,180,0))) |>
    add_object(sphere(y=5,x=5,z=-5,material=light(intensity=50))) |>
    render_scene(samples=16,width=800,height=800,
                 lookat = c(0,0.5,1), aperture=0.0)

Metallic Material

Description

Metallic Material

Usage

metal(
  color = "#ffffff",
  eta = 0,
  kappa = 0,
  fuzz = 0,
  checkercolor = NA,
  checkerperiod = 3,
  noise = 0,
  noisephase = 0,
  noiseintensity = 10,
  noisecolor = "#000000",
  gradient_color = NA,
  gradient_transpose = FALSE,
  gradient_point_start = NA,
  gradient_point_end = NA,
  gradient_type = "hsv",
  image_texture = "",
  image_repeat = 1,
  alpha_texture = "",
  bump_texture = "",
  bump_intensity = 1,
  importance_sample = FALSE
)

Arguments

Value

Single row of a tibble describing the metallic material.

Examples

# Generate the cornell box with a single chrome sphere in the center. For other metals,
# See the website refractiveindex.info for eta and k data, use wavelengths 5
# 80nm (R), 530nm (G), and 430nm (B).
scene = generate_cornell() |>
  add_object(sphere(x=555/2,y=555/2,z=555/2,radius=555/8,
  material=metal(eta=c(3.2176,3.1029,2.1839), k = c(3.3018,3.33,3.0339))))
render_scene(scene, lookfrom=c(278,278,-800),lookat = c(278,278,0), samples=16,
             aperture=0, fov=40, ambient_light=FALSE, parallel=TRUE)
#Add an aluminum rotated shiny metal block
scene = scene |>
  add_object(cube(x=380,y=150/2,z=200,xwidth=150,ywidth=150,zwidth=150,
  material = metal(eta = c(1.07,0.8946,0.523), k = c(6.7144,6.188,4.95)),angle=c(0,45,0)))
render_scene(scene, lookfrom=c(278,278,-800),lookat = c(278,278,0), samples=16,
             aperture=0, fov=40, ambient_light=FALSE, parallel=TRUE)
#Add a copper metal cube
scene = scene |>
  add_object(cube(x=150,y=150/2,z=300,xwidth=150,ywidth=150,zwidth=150,
                  material = metal(eta = c(0.497,0.8231,1.338),
                                   k = c(2.898,2.476,2.298)),
                  angle=c(0,-30,0)))
render_scene(scene, lookfrom=c(278,278,-800),lookat = c(278,278,0), samples=16,
             aperture=0, fov=40, ambient_light=FALSE, parallel=TRUE)

#Finally, let's add a lead pipe
scene2 = scene |>
  add_object(cylinder(x=450,y=200,z=400,length=400,radius=30,
                  material = metal(eta = c(1.44,1.78,1.9),
                                   k = c(3.18,3.36,3.43)),
                  angle=c(0,-30,0)))
render_scene(scene2, lookfrom=c(278,278,-800),lookat = c(278,278,0), samples=16,
             aperture=0, fov=40, ambient_light=FALSE, parallel=TRUE)

Microfacet Material

Description

Microfacet Material

Usage

microfacet(
  color = "white",
  roughness = 1e-04,
  transmission = FALSE,
  eta = 0,
  kappa = 0,
  microfacet = "tbr",
  checkercolor = NA,
  checkerperiod = 3,
  noise = 0,
  noisephase = 0,
  noiseintensity = 10,
  noisecolor = "#000000",
  gradient_color = NA,
  gradient_transpose = FALSE,
  gradient_point_start = NA_real_,
  gradient_point_end = NA_real_,
  gradient_type = "hsv",
  image_texture = "",
  image_repeat = 1,
  alpha_texture = "",
  bump_texture = "",
  bump_intensity = 1,
  roughness_texture = "",
  roughness_range = c(1e-04, 0.2),
  roughness_flip = FALSE,
  importance_sample = FALSE
)

Arguments

Value

Single row of a tibble describing the microfacet material.

Examples

# Generate a golden egg, using eta and kappa taken from physical measurements
# See the website refractiveindex.info for eta and k data, use
# wavelengths 580nm (R), 530nm (G), and 430nm (B).
generate_cornell() |>
  add_object(ellipsoid(x=555/2,555/2,y=150, a=100,b=150,c=100,
             material=microfacet(roughness=0.1,
                                 eta=c(0.216,0.42833,1.3184), kappa=c(3.239,2.4599,1.8661)))) |>
 render_scene(lookfrom=c(278,278,-800),lookat = c(278,278,0), samples=16,
             aperture=0, fov=40, parallel=TRUE,clamp_value=10)
#Make the roughness anisotropic (either horizontal or vertical), adding an extra light in front
#to show off the different microfacet orientations
generate_cornell() |>
  add_object(sphere(x=555/2,z=50,y=75,radius=20,material=light())) |>
  add_object(ellipsoid(x=555-150,555/2,y=150, a=100,b=150,c=100,
             material=microfacet(roughness=c(0.3,0.1),
                                 eta=c(0.216,0.42833,1.3184), kappa=c(3.239,2.4599,1.8661)))) |>
 add_object(ellipsoid(x=150,555/2,y=150, a=100,b=150,c=100,
             material=microfacet(roughness=c(0.1,0.3),
                                 eta=c(0.216,0.42833,1.3184), kappa=c(3.239,2.4599,1.8661)))) |>
 render_scene(lookfrom=c(278,278,-800),lookat = c(278,278,0), samples=16,
             aperture=0, fov=40,  parallel=TRUE,clamp_value=10)
#Render a rough silver R with a smaller golden egg in front
generate_cornell() |>
  add_object(obj_model(r_obj(simple_r = TRUE),
                       x=555/2,z=350,y=0, scale_obj = 200, angle=c(0,200,0),
             material=microfacet(roughness=0.2,
                                 eta=c(1.1583,0.9302,0.5996), kappa=c(6.9650,6.396,5.332)))) |>
 add_object(ellipsoid(x=200,z=200,y=80, a=50,b=80,c=50,
             material=microfacet(roughness=0.1,
                                 eta=c(0.216,0.42833,1.3184), kappa=c(3.239,2.4599,1.8661)))) |>
 render_scene(lookfrom=c(278,278,-800),lookat = c(278,278,0), samples=16,
             aperture=0, fov=40, parallel=TRUE,clamp_value=10)
#Increase the roughness
generate_cornell() |>
  add_object(obj_model(r_obj(simple_r = TRUE),
                       x=555/2,z=350,y=0, scale_obj = 200, angle=c(0,200,0),
             material=microfacet(roughness=0.5,
                                 eta=c(1.1583,0.9302,0.5996), kappa=c(6.9650,6.396,5.332)))) |>
 add_object(ellipsoid(x=200,z=200,y=80, a=50,b=80,c=50,
             material=microfacet(roughness=0.3,
                                 eta=c(0.216,0.42833,1.3184), kappa=c(3.239,2.4599,1.8661)))) |>
 render_scene(lookfrom=c(278,278,-800),lookat = c(278,278,0), samples=16,
             aperture=0, fov=40, parallel=TRUE,clamp_value=10)
 #Use transmission for a rough dielectric
generate_cornell() |>
  add_object(obj_model(r_obj(simple_r = TRUE),
                       x=555/2,z=350,y=0, scale_obj = 200, angle=c(0,200,0),
             material=microfacet(roughness=0.3, transmission=T, eta=1.6))) |>
 add_object(ellipsoid(x=200,z=200,y=80, a=50,b=80,c=50,
             material=microfacet(roughness=0.3, transmission=T, eta=1.6))) |>
 render_scene(lookfrom=c(278,278,-800),lookat = c(278,278,0), samples=64,
             aperture=0, fov=40, parallel=TRUE,clamp_value=10, min_variance=1e-6)

NanoVDB Participating Medium

Description

Read uncompressed float grids from a NanoVDB file. Native grid coordinates and transforms are retained; use 'medium_transform' to place them inside the boundary. Convert OpenVDB or compressed NanoVDB files externally before use.

Usage

nanovdb_medium(
  filename,
  sigma_a = 0,
  sigma_s = 1,
  density_scale = 1,
  g = 0,
  density_grid = "density",
  temperature_grid = NULL,
  emission = 0,
  emission_scale = 1,
  temperature_scale = 1,
  temperature_offset = 0,
  medium_transform = diag(4),
  haze = TRUE,
  haze_density_threshold = NULL
)

Arguments

Value

A reusable 'ray_medium' description. Files are loaded during scene construction.

New Tibble Row

Description

Creates a row of a tibble, without the parsing and checks in tibble::new_tibble(). Internal use only.

Usage

new_tibble_row(x)

Arguments

Value

Tibble row.

Examples

#none

Find the next available preview snapshot filename

Description

Find the next available preview snapshot filename

Usage

next_preview_snapshot_filename(filename = NA_character_)

Arguments

Value

An available filename for a preview snapshot.

'obj' File Object

Description

Load an obj file via a filepath. Currently only supports the diffuse texture with the 'texture' argument. Note: light importance sampling currently not supported for this shape.

Usage

obj_model(
  filename,
  x = 0,
  y = 0,
  z = 0,
  scale_obj = 1,
  load_material = TRUE,
  load_textures = TRUE,
  load_normals = TRUE,
  vertex_colors = FALSE,
  calculate_consistent_normals = TRUE,
  subdivision_levels = 1,
  displacement_texture = "",
  displacement_intensity = 1,
  displacement_vector = FALSE,
  recalculate_normals = FALSE,
  importance_sample_lights = TRUE,
  material = diffuse(),
  angle = c(0, 0, 0),
  order_rotation = c(1, 2, 3),
  flipped = FALSE,
  scale = c(1, 1, 1)
)

Arguments

Value

Single row of a tibble describing the obj model in the scene.

Examples

#Load the included example R object file, by calling the r_obj() function. This
#returns the local file path to the `r.txt` obj file. The file extension is "txt"
#due to package constraints, but the file contents are identical and it does not
#affect the function.

#Load the basic 3D R logo with the included materials
generate_ground(material = diffuse(checkercolor = "grey50")) |>
  add_object(obj_model(y = 0.2, filename = rayrender::r_obj(),
                       scale_obj=3)) |>
   add_object(sphere(z = -20, x = 20, y = 20, radius = 10,
                     material = light(intensity = 10))) |>
  render_scene(parallel = TRUE, samples = 16, aperture = 0.05,
               sample_method="sobol_blue",
               fov = 20, lookfrom = c(0, 2, -10))

# Smooth a mesh by setting the number of subdivision levels
generate_ground(material = diffuse(checkercolor = "grey50")) |>
  add_object(obj_model(y = 0.2, filename = rayrender::r_obj(),
                       scale_obj=3, subdivision_levels = 3)) |>
   add_object(sphere(z = -20, x = 20, y = 20, radius = 10,
                     material = light(intensity = 10))) |>
  render_scene(parallel = TRUE, samples = 16, aperture = 0.05,
               sample_method="sobol_blue",
               fov = 20, lookfrom = c(0, 2, -10))

#Override the materials for each object
generate_ground(material = diffuse(checkercolor = "grey50")) |>
  add_object(obj_model(y = 1.4, filename = rayrender::r_obj(), load_material = FALSE,
                       scale_obj = 1.8, angle=c(10,0,0),
                       material = microfacet(color = "gold", roughness = 0.2))) |>
  add_object(obj_model(x = 0.9, y = 0, filename = rayrender::r_obj(), load_material = FALSE,
                       scale_obj = 1.8, angle=c(0,20,0),
                       material = diffuse(color = "dodgerblue"))) |>
  add_object(obj_model(x = -0.9, y = 0, filename = rayrender::r_obj() , load_material = FALSE,
                       scale_obj = 1.8, angle=c(0,-40,0),
                       material = dielectric(attenuation = c(1,0.3,1), priority = 1,
                                             attenuation_intensity = 20))) |>
  add_object(sphere(z = -20, x = 20, y = 20, radius = 10,
                    material = light(intensity = 10))) |>
  render_scene(parallel = TRUE, samples = 16, aperture = 0.05,
               sample_method="sobol_blue", lookat=c(0,0.5,0),
               fov = 22, lookfrom = c(0, 2, -10))

Path Object

Description

Either a closed or open path made up of bezier curves that go through the specified points (with continuous first and second derivatives), or straight line segments.

Usage

path(
  points,
  x = 0,
  y = 0,
  z = 0,
  closed = FALSE,
  closed_smooth = TRUE,
  straight = FALSE,
  precomputed_control_points = FALSE,
  width = 0.1,
  width_end = NA,
  u_min = 0,
  u_max = 1,
  type = "cylinder",
  normal = c(0, 0, -1),
  normal_end = NA,
  material = diffuse(),
  angle = c(0, 0, 0),
  order_rotation = c(1, 2, 3),
  flipped = FALSE,
  scale = c(1, 1, 1)
)

Arguments

Value

Single row of a tibble describing the cube in the scene.

Examples

#Generate a wavy line, showing the line goes through the specified points:
wave = list(c(-2,1,0),c(-1,-1,0),c(0,1,0),c(1,-1,0),c(2,1,0))
point_mat = glossy(color="green")
generate_studio(depth=-1.5) |>
  add_object(path(points = wave,material=glossy(color="red"))) |>
  add_object(sphere(x=-2,y=1,radius=0.1,material=point_mat)) |>
  add_object(sphere(x=-1,y=-1,radius=0.1,material=point_mat)) |>
  add_object(sphere(x=0,y=1,radius=0.1,material=point_mat)) |>
  add_object(sphere(x=1,y=-1,radius=0.1,material=point_mat)) |>
  add_object(sphere(x=2,y=1,radius=0.1,material=point_mat)) |>
  add_object(sphere(z=-5,x=5,y=5,radius=2,material=light(intensity=15))) |>
  render_scene(samples=16, clamp_value=10,fov=30)
#Here we use straight lines by setting `straight = TRUE`:
generate_studio(depth=-1.5) |>
  add_object(path(points = wave,straight = TRUE, material=glossy(color="red"))) |>
  add_object(sphere(z=-5,x=5,y=5,radius=2,material=light(intensity=15))) |>
  render_scene(samples=16, clamp_value=10,fov=30)
#We can also pass a matrix of values, specifying the x/y/z coordinates. Here,
#we'll create a random curve:
set.seed(21)
random_mat = matrix(runif(3*9)*2-1, ncol=3)
generate_studio(depth=-1.5) |>
  add_object(path(points=random_mat, material=glossy(color="red"))) |>
  add_object(sphere(y=5,radius=1,material=light(intensity=30))) |>
  render_scene(samples=16, clamp_value=10)
#We can ensure the curve is closed by setting `closed = TRUE`
generate_studio(depth=-1.5) |>
  add_object(path(points=random_mat, closed = TRUE, material=glossy(color="red"))) |>
  add_object(sphere(y=5,radius=1,material=light(intensity=30))) |>
  render_scene(samples=16, clamp_value=10)
#Finally, let's render a pretzel to show how you can render just a subset of the curve:
pretzel = list(c(-0.8,-0.5,0.1),c(0,-0.2,-0.1),c(0,0.3,0.1),c(-0.5,0.5,0.1), c(-0.6,-0.5,-0.1),
               c(0,-0.8,-0.1),
               c(0.6,-0.5,-0.1),c(0.5,0.5,-0.1), c(0,0.3,-0.1),c(-0,-0.2,0.1), c(0.8,-0.5,0.1))

#Render the full pretzel:
generate_studio(depth = -1.1) |>
  add_object(path(pretzel, width=0.17,  material = glossy(color="#db5b00"))) |>
  add_object(sphere(y=5,x=2,z=-4,material=light(intensity=20,spotlight_focus = c(0,0,0)))) |>
  render_scene(samples=16, clamp_value=10)
#Here, we'll render only the first third of the pretzel by setting `u_max = 0.33`
generate_studio(depth = -1.1) |>
  add_object(path(pretzel, width=0.17, u_max=0.33, material = glossy(color="#db5b00"))) |>
  add_object(sphere(y=5,x=2,z=-4,material=light(intensity=20,spotlight_focus = c(0,0,0)))) |>
  render_scene(samples=16, clamp_value=10)
#Here's the last third, by setting `u_min = 0.66`
generate_studio(depth = -1.1) |>
  add_object(path(pretzel, width=0.17, u_min=0.66, material = glossy(color="#db5b00"))) |>
  add_object(sphere(y=5,x=2,z=-4,material=light(intensity=20,spotlight_focus = c(0,0,0)))) |>
  render_scene(samples=16, clamp_value=10)
#Here's the full pretzel, decomposed into thirds using the u_min and u_max coordinates
generate_studio(depth = -1.1) |>
  add_object(path(pretzel, width=0.17, u_max=0.33, x = -0.8, y =0.6,
                  material = glossy(color="#db5b00"))) |>
  add_object(path(pretzel, width=0.17, u_min=0.66, x = 0.8, y =0.6,
                  material = glossy(color="#db5b00"))) |>
  add_object(path(pretzel, width=0.17, u_min=0.33, u_max=0.66, x=0,
                  material = glossy(color="#db5b00"))) |>
  add_object(sphere(y=5,x=2,z=-4,material=light(intensity=20,spotlight_focus = c(0,0,0)))) |>
  render_scene(samples=16, clamp_value=10, lookfrom=c(0,3,-10))

Pig Object

Description

Builds an earless, low-poly mesh pig from compact data included in rayrender. The skiing outfit includes goggles, a scarf and skis; the spider variant has eight legs, four eyes and procedural copper-colored hair curves.

Usage

pig(
  x = 0,
  y = 0,
  z = 0,
  emotion = "neutral",
  spider = FALSE,
  angle = c(0, 0, 0),
  order_rotation = c(1, 2, 3),
  scale = c(1, 1, 1),
  diffuse_sigma = 0,
  ski = FALSE,
  hair_count = 12000,
  hair_length = 1,
  hair_seed = 8,
  hair_material = NULL
)

Arguments

Details

Geometry, expression heads and the ski pose are assembled in memory; no OBJ paths, downloads, Blender or rgl installation are required. The character faces +X, uses Y up, and retains the rotation/scale pivot at c(0, 1, 0). Feet or skis rest approximately at y - 0.6 before rotation and scaling. The mask and goggles can obscure eyebrows in skiing poses. Hair uses tapered bezier_curve() objects with hair() materials. A finite bounce limit, such as max_depth = 12, is useful for dense fur.

Value

A scene tibble containing mesh objects and, for a hairy spider, curves.

Examples

generate_ground(depth = -0.6) |>
  add_object(pig()) |>
  render_scene(lookfrom = c(8, 5, 8), lookat = c(0, 1, 0), samples = 64)

generate_ground(depth = -0.6, material = glossy(color="white")) |>
  add_object(pig(ski = TRUE)) |>
  render_scene(lookfrom = c(8, 5, 8),
               lookat = c(0, 1, 0),
               fov=40,samples = 64)

generate_ground(depth = -0.6) |>
  add_object(pig(spider = TRUE)) |>
  render_scene(lookfrom = c(10, 7, 8), lookat = c(0, 1, 0),
               samples = 64, max_depth = 12)

'ply' File Object

Description

Load an PLY file via a filepath. Note: light importance sampling currently not supported for this shape.

Usage

ply_model(
  filename,
  x = 0,
  y = 0,
  z = 0,
  scale_ply = 1,
  subdivision_levels = 1,
  recalculate_normals = FALSE,
  material = diffuse(),
  angle = c(0, 0, 0),
  order_rotation = c(1, 2, 3),
  flipped = FALSE,
  scale = c(1, 1, 1)
)

Arguments

Value

Single row of a tibble describing the obj model in the scene.

Examples

#See the documentation for `obj_model()`--no example PLY models are included with this package,
#but the process of loading a model is the same (without support for vertex colors).

Post-process Frame

Description

Post-process Frame

Usage

post_process_frame(
  rgb_mat,
  debug_channel,
  filename,
  tonemap,
  bloom = TRUE,
  transparent_background = FALSE,
  write_file = TRUE,
  plot_scene = TRUE
)

Value

Nothing

Post-process the scene

Description

Post-process the scene

Usage

post_process_scene(
  rgb_mat,
  iso,
  use_iso,
  tonemap,
  debug_channel,
  filename,
  plot_scene,
  bloom,
  new_page = TRUE,
  transparent_background = FALSE,
  auto_exposure = FALSE,
  verbose = FALSE,
  screen_text = NULL,
  screen_line = NULL,
  camera_info = NULL,
  screen_text_visible = NULL,
  screen_text_overlay = NULL,
  screen_line_visible = NULL,
  screen_line_overlay = NULL,
  exposure_adjustment = 1
)

Examples

#internal

Prepare environment light white balance

Description

Prepare environment light white balance

Usage

prepare_environment_light_white_balance(
  environment_light,
  environment_light_bake_white = FALSE,
  environment_light_bake_white_target = "D65"
)

Arguments

Value

A list with 'environment_light' and 'cleanup' entries.

Prepare the scene list

Description

Prepare the scene list

Usage

prepare_scene_list(
  scene,
  width = 400,
  height = 400,
  fov = 20,
  lookfrom = c(0, 1, 10),
  lookat = c(0, 0, 0),
  camera_up = c(0, 1, 0),
  samples = 100,
  camera_description_file = NA,
  camera_scale = 1,
  iso = 100,
  film_size = 22,
  min_variance = 5e-05,
  min_adaptive_size = 8,
  sample_method = "sobol",
  max_depth = NA,
  roulette_active_depth = 100,
  ambient_light = FALSE,
  aperture = 0.1,
  clamp_value = Inf,
  filename = NA,
  backgroundhigh = "#80b4ff",
  backgroundlow = "#ffffff",
  shutteropen = 0,
  shutterclose = 1,
  camera_motion_blur = FALSE,
  shutter_speed = 2,
  focal_distance = NULL,
  ortho_dimensions = c(1, 1),
  tonemap = "gamma",
  bloom = TRUE,
  parallel = TRUE,
  bvh_type = "sah",
  environment_light = NULL,
  rotate_env = 0,
  intensity_env = 1,
  debug_channel = "none",
  plot_scene = TRUE,
  progress = interactive(),
  verbose = FALSE,
  sample_dist = Inf,
  keep_colors = FALSE,
  deferred_render = FALSE,
  integrator_type = "nee",
  denoise = TRUE,
  print_debug_info = FALSE
)

Examples

#internal

Preview Camera

Description

Previews a scene-attached camera without writing image files.

Usage

preview_camera(
  scene,
  camera = NULL,
  width = 800,
  height = 800,
  fps = 24,
  samples = 1,
  ...
)

Arguments

Value

Invisibly returns the rendered preview result.

Examples

#Zooming over the R logo
motion = generate_camera_motion(
  positions = list(c(0, 1, -10), c(0, 1, -2), c(0, 1, 10)),
  lookats = list(c(0, 0, 0), c(0, 0.5, 0), c(0, 0, 0)),
  fovs = c(60, 45, 90),
  frames = 24,
  type = "linear",
  damp_motion = TRUE,
  closed = TRUE
)

scene = generate_ground(material=diffuse(color="grey20")) |>
  add_object(obj_model(r_obj())) |>
  add_object(sphere(y=10,x=-10,z=-5,material=light(intensity=100))) |>
  add_camera(camera(name = "flythrough", motion = motion))

preview_camera(scene, camera = "flythrough", width = 400, height = 400)

Print time

Description

Print time

Usage

print_time(verbose = FALSE, message_text = "")

Value

Nothing

Process Points to Control Points

Description

Process Points to Control Points

Usage

process_point_series(points, closed = FALSE, straight = FALSE)

Arguments

Value

Matrix of control points

Process Points to Control Points

Description

Process Points to Control Points

Usage

process_point_series_1d(values, closed = FALSE, straight = FALSE)

Arguments

Value

Matrix of control points

Process Points to Control Points

Description

Process Points to Control Points

Usage

process_point_series_2d(values, closed = FALSE, straight = FALSE)

Arguments

Value

Matrix of control points

Process a scene

Description

Process a scene

Usage

process_scene(scene, process_material_ids = TRUE)

Quad-in-out

Description

Quad-in-out

Usage

quadInOut(t)

Arguments

Value

number

R 3D Model

Description

3D obj model of R logo (created from the R SVG logo with the 'raybevel' package), to be used with 'obj_model()'

Usage

r_obj(simple_r = FALSE)

Arguments

Value

File location of the 3d_r_logo.obj file (saved with a .txt extension)

Examples

#Load and render the included example R object file.
generate_ground(material = diffuse(noise = TRUE, noisecolor = "grey20")) |>
  add_object(sphere(x = 2, y = 3, z = -2, radius = 1,
                    material = light(intensity = 10))) |>
  add_object(obj_model(r_obj(), scale=2.5, angle = c(0,0,0), material = diffuse(color="red"))) |>
  render_scene(parallel=TRUE, lookfrom = c(0, 1, -10), clamp_value = 5, samples = 200)

Internal vctrs methods

Description

list(start_transform_animation = list(matrix(4x4) OR ..NA_real..), end_transform_animation = list(matrix(4x4 OR ..NA_real..)), start_time = numeric(1), end_time = numeric(1))

Usage

ray_animated_transform(...)

Value

ray_animated_transform

Internal vctrs methods

Description

Internal vctrs methods

Constructor for ray_material

Usage

ray_material(...)

Value

ray_material

Constructor for ray_material

Description

Constructor for ray_material

Usage

ray_scene(...)

Value

ray

Internal vctrs methods

Description

list(angle = list(numeric(3)), order_rotation = list(numeric(3)), scale_factor = list(numeric(3)), group_transform = list(matrix(4x4) ..OR.. NA_real))

Usage

ray_shape_info(...)

Value

ray_transform

Internal vctrs methods

Description

list(angle = list(numeric(3)), order_rotation = list(numeric(3)), scale_factor = list(numeric(3)), group_transform = list(matrix(4x4) ..OR.. NA_real))

Usage

ray_transform(...)

Value

ray_transform

'raymesh' model

Description

Load an 'raymesh' object, as specified in the 'rayvertex' package.

Usage

raymesh_model(
  mesh,
  x = 0,
  y = 0,
  z = 0,
  flip_transmittance = TRUE,
  verbose = FALSE,
  importance_sample_lights = FALSE,
  calculate_consistent_normals = TRUE,
  subdivision_levels = 1,
  displacement_texture = "",
  displacement_intensity = 1,
  displacement_vector = FALSE,
  recalculate_normals = FALSE,
  override_material = NULL,
  material = diffuse(),
  angle = c(0, 0, 0),
  order_rotation = c(1, 2, 3),
  flipped = FALSE,
  scale = c(1, 1, 1),
  validate_mesh = TRUE
)

Arguments

Value

Single row of a tibble describing the raymesh model in the scene.

Examples

#Render a simple raymesh object
library(rayvertex)
raymesh_model(sphere_mesh(position = c(-1, 0, 0),
              material = material_list(transmittance = "red"))) |>
  add_object(generate_ground(material = diffuse(checkercolor="grey20"))) |>
  render_scene(fov = 30, samples=16, sample_method="sobol_blue")

# We create a complex rayvertex mesh, using the `rayvertex::add_shape` function which
# creates a new `raymesh` object out of individual `raymesh` objects
rm_scene = sphere_mesh(position = c(-1, 0, 0),
            material = material_list(transmittance = "red")) |>
    add_shape(sphere_mesh(position = c(1, 0, 0),
            material = material_list(transmittance = "green", ior = 1.5)))

# Pass the single raymesh object to `raymesh_model()`
# `raymesh_model()`
raymesh_model(rm_scene) |>
  add_object(generate_ground(material = diffuse(checkercolor="grey20"))) |>
  render_scene(fov = 30, samples=16, sample_method="sobol_blue")

# Set `flip_transmittance = FALSE` argument to specify attenuation coefficients directly
# (as specified in the `dielectric()` material). We change the material's numerical attenuation
# constants using `rayvertex::change_material`
rm_scene_new= change_material(rm_scene, transmittance = c(1,2,0.3), id = 1) |>
  change_material(transmittance = c(3,1,2), id = 2)
raymesh_model(rm_scene_new, flip_transmittance = FALSE) |>
  add_object(generate_ground(material = diffuse(checkercolor="grey20"))) |>
  render_scene(fov = 30, samples=16, sample_method="sobol_blue")

# Override the material specified in the `raymesh` object and render the scene
raymesh_model(rm_scene,
              material = dielectric(attenuation = "dodgerblue2", attenuation_intensity = 4),
  override_material = TRUE) |>
  add_object(generate_ground(material = diffuse(checkercolor="grey20"))) |>
  render_scene(fov = 30, samples=16, sample_method="sobol_blue")

# Adjusting the scale, position, and rotation parameters of the `raymesh` model
raymesh_model(rm_scene,
              x = 0, y = 0.5, z = -1, angle = c(0, 0, 20)) |>
  add_object(generate_ground(material = diffuse(checkercolor="grey20"))) |>
  render_scene(fov = 30,lookat=c(0,0.5,0), samples=16, sample_method="sobol_blue")

Remove Camera

Description

Removes a camera from a 'ray_scene'.

Usage

remove_camera(scene, camera)

Arguments

Value

A modified 'ray_scene'.

Examples

scene = generate_ground(material=diffuse(color="grey20")) |>
  add_camera(camera(name = "wide"), active = FALSE) |>
  add_camera(camera(name = "detail"), active = TRUE)

scene = remove_camera(scene, "detail")
list_cameras(scene)

Remove an Infinite Light

Description

Remove an Infinite Light

Usage

remove_infinite_light(scene, name)

Arguments

Value

A modified scene.

Remove Sequential Duplicate Keyframes

Description

Remove Sequential Duplicate Keyframes

Usage

remove_sequential_duplicate_keyframes(keyframes)

Arguments

Value

Keyframe data frame with adjacent duplicate rows removed.

Remove Stalled Path Samples

Description

Remove Stalled Path Samples

Usage

remove_stalled_path_samples(linearized_cp)

Arguments

Value

Linearized path data frame with repeated cumulative-distance samples removed.

Render Animation

Description

Takes the scene description and renders an image, either to the device or to a filename.

Usage

render_animation(
  scene,
  camera_motion = NULL,
  start_frame = 1,
  end_frame = NA,
  width = 400,
  height = 400,
  preview = interactive(),
  denoise = TRUE,
  camera_description_file = NA,
  camera_scale = 1,
  iso = 100,
  film_size = 22,
  samples = 100,
  min_variance = 0,
  min_adaptive_size = 8,
  sample_method = "sobol",
  ambient_occlusion = FALSE,
  keep_colors = FALSE,
  sample_dist = 10,
  max_depth = 50,
  roulette_active_depth = 10,
  ambient_light = FALSE,
  clamp_value = Inf,
  filename = NA,
  backgroundhigh = "#80b4ff",
  backgroundlow = "#ffffff",
  shutteropen = 0,
  shutterclose = 1,
  camera_motion_blur = FALSE,
  focal_distance = NULL,
  ortho_dimensions = c(1, 1),
  tonemap = "raw",
  bloom = TRUE,
  parallel = TRUE,
  bvh_type = "sah",
  environment_light = NULL,
  rotate_env = 0,
  intensity_env = 1,
  debug_channel = "none",
  plot_scene = TRUE,
  progress = interactive(),
  verbose = FALSE,
  transparent_background = FALSE,
  preview_light_direction = c(0, -1, 0),
  preview_exponent = 6,
  integrator_type = "rtiow",
  camera = NULL
)

Arguments

Value

Raytraced plot to current device, or an image saved to a file.

Examples

#Create and animate flying through a scene on a simulated roller coaster
set.seed(3)
elliplist = list()
ellip_colors = rainbow(8)
for(i in 1:1200) {
  elliplist[[i]] = ellipsoid(x=10*runif(1)-5,y=10*runif(1)-5,z=10*runif(1)-5,
                             angle = 360*runif(3), a=0.1,b=0.05,c=0.1,
                             material=glossy(color=sample(ellip_colors,1)))
}
ellip_scene = do.call(rbind, elliplist)

camera_pos = list(c(0,1,15),c(5,-5,5),c(-5,5,-5),c(0,1,-15))

#Plot the camera path and render from above using the path object:
generate_ground(material=diffuse(checkercolor="grey20"),depth=-10) |>
  add_object(ellip_scene) |>
  add_object(sphere(y=50,radius=10,material=light(intensity=30))) |>
  add_object(path(camera_pos, material=diffuse(color="red"))) |>
  render_scene(lookfrom=c(0,20,0), width=800,height=800,samples=32,
               camera_up = c(0,0,1),
               fov=80)
#Side view
generate_ground(material=diffuse(checkercolor="grey20"),depth=-10) |>
  add_object(ellip_scene) |>
  add_object(sphere(y=50,radius=10,material=light(intensity=30))) |>
  add_object(path(camera_pos, material=diffuse(color="red"))) |>
  render_scene(lookfrom=c(20,0,0),width=800,height=800,samples=32,
                 fov=80)
#View from the start
generate_ground(material=diffuse(checkercolor="grey20"),depth=-10) |>
  add_object(ellip_scene) |>
  add_object(sphere(y=50,radius=10,material=light(intensity=30))) |>
  add_object(path(camera_pos, material=diffuse(color="red"))) |>
  render_scene(lookfrom=c(0,1.5,16),width=800,height=800,samples=32,
                 fov=80)
#Generate Camera movement, setting the lookat position to be same as camera position, but offset
#slightly in front. We'll render 12 frames, but you'd likely want more in a real animation.

camera_motion =  generate_camera_motion(positions = camera_pos, lookats = camera_pos,
                                        offset_lookat = 1, fovs=80, frames=12,
                                        type="bezier")

#This returns a data frame of individual camera positions, interpolated by cubic bezier curves.
camera_motion

#Pass NA filename to plot to the device. We'll keep the path and offset it slightly to see
#where we're going. This results in a "roller coaster" effect.
generate_ground(material=diffuse(checkercolor="grey20"),depth=-10) |>
  add_object(ellip_scene) |>
  add_object(sphere(y=50,radius=10,material=light(intensity=30))) |>
  add_object(obj_model(r_obj(),x=10,y=-5,z=10,scale=7, angle=c(45,135,0),
                       material=dielectric(attenuation=c(1,1,0.3)))) |>
  add_object(pig(x=-7,y=10,z=-5,scale=1,angle=c(0,-45,80),emotion="angry")) |>
  add_object(pig(x=0,y=-0.25,z=-15,scale=1,angle=c(0,225,-22), order_rotation = c(3,2,1),
                 emotion="angry", spider=TRUE)) |>
  add_object(path(camera_pos, y=-0.2,material=diffuse(color="red"))) |>
  render_animation(camera_motion = camera_motion, samples=16,
                   sample_method="sobol_blue",
                   clamp_value=10, width=400, height=400)

Render Ambient Occlusion

Description

Takes the scene description and renders an image using ambient occlusion, either to the device or to a filename.

Usage

render_ao(
  scene,
  width = 400,
  height = 400,
  fov = 20,
  sample_dist = 10,
  keep_colors = FALSE,
  samples = 100,
  camera_description_file = NA,
  camera_scale = 1,
  iso = 100,
  film_size = 22,
  min_variance = 0,
  min_adaptive_size = 8,
  sample_method = "sobol",
  background_color = "white",
  lookfrom = c(0, 1, 10),
  lookat = c(0, 0, 0),
  camera_up = c(0, 1, 0),
  aperture = 0.1,
  clamp_value = Inf,
  filename = NA,
  shutteropen = 0,
  shutterclose = 1,
  focal_distance = NULL,
  ortho_dimensions = c(1, 1),
  parallel = TRUE,
  bvh_type = "sah",
  progress = interactive(),
  verbose = FALSE
)

Arguments

Value

Raytraced plot to current device, or an image saved to a file. Invisibly returns the array (containing either debug data or the RGB)

Examples

#Generate and render a regular scene and an ambient occlusion version of that scene
angles = seq(0,360,by=36)
xx = rev(c(rep(c(1,0.5),5),1) * sinpi(angles/180))
yy = rev(c(rep(c(1,0.5),5),1) * cospi(angles/180))
star_polygon = data.frame(x=xx,y=yy)
hollow_star = rbind(star_polygon,0.8*star_polygon)

generate_ground(material = diffuse(color="grey20", checkercolor = "grey50",sigma=90)) |>
 add_object(sphere(material=metal())) |>
 add_object(obj_model(r_obj(),y=-0.25,x=-1.8,scale=2,
                      angle=c(0,-45,0),material = diffuse(sigma=90))) |>
 add_object(pig(x=1.8,y=-1.2,scale=0.5,angle=c(0,90,0),diffuse_sigma = 90)) |>
 add_object(extruded_polygon(hollow_star,top=-0.5,bottom=-1, z=-2,
                             hole = nrow(star_polygon),
                             material=diffuse(color="red",sigma=90))) |>
 render_scene(parallel = TRUE,width=800,height=800,
              fov=70,clamp_value=10,samples=16, aperture=0.1,
              lookfrom=c(-0.9,1.2,-4.5),lookat=c(0,-1,0))

#Render the scene with ambient occlusion
generate_ground(material = diffuse(color="grey20", checkercolor = "grey50",sigma=90)) |>
 add_object(sphere(material=metal())) |>
 add_object(obj_model(r_obj(),y=-0.25,x=-1.8,scale=2,
                      angle=c(0,-45,0),material = diffuse(sigma=90))) |>
 add_object(pig(x=1.8,y=-1.2,scale=0.5,angle=c(0,90,0),diffuse_sigma = 90)) |>
 add_object(extruded_polygon(hollow_star,top=-0.5,bottom=-1, z=-2,
                             hole = nrow(star_polygon),
                             material=diffuse(color="red",sigma=90))) |>
 render_ao(parallel = TRUE,width=800,height=800, sample_dist=10,
           fov=70,samples=16, aperture=0.1,
           lookfrom=c(-0.9,1.2,-4.5),lookat=c(0,-1,0))
#Decrease the ray occlusion search distance
generate_ground(material = diffuse(color="grey20", checkercolor = "grey50",sigma=90)) |>
 add_object(sphere(material=metal())) |>
 add_object(obj_model(r_obj(),y=-0.25,x=-1.8,scale=2,
                      angle=c(0,-45,0),material = diffuse(sigma=90))) |>
 add_object(pig(x=1.8,y=-1.2,scale=0.5,angle=c(0,90,0),diffuse_sigma = 90)) |>
 add_object(extruded_polygon(hollow_star,top=-0.5,bottom=-1, z=-2,
                             hole = nrow(star_polygon),
                             material=diffuse(color="red",sigma=90))) |>
 render_ao(parallel = TRUE,width=800,height=800, sample_dist=1,
           fov=70,samples=16, aperture=0.1,
           lookfrom=c(-0.9,1.2,-4.5),lookat=c(0,-1,0))
#Turn on colors
generate_ground(material = diffuse(color="grey20", checkercolor = "grey50",sigma=90)) |>
 add_object(sphere(material=metal())) |>
 add_object(obj_model(r_obj(), y=-0.25,x=-1.8,scale=2,
                      angle=c(0,-45,0),material = diffuse(sigma=90))) |>
 add_object(pig(x=1.8,y=-1.2,scale=0.5,angle=c(0,90,0),diffuse_sigma = 90)) |>
 add_object(extruded_polygon(hollow_star,top=-0.5,bottom=-1, z=-2,
                             hole = nrow(star_polygon),
                             material=diffuse(color="red",sigma=90))) |>
 render_ao(parallel = TRUE,width=800,height=800, sample_dist=1,
           fov=70,samples=16, aperture=0.1, keep_colors = TRUE,
           lookfrom=c(-0.9,1.2,-4.5),lookat=c(0,-1,0))

Render Preview

Description

Takes the scene description and renders an image, either to the device or to a filename.

Usage

render_preview(..., light_direction = c(0, -1, 0), exponent = 6)

Arguments

Value

Raytraced plot to current device, or an image saved to a file.

Examples

generate_ground(material=diffuse(color="darkgreen")) |>
  add_object(sphere(material=diffuse(checkercolor="red"))) |>
  render_preview()
#Change the light direction
generate_ground(material=diffuse(color="darkgreen")) |>
  add_object(sphere(material=diffuse(checkercolor="red"))) |>
  render_preview(light_direction = c(-1,-1,0))
#Change the Phong exponent
generate_ground(material=diffuse(color="darkgreen")) |>
  add_object(sphere(material=diffuse(checkercolor="red"))) |>
  render_preview(light_direction = c(-1,-1,0), exponent=100)

Render Scene

Description

Takes the scene description and renders an image, either to the device or to a filename. The user can also interactively fly around the 3D scene if they have X11 support on their system or are on Windows.

Usage

render_scene(
  scene,
  width = 400,
  height = 400,
  fov = 20,
  samples = 100,
  camera_description_file = NA,
  preview = interactive(),
  interactive = TRUE,
  deferred_render = FALSE,
  denoise = TRUE,
  camera_scale = 1,
  iso = 100,
  auto_exposure = FALSE,
  film_size = 22,
  min_variance = 0,
  min_adaptive_size = 8,
  sample_method = "sobol_blue",
  max_depth = NA,
  roulette_active_depth = 100,
  ambient_light = NULL,
  lookfrom = c(0, 1, -10),
  lookat = c(0, 0, 0),
  camera_up = c(0, 1, 0),
  aperture = 0.1,
  clamp_value = Inf,
  filename = NA,
  backgroundhigh = "#80b4ff",
  backgroundlow = "#ffffff",
  shutteropen = 0,
  shutterclose = 1,
  camera_motion_blur = FALSE,
  shutter_speed = NULL,
  focal_distance = NULL,
  ortho_dimensions = c(1, 1),
  tonemap = "raw",
  bloom = TRUE,
  parallel = TRUE,
  bvh_type = "sah",
  environment_light = NULL,
  rotate_env = 0,
  intensity_env = 1,
  transparent_background = FALSE,
  debug_channel = "none",
  plot_scene = TRUE,
  progress = interactive(),
  verbose = FALSE,
  print_debug_info = FALSE,
  new_page = TRUE,
  integrator_type = "rtiow",
  screen_text = NULL,
  screen_line = NULL,
  camera = NULL,
  start_frame = 1,
  end_frame = NA,
  mode = c("auto", "image", "animation", "preview")
)

Arguments

Value

A pathtraced image to the current device, or an image saved to a file. Invisibly returns the array (containing either debug data or the RGB).

Examples

# Generate a large checkered sphere as the ground
  scene = generate_ground(depth = -0.5,
                          material = diffuse(color = "white", checkercolor = "darkgreen"))
  render_scene(scene, parallel = TRUE, samples = 16, sample_method = "sobol")
  # Add a sphere to the center
  scene = scene |>
    add_object(sphere(x = 0, y = 0, z = 0, radius = 0.5, material = diffuse(color = c(1, 0, 1))))
  render_scene(scene, fov = 20, parallel = TRUE, samples = 16)
  # Add a marbled cube
  scene = scene |>
    add_object(cube(x = 1.1, y = 0, z = 0, material = diffuse(noise = 3)))
  render_scene(scene, fov = 20, parallel = TRUE, samples = 16)
  # Add a metallic gold sphere, using stratified sampling for a higher quality render
  # We also add a light, which turns off the default ambient lighting
  scene = scene |>
    add_object(sphere(x = -1.1, y = 0, z = 0, radius = 0.5,
                      material = metal(color = "gold", fuzz = 0.1))) |>
    add_object(sphere(y=10,z=-13,radius=2,material=light(intensity=40)))
  render_scene(scene, fov = 20, parallel = TRUE, samples = 16)
  # Lower the number of samples to render more quickly (here, we also use only one core).
  render_scene(scene, samples = 4, parallel = FALSE)
  # Add a floating R plot using the iris dataset as a png onto a floating 2D rectangle
  tempfileplot = tempfile()
  png(filename = tempfileplot, height = 400, width = 800)
  plot(iris$Petal.Length, iris$Sepal.Width, col = iris$Species, pch = 18, cex = 4)
  dev.off()
  image_array = aperm(png::readPNG(tempfileplot), c(2, 1, 3))
  scene = scene |>
    add_object(xy_rect(x = 0, y = 1.1, z = 0, xwidth = 2, angle = c(0, 0, 0),
                       flipped = TRUE,
                       material = diffuse(image_texture = image_array)))
  render_scene(scene, fov = 20, parallel = TRUE, samples = 16)
  # Move the camera
  render_scene(scene, lookfrom = c(7, 1.5, 10), lookat = c(0, 0.5, 0), fov = 15, parallel = TRUE)
  # Change the background gradient to a firey sky
  render_scene(scene, lookfrom = c(7, 1.5, 10), lookat = c(0, 0.5, 0), fov = 15,
               backgroundhigh = "orange", backgroundlow = "red", parallel = TRUE,
               ambient = TRUE,
               samples = 16)
  # Increase the aperture to blur objects that are further from the focal plane.
  render_scene(scene, lookfrom = c(7, 1.5, 10), lookat = c(0, 0.5, 0), fov = 15,
               aperture = 1, parallel = TRUE, samples = 16)
  # We can also capture a 360 environment image by setting `fov = 360` (can be used for VR).
  # The left edge of the image is directly where the camera is pointing--we point the image
  # backwards so the full cornell box is in the "center" of the environment map.
  generate_cornell() |>
    add_object(ellipsoid(x = 555 / 2, y = 100, z = 555 / 2, a = 50, b = 100, c = 50,
                          material = metal(color = "lightblue"))) |>
    add_object(cube(x = 100, y = 130 / 2, z = 200, xwidth = 130, ywidth = 130, zwidth = 130,
                     material = diffuse(checkercolor = "purple",
                                        checkerperiod = 30), angle = c(0, 10, 0))) |>
    add_object(pig(x = 100, y = 190, z = 200, scale = 40, angle = c(0, 30, 0))) |>
    add_object(sphere(x = 420, y = 555 / 8, z = 100, radius = 555 / 8,
                       material = dielectric(color = "orange"))) |>
    add_object(xz_rect(x = 555 / 2, z = 555 / 2, y = 1, xwidth = 555, zwidth = 555,
                       material = glossy(checkercolor = "white",
                                         checkerperiod = 10, color = "dodgerblue"))) |>
    render_scene(lookfrom = c(278, 278, -10), lookat = c(278, 278, -300), clamp_value = 100,
                 fov = 360,  samples = 16, width = 800, height = 800)
  # Spin the camera around the scene, decreasing the number of samples to render faster. To make
  # an animation, specify the a filename in `render_scene` for each frame and use the `av` package
  # or ffmpeg to combine them all into a movie.
  t = 1:9
  xpos = 10 * sin(t * 18 * pi / 180 + pi / 2)
  zpos = 10 * cos(t * 18 * pi / 180 + pi / 2)
  image_output = list()
  for (i in 1:9) {
    image_output[[i]] = render_scene(scene, samples = 16, plot_scene = FALSE,
                 lookfrom = c(xpos[i], 1.5, zpos[i]), lookat = c(0, 0.5, 0), parallel = TRUE)
  }
  rayimage::plot_image_grid(image_output, dim = c(3,3) )

Save an interactive preview snapshot

Description

Save an interactive preview snapshot

Usage

save_preview_snapshot(image, filename = NA_character_)

Arguments

Value

Invisibly returns the saved snapshot filename.

Inspect Medium Attachments Before Scene Construction

Description

Inspect Medium Attachments Before Scene Construction

Usage

scene_medium_features(scene)

Arguments

Screen-space Lines

Description

Creates line annotations for 'render_scene()' that are anchored to 3D world-space endpoints but drawn in 2D screen space after rendering.

Usage

screen_line(
  x = 0,
  y = 0,
  z = 0,
  xend = 0,
  yend = 0,
  zend = 0,
  start = NULL,
  end = NULL,
  offset = c(0, 0),
  end_offset = offset,
  width = 2,
  color = "black",
  alpha = 1,
  lineend = "round",
  clip = TRUE,
  occlusion = FALSE,
  occlusion_mode = "anchor",
  occlusion_tolerance = 0.001
)

Arguments

Value

A data frame describing screen-space line annotations.

Examples

# Build the scene first, then add independent screen-space line layers.
scene = generate_cornell(lightwidth = 250, lightdepth = 250) |>
  add_object(sphere(
    x = 180, y = 90, z = 260, radius = 90,
    material = diffuse(color = "#f2c14e")
  )) |>
  add_object(cube(
    x = 385, y = 90, z = 330, xwidth = 120, ywidth = 180, zwidth = 120,
    angle = c(0, 25, 0), material = diffuse(color = "#243846")
  ))

# A round-ended measurement across the sphere uses matrix start/end points.
sphere_measure = screen_line(
  start = matrix(c(90, 6, 260), ncol = 3),
  end = matrix(c(270, 6, 260), ncol = 3),
  offset = c(0, 0),
  end_offset = c(0, 0),
  width = 5,
  color = "#f2c14e",
  alpha = 1,
  lineend = "round",
  clip = TRUE,
  occlusion = FALSE,
  occlusion_mode = "anchor",
  occlusion_tolerance = 0.001
)

# A vertical guide on the rotated box exercises line-level occlusion.
box_measure = screen_line(
  start = matrix(c(385, 0, 330), ncol = 3),
  end = matrix(c(385, 180, 330), ncol = 3),
  offset = c(-12, 0),
  end_offset = c(-12, 0),
  width = 7,
  color = "#4d9de0",
  alpha = 0.8,
  lineend = "butt",
  clip = TRUE,
  occlusion = TRUE,
  occlusion_mode = "line",
  occlusion_tolerance = 0.004
)

# A back-wall rule uses square caps, no clipping, and the "partial" alias.
wall_rule = screen_line(
  start = matrix(c(85, 18, 545), ncol = 3),
  end = matrix(c(505, 18, 545), ncol = 3),
  offset = c(0, -8),
  end_offset = c(0, -8),
  width = 4,
  color = "white",
  alpha = 0.6,
  lineend = "square",
  clip = FALSE,
  occlusion = TRUE,
  occlusion_mode = "partial",
  occlusion_tolerance = 0.01
)

# Scalar coordinates work too, which is handy for one-off callout lines.
callout_line = screen_line(
  x = 180, y = 190, z = 260,
  xend = 245, yend = 255, zend = 230,
  offset = c(0, -4),
  end_offset = c(30, -24),
  width = 3,
  color = "black",
  alpha = 0.9,
  lineend = "round",
  clip = TRUE,
  occlusion = TRUE,
  occlusion_mode = "anchor",
  occlusion_tolerance = 0.002
)

# Build a 3D spiral from many short screen-space line segments.
spiral_theta = seq(0, 5 * pi, length.out = 120)
spiral_radius = seq(6, 65, length.out = length(spiral_theta))
spiral_points = cbind(
  445 + spiral_radius * cos(spiral_theta),
  390 + spiral_radius * sin(spiral_theta),
  seq(245, 390, length.out = length(spiral_theta))
)
spiral_count = nrow(spiral_points) - 1
spiral_lines = screen_line(
  start = spiral_points[-nrow(spiral_points), ],
  end = spiral_points[-1, ],
  width = seq(1, 4, length.out = spiral_count),
  color = grDevices::hcl(seq(250, 360, length.out = spiral_count), 80, 65),
  alpha = seq(0.35, 0.95, length.out = spiral_count),
  lineend = "round",
  clip = TRUE
)

line_layers = list(
  sphere_measure,
  box_measure,
  wall_rule,
  callout_line,
  spiral_lines
)

render_scene(
  scene,
  samples = 32,
  clamp_value = 5,
  aperture = 0,
  ambient_light = FALSE,
  screen_line = line_layers
)

Screen-space Text

Description

Creates text annotations for 'render_scene()' that are anchored to 3D world-space points but drawn in 2D screen space after rendering.

Usage

screen_text(
  label,
  x = 0,
  y = 0,
  z = 0,
  point = NULL,
  offset = c(0, 0),
  hjust = 0,
  vjust = 0.5,
  size = 16,
  color = "black",
  font = "sans",
  lineheight = 1,
  background_color = "white",
  background_alpha = 0,
  just = "left",
  clip = TRUE,
  halo_color = NA,
  halo_expand = 0,
  halo_alpha = 1,
  halo_offset = c(0, 0),
  halo_blur = 0,
  halo_edge_softness = 0.1,
  halo_gap_fill = 2,
  halo_gap_fill_alpha_threshold = 0.25,
  occlusion = FALSE,
  occlusion_mode = "anchor",
  occlusion_tolerance = 0.001
)

Arguments

Value

A data frame describing screen-space text annotations.

Examples

# Start with a Cornell box that has one bright object and one dark object.
scene = generate_cornell(lightwidth = 250, lightdepth = 250) |>
  add_object(sphere(
    x = 180, y = 90, z = 260, radius = 90,
    material = diffuse(color = "#f2c14e")
  )) |>
  add_object(cube(
    x = 385, y = 90, z = 330, xwidth = 120, ywidth = 180, zwidth = 120,
    angle = c(0, 25, 0), material = diffuse(color = "#243846")
  ))

# Labels can be built in separate calls and passed as a list to render_scene().
sphere_label = screen_text(
  label = "matte sphere\nanchor test",
  x = 180, y = 190, z = 260,
  offset = c(18, -28),
  hjust = 0.5,
  vjust = 1,
  size = 18,
  color = "black",
  lineheight = 0.95,
  background_alpha = 0,
  just = "left",
  halo_color = "#f2c14e",
  halo_expand = 4,
  halo_alpha = 0.8,
  halo_offset = c(1, 1),
  halo_blur = 0.5,
  halo_edge_softness = 0.5,
  halo_gap_fill = 1,
  halo_gap_fill_alpha_threshold = 0.2,
  occlusion = TRUE,
  occlusion_mode = "anchor",
  occlusion_tolerance = 0.002
)

# Dark text over a dark object remains legible with a subtle white halo.
box_label = screen_text(
  label = "dark text\nwhite halo",
  x = 385, y = 195, z = 20,
  offset = c(-16, -34),
  hjust = 0.5,
  vjust = 1,
  size = 16,
  color = "#111111",
  lineheight = 1.05,
  background_alpha = 0,
  just = "right",
  halo_color = "white",
  halo_expand = 6,
  halo_alpha = 0.72,
  halo_offset = c(-1, 2),
  halo_blur = 1.5,
  halo_edge_softness = 10,
  halo_gap_fill = 3,
  halo_gap_fill_alpha_threshold = 0.35,
  occlusion = TRUE,
  occlusion_mode = "label",
  occlusion_tolerance = 0.01
)

# A floor label shows multi-line text, custom justification, and partial occlusion.
floor_label = screen_text(
  label = "floor label\n\nocclusion",
  point = matrix(c(280, 0, 50), ncol = 3),
  offset = c(0, 18),
  hjust = 0.5,
  vjust = 0.7,
  size = 15,
  color = "#222222",
  lineheight = 1,
  background_color = "#fff7cc",
  background_alpha = 0.65,
  just = "center",
  clip = FALSE,
  halo_color = "white",
  halo_expand = 3,
  halo_alpha = 0.7,
  halo_blur = 0,
  halo_edge_softness = 0.25,
  halo_gap_fill = 2,
  halo_gap_fill_alpha_threshold = 0.25,
  occlusion = TRUE,
  occlusion_mode = "partial",
  occlusion_tolerance = 0.005
)

# Later list entries draw after earlier entries.
wall_label = screen_text(
  label = "back wall\nalways in front",
  x = 278, y = 330, z = 545,
  offset = c(0, -20),
  hjust = 0.5,
  vjust = 1,
  size = 12,
  color = "white",
  background_color = "black",
  background_alpha = 0.35,
  halo_color = "black",
  halo_expand = 2,
  clip = TRUE
)

text_layers = list(sphere_label, box_label, floor_label, wall_label)

render_scene(
  scene,
  samples = 32,
  clamp_value = 5,
  aperture = 0,
  fov = 50,
  ambient_light = FALSE,
  screen_text = text_layers
)

Segment Object

Description

Similar to the cylinder object, but specified by start and end points.

Usage

segment(
  start = c(0, -1, 0),
  end = c(0, 1, 0),
  radius = 0.1,
  phi_min = 0,
  phi_max = 360,
  from_center = TRUE,
  direction = NA,
  material = diffuse(),
  capped = TRUE,
  flipped = FALSE,
  scale = c(1, 1, 1)
)

Arguments

Value

Single row of a tibble describing the segment in the scene.

Examples

#Generate a segment in the cornell box.
generate_cornell() |>
  add_object(segment(start = c(100, 100, 100), end = c(455, 455, 455), radius = 50)) |>
  render_scene(lookfrom = c(278, 278, -800) ,lookat = c(278, 278, 0), fov = 40,
               ambient_light = FALSE, samples = 16, parallel = TRUE, clamp_value = 5)

# Draw a line graph representing a normal distribution, but with metal:
xvals = seq(-3, 3, length.out = 30)
yvals = dnorm(xvals)

scene_list = list()
for(i in 1:(length(xvals) - 1)) {
  scene_list[[i]] = segment(start = c(555/2 + xvals[i] * 80, yvals[i] * 800, 555/2),
                            end = c(555/2 + xvals[i + 1] * 80, yvals[i + 1] * 800, 555/2),
                            radius = 10,
                            material = metal())
}
scene_segments = do.call(rbind,scene_list)
generate_cornell() |>
  add_object(scene_segments) |>
  render_scene(lookfrom = c(278, 278, -800) ,lookat = c(278, 278, 0), fov = 40,
               ambient_light = FALSE, samples = 16, parallel = TRUE, clamp_value = 5)

#Draw the outline of a cube:

cube_outline = segment(start = c(100, 100, 100), end = c(100, 100, 455), radius = 10) |>
  add_object(segment(start = c(100, 100, 100), end = c(100, 455, 100), radius = 10)) |>
  add_object(segment(start = c(100, 100, 100), end = c(455, 100, 100), radius = 10)) |>
  add_object(segment(start = c(100, 100, 455), end = c(100, 455, 455), radius = 10)) |>
  add_object(segment(start = c(100, 100, 455), end = c(455, 100, 455), radius = 10)) |>
  add_object(segment(start = c(100, 455, 455), end = c(100, 455, 100), radius = 10)) |>
  add_object(segment(start = c(100, 455, 455), end = c(455, 455, 455), radius = 10)) |>
  add_object(segment(start = c(455, 455, 100), end = c(455, 100, 100), radius = 10)) |>
  add_object(segment(start = c(455, 455, 100), end = c(455, 455, 455), radius = 10)) |>
  add_object(segment(start = c(455, 100, 100), end = c(455, 100, 455), radius = 10)) |>
  add_object(segment(start = c(455, 100, 455), end = c(455, 455, 455), radius = 10)) |>
  add_object(segment(start = c(100, 455, 100), end = c(455, 455, 100), radius = 10))

generate_cornell() |>
  add_object(cube_outline) |>
  render_scene(lookfrom = c(278, 278, -800) ,lookat = c(278, 278, 0), fov = 40,
               ambient_light = FALSE, samples = 16, parallel = TRUE, clamp_value = 5)

#Shrink and rotate the cube
generate_cornell() |>
  add_object(group_objects(cube_outline, pivot_point = c(555/2, 555/2, 555/2),
                           angle = c(45,45,45), scale = c(0.5,0.5,0.5))) |>
  render_scene(lookfrom = c(278, 278, -800) ,lookat = c(278, 278, 0), fov = 40,
               ambient_light = FALSE, samples = 16, parallel = TRUE, clamp_value = 5)

Set Active Camera

Description

Sets the active camera for a 'ray_scene'.

Usage

set_active_camera(scene, camera)

Arguments

Value

A modified 'ray_scene'.

Examples

scene = generate_ground(material=diffuse(color="grey20")) |>
  add_camera(camera(name = "wide", fov = 55), active = FALSE) |>
  add_camera(camera(name = "detail", fov = 20), active = FALSE)

scene = set_active_camera(scene, "detail")
get_camera(scene)

Attach a Medium to Closed Objects

Description

Media nest: the innermost medium replaces the surrounding one. Cameras inside media are detected automatically. A medium with zero absorption and scattering creates a vacuum cavity. Intersecting, non-nested volume boundaries are unsupported.

Usage

set_medium(scene, medium, keep_surface = FALSE)

Arguments

Value

The scene with medium attachments stored independently of materials.

Examples

water = homogeneous_medium(sigma_a = c(0.3, 0.05, 0.02), sigma_s = 0.01)
glass = sphere(material = dielectric())
scene = set_medium(glass, water, keep_surface = TRUE)

Set Material for All Objects

Description

Set Material for All Objects

Usage

set_scene_material(scene, material)

Arguments

Value

A modified ray_scene with the new material applied to all objects

Examples

# Create a scene with different materials
scene = generate_cornell() |>
  add_object(sphere(x=555/2, y=555/2, z=555/2, radius=100))

# Set all objects to be metallic
scene = set_scene_material(scene, metal(color="gold"))

# Set all objects to be glass
scene = set_scene_material(scene, dielectric())

Atmospheric Location and Time Sky Light

Description

Evaluate the native Prague atmosphere at scene interactions, including altitude-dependent Sun and sky lighting, finite-distance haze, and in-scattering. Sun and Moon disk lights are included automatically. Add the light with add_infinite_light(). Rendering automatically selects integrator_type = "nee". Use sky_light_image() for a cached sky image.

Usage

sky_light(
  lat,
  long,
  datetime,
  intensity = 1,
  rotation = 0,
  name = "sky",
  meters_per_unit = 1,
  atmosphere_origin = c(0, 0, 0),
  haze = TRUE,
  query_altitude = TRUE,
  haze_in_volumes = FALSE,
  deferred_haze = TRUE,
  cache_spectra = TRUE,
  transmission_table = TRUE,
  transmission_table_max_mb = 512,
  altitude = 0,
  visibility = 131.8,
  albedo = 0.5,
  sampling_resolution = 64,
  render_mode = "all",
  prague_rgb_correction = TRUE,
  prague_rgb_correction_strength = 1,
  prague_rgb_correction_gain = "auto",
  sun = TRUE,
  moon = TRUE,
  sun_resolution = 256,
  moon_resolution = 256,
  earthshine = TRUE,
  earthshine_albedo = 0.19,
  solar_irradiance_w_m2 = 1300,
  stars = FALSE,
  star_width = 1,
  stars_exposure = 0,
  planets = FALSE,
  celestial_resolution = 2048,
  number_cores = 1,
  haze_filter = TRUE
)

Arguments

Details

Install the full-altitude Prague data with skymodelr::download_sky_data(sea_level = FALSE) before rendering. Atmospheric queries share skymodelr's coefficients and registered native API.

With query_altitude = TRUE, the sky and Sun elevation change with the altitude of each surface or cloud interaction. With haze = FALSE, finite haze is disabled while this local lighting remains active. Setting both haze = FALSE and query_altitude = FALSE uses the fixed reference observer for all lighting. Date and time stay fixed during an animation.

World +Y is up. With zero rotation, north is world +Z and east is world -X. meters_per_unit sets the physical scene scale, and atmosphere_origin locates the geographic reference point at altitude meters above sea level. Horizontal offsets follow the model's spherical Earth. The Sun is sampled independently of the sky sampling resolution. Its visibility includes Earth's curvature, allowing elevated clouds to receive sunlight on their undersides after the Sun disappears from the ground. Refraction is not modeled. Ground surfaces can still receive diffuse twilight and indirect cloud light.

A scene can contain one atmospheric sky. When the reference Sun elevation is below -4.2 degrees, Prague contributes black sky and no solar in-scattering. Enabled Moon, star, and planet lights still contribute, with atmospheric transmission and Earth occlusion applied normally. Queries outside 0–15000 m use the nearest modeled altitude; keep scene interactions within that range. Do not add another medium modeling the same clear-air scattering or absorption. Separate clouds can be added normally. Clouds default to no interior haze; cloud(haze = TRUE) enables haze below density 0.05, and haze_density_threshold = NULL removes that cutoff. See cloud() for details.

The model precomputes clear-air multiple scattering over a spherical Earth with uniform ground albedo. Local geometry and clouds block direct Sun and sky lighting but do not cast shadows into this precomputed in-scattering. Haze is disabled inside dielectric solids. Radiance is integrated spectrally and converted to renderer RGB; haze of RGB materials uses a broadband approximation. Finite-distance fitted transmission is normalized at zero distance and interpolated in optical depth over the first 100 m. Ray-anchored cumulative transport avoids accumulating fit errors at cloud null events. Finite haze is filtered over complete neighboring paths by default to reduce bands from subtracting independently fitted sky spectra. This is an angular regularization of the finite source. It does not blur the environment image or surface geometry.

Sun and Moon are prepared automatically using sun_light() and moon_light() with this sky's location, time, altitude, rotation, intensity, and color settings. Disk textures are generated without atmospheric filtering or a fixed horizon mask, then cached. The renderer applies spectral atmospheric filtering and Earth occlusion at each interaction. Disabling finite haze does not disable this filtering. Separate Sun or Moon lights replace the matching automatic disk, preserving their own settings. Removing or replacing the sky also removes or replaces its automatic celestial components.

Stars and planets use cached, unattenuated images of the full sphere, with native RGB atmospheric filtering and Earth occlusion at each interaction. Their map resolution affects point-source detail, not the Prague atmosphere.

Other infinite lights add to the sky. Additional image lights represent radiance outside the atmosphere and receive atmospheric haze; do not use an image that already includes the same haze. sun_light() and moon_light() request unattenuated textures automatically. The renderer applies spectral atmospheric filtering and Earth occlusion at each interaction. The sampled Sun replaces the built-in solar disk while preserving the sky and haze. Without an explicit disk altitude, ephemerides use this sky's reference altitude. Match light rotations and intensities when they should describe the same illumination. The precomputed haze remains Sun-driven: a Moon disk lights surfaces and clouds but adds no moonlit in-scattering or lunar halo. Image-only model choices such as hosek and moon_atmosphere belong to sky_light_image().

Use render_scene()'s iso to adjust exposure, keeping it fixed within each comparison. With a transparent background, atmospheric in-scattering remains foreground radiance and scalar opacity comes from primary-ray transmission. RGB transmission into an arbitrary compositing background is approximate.

The standalone vignette vignette("sky-light", package = "rayrender") builds the full capsule landscape, river, question blocks, pipes, and clouds, and demonstrates image skies, celestial lights, and additional sky controls.

Value

A ray_infinite_light containing a native atmospheric sky description.

See Also

sky_light_image(), cloud(), sun_light(), moon_light()

Examples

# Install the full-altitude Prague data once before rendering:
# skymodelr::download_sky_data(sea_level = FALSE)
if (
  requireNamespace("ambient", quietly = TRUE) &&
    requireNamespace("tree3d", quietly = TRUE)
) {
  # Scene units are kilometres.
  # Rounded green hills, with their lower capsule ends buried in the ground.
  # The rows are roughly 3-7, 17-26, and 60-85 km from the camera.
  # Small foreground hills stay crisp while larger distant hills fade.
  hills = data.frame(
    x = c(-1.1, 3, -6, -2, 3.5, 8, -27, -17, -6, 7, 22, 35, -45),
    z = c(-5.6, -2.2, 9, 15, 11, 17, 55, 63, 69, 58, 66, 60, 62),
    radius = c(0.30, 0.72, 1.7, 1.4, 2, 2.2, 6, 5, 5.5, 5, 7, 4, 2),
    top = c(0.7, 1.7, 3.8, 3, 4.7, 4.2, 10, 9, 22, 20.5, 31, 30, 34)
  )
  terrain_mat = diffuse(color = "#469D60")
  terrain = xz_rect(xwidth = 160, zwidth = 160, material = terrain_mat)
  for (i in seq_len(nrow(hills))) {
    h = hills[i, ]
    terrain = add_object(
      terrain,
      csg_object(
        csg_capsule(
          start = c(h$x, -h$radius, h$z),
          end = c(h$x, h$top - h$radius, h$z),
          radius = h$radius
        ),
        material = terrain_mat
      )
    )
  }

  # A river winds around the capsule footprints and turns out of sight behind
  # the distant pair at (-6, 69) and (7, 58). Coordinates and width are in km.
  # fmt: skip
  river_bends = data.frame(
    x = c(0.3, 0.1, 0.7, 0.8, -1.2, -2.6, -3.9, -4.2, 0.2, 2.5, -1.1, 0.7, 1.4, 1.1, -2, -4.5),
    z = c(-12, -7, -4, -1, 3, 7, 12, 17, 23, 32, 43, 53, 62, 69, 76, 79)
  )
  river_curve = stats::splinefun(
    river_bends$z,
    river_bends$x,
    method = "natural"
  )
  river_z = seq(min(river_bends$z), max(river_bends$z), length.out = 600)
  river_center = cbind(x = river_curve(river_z), z = river_z)

  # Offset perpendicular to the tangent, keeping the river 1 km wide even
  # through bends. Reverse the second bank to make one closed polygon.
  river_width = 1
  river_slope = river_curve(river_z, deriv = 1)
  bank_offset = river_width /
    2 *
    cbind(1, -river_slope) /
    sqrt(1 + river_slope^2)
  river_banks = rbind(
    river_center + bank_offset,
    (river_center - bank_offset)[length(river_z):1, ]
  )

  # Keep the polygon's world x coordinates and lift its top 1 m above
  # ground. A thin extrusion gives the river an upward-facing surface.
  terrain = add_object(
    terrain,
    extruded_polygon(
      river_banks,
      plane = "xz",
      top = 0.001,
      bottom = -0.001,
      flip_horizontal = TRUE,
      material = microfacet(color="#168BC4",transmission=TRUE, roughness=0.2)
    )
  )

  # Redwood-sized trees: 60-100 m tall, in a scene measured in kilometres.
  # Generate three solid tree meshes once, then share them across 20,000 instances.
  # Crown widths are 12-25 m and trunk diameters are approximately 2.4-5 m.
  tree_types = c("pyramidal1", "pyramidal2", "columnar")
  tree_colors = c("#245638", "#2B603E", "#305A3B")
  tree_models = lapply(seq_along(tree_types), function(i) {
    tree3d::tree_mesh(
      crown_type = tree_types[i],
      solid = TRUE,
      resolution = "medium",
      tree_height = 0.08,
      trunk_height_ratio = c(0.25, 0.3, 0.35)[i],
      crown_width = c(0.018, 0.016, 0.020)[i],
      trunk_width = c(0.0032, 0.0036, 0.0040)[i],
      crown_color = tree_colors[i],
      trunk_color = "#794A35",
      ambient_intensity = 0
    ) |>
      raymesh_model()
  })

  # Log-spaced distances give the foreground enough trees to establish scale.
  # Candidate positions follow the camera's view across the flat valley floor.
  tree_count = 20000
  tree_candidates = 4 * tree_count
  set.seed(2028)
  tree_distance = exp(runif(tree_candidates, log(1.4), log(85)))
  tree_positions = data.frame(
    x = runif(tree_candidates, -0.65, 0.65) * tree_distance,
    z = -8 + tree_distance,
    size = runif(tree_candidates, 0.75, 1.25),
    angle = runif(tree_candidates, 0, 360),
    model = sample(seq_along(tree_models), tree_candidates, replace = TRUE)
  )

  # Leave enough room for the widest crown along both riverbanks and hills.
  # Measure distance to river segments so the exclusion follows every bend.
  tree_clearance = 0.015
  tree_clear = rep(TRUE, nrow(tree_positions))
  for (i in seq_len(nrow(river_center) - 1)) {
    dx = river_center[i + 1, 1] - river_center[i, 1]
    dz = river_center[i + 1, 2] - river_center[i, 2]
    along = pmin(
      pmax(
        ((tree_positions$x - river_center[i, 1]) *
          dx +
          (tree_positions$z - river_center[i, 2]) * dz) /
          (dx^2 + dz^2),
        0
      ),
      1
    )
    river_dx = tree_positions$x - (river_center[i, 1] + along * dx)
    river_dz = tree_positions$z - (river_center[i, 2] + along * dz)
    tree_clear = tree_clear &
      river_dx^2 + river_dz^2 > (river_width / 2 + tree_clearance)^2
  }
  for (i in seq_len(nrow(hills))) {
    tree_clear = tree_clear &
      (tree_positions$x - hills$x[i])^2 +
        (tree_positions$z - hills$z[i])^2 >
        (hills$radius[i] + tree_clearance)^2
  }
  tree_positions = head(tree_positions[tree_clear, ], tree_count)

  # Each group shares one mesh/BVH. Vary height and yaw without copying geometry.
  for (i in seq_along(tree_models)) {
    grove = tree_positions[tree_positions$model == i, ]
    terrain = add_object(
      terrain,
      create_instances(
        tree_models[[i]],
        x = grove$x,
        z = grove$z,
        angle_y = grove$angle,
        scale_x = grove$size,
        scale_y = grove$size,
        scale_z = grove$size
      )
    )
  }

  # Billowing Perlin volumes sit above each row of hills. Optical depth sets
  # the cloud's own scattering; sky_light() separately supplies clear-air haze.
  cloud_rows = data.frame(
    z = c(3, 21, 63),
    base = c(5, 6, 12.5),
    width = c(16, 32, 90),
    depth = c(10, 16, 24)
  )
  landscape = terrain
  for (i in seq_len(nrow(cloud_rows))) {
    cl = cloud_rows[i, ]
    landscape = add_object(
      landscape,
      cloud(
        z = cl$z,
        y = cl$base + 1.8 / 2,
        width = cl$width,
        depth = cl$depth,
        height = 1.8,
        resolution = 64,
        coverage = 0.4,
        detail = 0.4,
        optical_depth = 4,
        g = 0.65,
        seed = 41 + i
      )
    )
  }
  day = as.POSIXct("2026-06-21 18:00:00", tz = "America/New_York")
  sunset = as.POSIXct("2026-06-21 20:35:00", tz = "America/New_York")

  render_sky = function(light, iso = 4, caption = "") {
    set.seed(2026)
    image = landscape |>
      add_infinite_light(light) |>
      render_scene(
        lookfrom = c(0, 0.35, -8),
        lookat = c(0, 2.4, 3),
        fov = 47,
        aperture = 0,
        width = 384,
        height = 240,
        samples = 32,
        integrator_type = "nee",
        iso = iso,
        tonemap = "raw",
        plot_scene = FALSE
      )
    rayimage::render_stack(list(
      image,
      rayimage::render_text_image(
        caption,
        size = 14,
        font = "sans",
        width = dim(image)[2],
        height = 34,
        just = "center",
        check_text_width = FALSE,
        check_text_height = FALSE
      )
    ))
  }

  # Haze changes contrast and color with distance. Hold visibility and ISO fixed.
  rayimage::plot_image_grid(
    list(
      render_sky(
        sky_light(
          40.7,
          -74,
          day,
          meters_per_unit = 1000,
          haze = FALSE
        ),
        caption = "No finite haze"
      ),
      render_sky(
        sky_light(40.7, -74, day, meters_per_unit = 1000, visibility = 120),
        caption = "Finite haze, 120km"
      ),
      render_sky(
        sky_light(40.7, -74, day, meters_per_unit = 1000, visibility = 20),
        caption = "Finite haze, 20km"
      )
    ),
    dim = c(1, 3)
  )

  # Isolate altitude-dependent lighting by disabling finite haze in both images.
  # The Sun is below the ground horizon, but the elevated cloud can still see it.
  rayimage::plot_image_grid(
    list(
      render_sky(
        sky_light(
          40.7,
          -74,
          sunset,
          meters_per_unit = 1000,
          haze = FALSE,
          query_altitude = FALSE
        ),
        iso = 175,
        caption = "Fixed observer altitude"
      ),
      render_sky(
        sky_light(
          40.7,
          -74,
          sunset,
          meters_per_unit = 1000,
          haze = FALSE,
          query_altitude = TRUE
        ),
        iso = 175,
        caption = "Altitude at each interaction"
      ),
      render_sky(
        sky_light(
          40.7,
          -74,
          sunset,
          meters_per_unit = 1000,
          haze = TRUE,
          query_altitude = TRUE
        ),
        iso = 175,
        caption = "Altitude + haze each interaction"
      )
    ),
    dim = c(1, 3)
  )
}

Image-Based Location and Time Sky Light

Description

Generate a cached sky EXR with skymodelr::generate_sky_latlong() and use it as an infinite light. Add it to a scene with add_infinite_light(). The image represents one observer and illuminates every scene position with the same sky. Use sky_light() for altitude-dependent lighting and finite-distance haze. Both constructors include Sun and Moon by default, controlled with sun and moon, and support optional stars and planets.

Usage

sky_light_image(
  lat,
  long,
  datetime,
  intensity = 1,
  rotation = 0,
  name = "sky",
  altitude = 0,
  visibility = 131.8,
  albedo = 0.5,
  resolution = 2048,
  hosek = TRUE,
  render_mode = "all",
  turbidity = 3,
  wide_spectrum = FALSE,
  below_horizon = TRUE,
  prague_rgb_correction = TRUE,
  prague_rgb_correction_strength = 1,
  prague_rgb_correction_gain = "auto",
  stars = FALSE,
  star_width = 1,
  stars_exposure = 0,
  planets = FALSE,
  moon = TRUE,
  moon_atmosphere = FALSE,
  moon_hosek = TRUE,
  exr_adopted_white = "D60",
  exr_metadata = TRUE,
  number_cores = 1,
  verbose = FALSE,
  sun = TRUE,
  environment_light_bake_white = FALSE,
  environment_light_bake_white_target = "D65",
  ...
)

Arguments

Details

Image generation happens before rendering and is cached for the R session. Changing only intensity, rotation, or name reuses the image. Changing the baked target white point reuses the generated sky and caches a separate adapted image. White-balance controls belong to this light; pass the light to add_infinite_light() before calling render_scene() or render_animation(). Install any required Prague data with skymodelr::download_sky_data() first; rendering does not download datasets.

With zero rotation, north is world +Z and east is world -X. Date, time, and observer altitude remain fixed throughout the image. This light supports the same integrators as infinite_light() and adds no finite atmospheric haze. Use render_scene()'s iso to adjust exposure.

For a separately sampled Sun, set render_mode = "atmosphere" and add sun_light() with matching location, time, and atmospheric settings. This avoids relying on the environment image to resolve the small solar disk.

Value

A ray_infinite_light containing a cached-image sky description.

See Also

sky_light(), infinite_light(), sun_light(), moon_light()

Examples

time = as.POSIXct("2026-06-21 18:00:00", tz = "America/New_York")
scene = sphere(material = diffuse("white")) |>
  add_object(generate_ground())

scene |>
  add_infinite_light(sky_light_image(40.7, -74, time)) |>
  render_scene(
    lookfrom = c(0, 1, 10),
    lookat = c(0, 0, 0),
    width = 600,
    height = 300,
    samples = 32,
    iso = 3
  )

# A Prague image sky with an independently sampled solar disk.
# Install Prague data with skymodelr::download_sky_data() before rendering.
scene |>
  add_infinite_light(sky_light_image(
    40.7,
    -74,
    time,
    hosek = FALSE,
    render_mode = "atmosphere",
    altitude = 0,
    visibility = 50,
    albedo = 0.3
  )) |>
  add_infinite_light(sun_light(
    40.7,
    -74,
    time,
    sky_args = list(altitude = 0, visibility = 50, albedo = 0.3)
  )) |>
render_scene(
  lookfrom = c(0, 1, 10),
  lookat = c(0, 0, 0),
  aperture = 0,
  width = 600,
  height = 300,
  samples = 32,
  iso = 3
)

Slerp

Description

Slerp

Usage

slerp(vec1, vec2, n)

Arguments

Value

number

Sphere Object

Description

Sphere Object

Usage

sphere(
  x = 0,
  y = 0,
  z = 0,
  radius = 1,
  material = diffuse(),
  angle = c(0, 0, 0),
  order_rotation = c(1, 2, 3),
  flipped = FALSE,
  scale = c(1, 1, 1)
)

Arguments

Value

Single row of a tibble describing the sphere in the scene.

Examples

#Generate a sphere in the cornell box.
generate_cornell() |>
  add_object(sphere(x = 555/2, y = 555/2, z = 555/2, radius = 100)) |>
  render_scene(lookfrom = c(278, 278, -800) ,lookat = c(278, 278, 0), fov = 40,
               ambient_light = FALSE, samples = 16, clamp_value = 5)

#Generate a gold sphere in the cornell box
generate_cornell() |>
  add_object(sphere(x = 555/2, y = 100, z = 555/2, radius = 100,
                    material = microfacet(color = "gold"))) |>
  render_scene(lookfrom = c(278, 278, -800) ,lookat = c(278, 278, 0), fov = 40,
               ambient_light = FALSE, samples = 16, clamp_value = 5)

Convert Accumulated Volume Foreground to Straight RGB

Description

Convert Accumulated Volume Foreground to Straight RGB

Usage

straight_volume_rgb(rgb_mat)

Arguments

Sun and Moon Infinite Lights

Description

Create detailed celestial disks without embedding them in a latitude-longitude environment map. skymodelr supplies the position and apparent angular size for the observer, date, and time. The Sun uses Prague solar radiance queries; the Moon uses skymodelr's surface texture, phase, earthshine, and radiometry routines. Add these descriptions to a scene with add_infinite_light().

Usage

sun_light(
  lat,
  long,
  datetime,
  sky_args = list(),
  resolution = 256,
  intensity = 1,
  rotation = 0,
  name = "sun"
)

moon_light(
  lat,
  long,
  datetime,
  sky_args = list(),
  moon_args = list(),
  resolution = 256,
  intensity = 1,
  rotation = 0,
  name = "moon"
)

Arguments

Details

Requires skymodelr and its Prague data. Install datasets with skymodelr::download_sky_data() before rendering. Requires the public skymodelr::generate_sun_disk() and skymodelr::generate_moon_disk() exports.

Pair a Sun disk with sky_light_image(..., hosek = FALSE, render_mode = "atmosphere") to exclude the sky map's rasterized Sun. Leave moon = FALSE in that sky when adding a Moon disk. Lights add radiance; they do not eclipse or occlude each other, and adding a second copy doubles its light. With sky_light(), explicit Sun and Moon lights replace the corresponding automatic disks; there is no need to change sun, moon, or render_mode. The clear-air sky and haze retain that sky light's own location, time, rotation, and intensity.

Both lights use north at world +Z, east at world -X, and up at world +Y, matching sky_light(). They have no parallax and add no scene geometry. The geometric horizon clips their emission. Preparation generates and caches linear EXRs before worker threads start; phase, time, and position stay fixed during animation. Direct illumination samples each disk's solid angle, so a small apparent diameter does not depend on a high-resolution sky sampler.

The Sun texture uses Prague's solar disk profile, mapped to the ephemeris angular diameter. Moon radiance preserves skymodelr's phase-dependent total irradiance and atmospheric extinction, with its spectral RGB and atmospheric tint. Earthshine is part of the generated phase texture. These are radiance images; exposure and tone mapping are applied only by the final render.

With a native atmospheric sky, preparation automatically requests atmospheric_attenuation = FALSE through skymodelr's public disk generators. Sun radiance and lunar phase, surface detail, and earthshine are generated before atmospheric filtering. The renderer applies the Sun's spectrum or the Moon's reference spectrum to Prague transmission along each light direction. Spherical Earth visibility clips each direction, so a partially set disk can illuminate high clouds while being hidden from the ground. Texture detail remains independent of the sky sampling resolution. Skymodelr must support the new argument. Without a native atmosphere, the existing fixed-observer haze and geometric horizon clipping remain in effect. The sky's haze = FALSE option removes finite scene haze while keeping this celestial filtering. Its query_altitude option controls whether the filtering and horizon follow each interaction or use the reference observer. The precomputed clear-air haze is Sun-driven; lunar atmospheric in-scattering and halos are not modeled. See sky_light() for the model's supported domain.

Value

A ray_infinite_light description.

Examples

time = as.POSIXct("2026-01-28 21:00:00", tz = "Pacific/Auckland")
scene = sphere(material = diffuse()) |>
  add_infinite_light(moon_light(-36.87593, 174.7647, time)) |>
  add_camera(camera(aperture = 0))
render_scene(scene, integrator_type = "nee", auto_exposure = TRUE)

Text Object

Description

Text Object

Usage

text3d(
  label,
  x = 0,
  y = 0,
  z = 0,
  text_height = 1,
  orientation = "xy",
  material = diffuse(),
  font = "sans",
  font_style = "plain",
  font_color = "black",
  font_lineheight = 1,
  font_size = 100,
  background_color = "white",
  background_alpha = 0,
  angle = c(0, 0, 0),
  order_rotation = c(1, 2, 3),
  flipped = FALSE,
  scale = c(1, 1, 1)
)

Arguments

Value

Single row of a tibble describing the text in the scene.

Examples

#Generate a label in the cornell box.
generate_cornell() |>
  add_object(text3d(label="Cornell Box", x=555/2,y=555/2,z=555/2,text_height=60,
                    material=diffuse(color="grey10"), angle=c(0,0,0))) |>
  render_scene(samples=16)
#Change the orientation
generate_cornell() |>
  add_object(text3d(label="YZ Plane", x=550,y=555/2,z=555/2,text_height=200,
                    orientation = "yz",
                    material=diffuse(color="grey10"), angle=c(0,0,0))) |>
 add_object(text3d(label="XY Plane", z=550,y=555/2,x=555/2,text_height=200,
                    orientation = "xy",
                    material=diffuse(color="grey10"), angle=c(0,0,0))) |>
 add_object(text3d(label="XZ Plane", z=555/2,y=5,x=555/2,text_height=200,
                    orientation = "xz",
                    material=diffuse(color="grey10"))) |>
  render_scene(samples=16)
#Add an label in front of a sphere
generate_cornell() |>
  add_object(text3d(label="Cornell Box", x=555/2,y=555/2,z=555/2,text_height=90,
                    material=diffuse(color="grey10"), angle=c(0,0,0))) |>
  add_object(text3d(label="Sphere", x=555/2,y=100,z=100,text_height=60,
                    material=diffuse(color="white"), angle=c(0,0,0))) |>
  add_object(sphere(y=100,radius=100,z=555/2,x=555/2,
                    material=glossy(color="purple"))) |>
  add_object(sphere(y=555,radius=100,z=-1000,x=555/2,
                    material=light(intensity=100,
                                   spotlight_focus=c(555/2,100,100)))) |>
  render_scene(samples=16)

#A room full of bees
bee_list = list()
for(i in 1:100) {
bee_list[[i]] = text3d("B", x=20+runif(1)*525, y=20+runif(1)*525, z=20+runif(1)*525,
                       text_height = 50, angle=c(0,0,0))
}
bees = do.call(rbind,bee_list)
generate_cornell() |>
  add_object(bees) |>
  render_scene(samples=16)
# If you have ragg installed, you can also use color emojis.
library(rayrender)
generate_cornell(light_position = c(555/2,554,10),
                 lightwidth = 10, lightdepth = 100,
                 lightintensity = 800) |>
  add_object(text3d(label="\U1F30A",font_size = 500,angle=c(0,0,0),
                    x=555/2,y=555/2,z=260,text_height=1000)) |>
  add_object(text3d(label="\U1F6A3", x=180,y=140,z=260-50,
                    text_height=400, font_size = 500,
                    material=diffuse(color="black"),
                    angle=c(0,0,30))) |>
  add_object(text3d(label="\U1F5FB", x=180,y=230,z=260+50,text_height=300,
                    font_size = 500,material=diffuse(color="black"),
                    angle=c(0,0,0))) |>
  render_scene(samples=16)

Triangle Object

Description

Triangle Object

Usage

triangle(
  v1 = c(1, 0, 0),
  v2 = c(0, 1, 0),
  v3 = c(-1, 0, 0),
  n1 = rep(NA, 3),
  n2 = rep(NA, 3),
  n3 = rep(NA, 3),
  color1 = rep(NA, 3),
  color2 = rep(NA, 3),
  color3 = rep(NA, 3),
  material = diffuse(),
  angle = c(0, 0, 0),
  order_rotation = c(1, 2, 3),
  flipped = FALSE,
  reversed = FALSE,
  scale = c(1, 1, 1)
)

Arguments

Value

Single row of a tibble describing the XZ plane in the scene.

Examples

#Generate a triangle in the Cornell box.
generate_cornell() |>
  add_object(triangle(v1 = c(100, 100, 100), v2 = c(555/2, 455, 455), v3 = c(455, 100, 100),
                      material = diffuse(color = "purple"))) |>
  render_scene(lookfrom = c(278, 278, -800) ,lookat = c(278, 278, 0), fov = 40,
               ambient_light = FALSE, samples = 16, parallel = TRUE, clamp_value = 5)
#Pass individual colors to each vertex:
generate_cornell() |>
  add_object(triangle(v1 = c(100, 100, 100), v2 = c(555/2, 455, 455), v3 = c(455, 100, 100),
                      color1 = "green", color2 = "yellow", color3 = "red")) |>
  render_scene(lookfrom = c(278, 278, -800) ,lookat = c(278, 278, 0), fov = 40,
               ambient_light = FALSE, samples = 16, parallel = TRUE, clamp_value = 5)

Tween

Description

Tween

Usage

tween(vals, n, ease = "cubic", closed = FALSE)

Arguments

Value

number

Interpolate Camera Orientation with a Quaternion Spline