rayshader v0.38.8: Update to new required rayimage/rayvertex versions…

… to use more robust 3D text generation

-Fix bug where DEMs with an edge of NA values had the incorrect extent calculated when plotting points

DESCRIPTION

@@ -1,8 +1,8 @@
 Package: rayshader
 Type: Package
 Title: Create Maps and Visualize Data in 2D and 3D
-Version: 0.38.7
-Date: 2024-12-28
+Version: 0.38.8
+Date: 2025-01-02
 Authors@R: 
     person("Tyler", "Morgan-Wall", email = "[email protected]",role = c("aut", "cph", "cre"), 
            comment = c(ORCID = "0000-0002-3131-3814"))
@@ -26,9 +26,9 @@ Imports: doParallel,
          utils,
          methods,
          terrainmeshr,
-         rayimage (>= 0.14.4),
-         rayvertex (>= 0.11.4),
-         rayrender (>= 0.36.5)
+         rayimage (>= 0.15.1),
+         rayvertex (>= 0.12.0),
+         rayrender (>= 0.38.2)
 Suggests: 
     reshape2,
     viridis,

R/add_overlay.R

@@ -83,8 +83,8 @@ add_overlay = function(hillshade = NULL, overlay = NULL, alphalayer = 1, alphaco
     return(hillshade)
   }
   if(length(dim(hillshade)) == 2) {
-    rayimage::add_image_overlay(fliplr(t(hillshade)),overlay,alpha=alphalayer, rescale_original = rescale_original)
+    rayimage::render_image_overlay(fliplr(t(hillshade)),overlay,alpha=alphalayer, rescale_original = rescale_original)
   } else {
-    rayimage::add_image_overlay(hillshade,overlay,alpha=alphalayer, rescale_original = rescale_original)
+    rayimage::render_image_overlay(hillshade,overlay,alpha=alphalayer, rescale_original = rescale_original)
   }
 }

R/get_ids_with_labels.R

@@ -48,12 +48,19 @@ get_ids_with_labels = function(typeval = NULL) {
     material_properties[[i]]$obj_specular = NA_character_
     material_properties[[i]]$obj_emission = NA_character_
     material_properties[[i]]$shininess = NA
+    material_properties[[i]]$shininess = NA
+    material_properties[[i]]$nrow = NA
+    material_properties[[i]]$ncol = NA
 
 
 
     if(idvals$type[i] != "text") {
       if(substr(material_type[i],1,7) == "surface") {
         material_properties[[i]]$texture_file = material_type_single$texture
+        dim_string = strsplit(material_type[i], "-")[[1]][2]
+        dim_dem = as.integer(unlist(strsplit(dim_string,"_")[[1]])[2:3])
+        material_properties[[i]]$nrow = dim_dem[1]
+        material_properties[[i]]$ncol = dim_dem[2]
       } 
       if(material_type[i] %in% c("floating_overlay", "floating_overlay_tris")) {
         material_properties[[i]]$layer_texture_file = material_type_single$texture

R/make_base.R

@@ -186,12 +186,5 @@ make_base = function(heightmap,basedepth=0,basecolor="grey20",zscale=1, soil = F
                      color=basecolor,back="cull", front="filled",
                      lit=FALSE,texture=NULL,tag = "basebottom")
 
-    # rgl::surface3d(x=1:nrow(basemat)-1-(nr-1)/2,
-    #                z=1:ncol(basemat)-1-(nc-1)/2,
-    #                y=basemat,
-    #                color=basecolor, 
-    #                lit=FALSE,back="cull",front="filled",tag = "basebottom",
-    #                normal_x = xznormals, normal_z = xznormals, normal_y = ynormals)
-
   }
 }

R/plot_3d.R

@@ -306,6 +306,7 @@ plot_3d = function(hillshade, heightmap, zscale=1, baseshape="rectangle",
   }
   rgl::view3d(zoom = zoom, phi = phi, theta = theta, fov = fov)
   attributes(heightmap) = attributes(heightmap)["dim"]
+  tag_surface = sprintf("surface_tris-dim_%i_%i", nrow(heightmap),ncol(heightmap))
   if(!triangulate) {
     if(!precomputed) {
       normals = calculate_normal(heightmap, zscale = zscale)
@@ -324,7 +325,7 @@ plot_3d = function(hillshade, heightmap, zscale=1, baseshape="rectangle",
                      indices = ray_surface$inds, 
                      texcoords = ray_surface$texcoords, 
                      normals = matrix(c(normalsz,normalsy,-normalsx), ncol = 3L),
-                     texture = tempmap, color="white", lit = FALSE, tag = "surface_tris",
+                     texture = tempmap, color="white", lit = FALSE, tag = tag_surface,
                      back = "culled")
   } else {
     tris = terrainmeshr::triangulate_matrix(heightmap, maxError = max_error, 
@@ -350,10 +351,11 @@ plot_3d = function(hillshade, heightmap, zscale=1, baseshape="rectangle",
     tris[,1] = tris[,1] - (nr-1)/2# +1
     tris[,3] = tris[,3] - (nc-1)/2
     tris[,3] = -tris[,3]
+
     rgl::triangles3d(tris, texcoords = texcoords, 
                      indices = index_vals, back = "cull",
                      #normals = normal_comp,
-                     texture=tempmap,lit=FALSE,color="white",tag = "surface_tris")
+                     texture=tempmap,lit=FALSE,color="white",tag = tag_surface)
   }
   rgl::bg3d(color = background,texture=NULL)
   if(solid && !triangulate) {

R/plot_map.R

@@ -87,7 +87,7 @@ plot_map = function(hillshade, rotate=0, asp = 1,
       }
     }
     if(has_title) {
-      hillshade = rayimage::add_title(hillshade, title_text = title_text, title_offset = title_offset,
+      hillshade = rayimage::render_title(hillshade, title_text = title_text, title_offset = title_offset,
                           title_color = title_color, title_size = title_size,
                           title_font = title_font, title_style = title_style,
                           title_bar_color = title_bar_color, title_bar_alpha = title_bar_alpha, 
@@ -102,7 +102,7 @@ plot_map = function(hillshade, rotate=0, asp = 1,
     }
     array_from_mat = array(fliplr(t(hillshade)),dim=c(ncol(hillshade),nrow(hillshade),3))
     if(has_title) {
-      array_from_mat = rayimage::add_title(array_from_mat, title_text = title_text, title_offset = title_offset,
+      array_from_mat = rayimage::render_title(array_from_mat, title_text = title_text, title_offset = title_offset,
                           title_color = title_color, title_size = title_size,
                           title_font = title_font, title_style = title_style,
                           title_bar_color = title_bar_color, title_bar_alpha = title_bar_alpha, 

R/render_depth.R

@@ -309,14 +309,14 @@ render_depth = function(focus = NULL, focallength = 100, fstop = 4, filename=NUL
     }
     dimensions = dim(tempmap)
     if(has_overlay) {
-      tempmap = rayimage::add_image_overlay(tempmap, image_overlay = image_overlay_file)
+      tempmap = rayimage::render_image_overlay(tempmap, image_overlay = image_overlay_file)
     }
     if(vignette || is.numeric(vignette)) {
-      tempmap = rayimage::add_vignette(tempmap, vignette = vignette, color = vignette_color,
+      tempmap = rayimage::render_vignette(tempmap, vignette = vignette, color = vignette_color,
                                        radius = vignette_radius)
     }
     if(has_title) {
-      tempmap = rayimage::add_title(tempmap, title_text = title_text, 
+      tempmap = rayimage::render_title(tempmap, title_text = title_text, 
                           title_bar_color = title_bar_color,title_bar_alpha = title_bar_alpha,
                           title_offset = title_offset, title_color = title_color,
                           title_position = title_position,

R/render_highquality.R

@@ -640,13 +640,13 @@ render_highquality = function(filename = NA, samples = 128,
     if(has_title) {
       if(is.na(filename)) {
         temp = rayimage::ray_read_image(temp)
-        rayimage::add_title(temp, title_text = title_text, title_color = title_color, 
+        rayimage::render_title(temp, title_text = title_text, title_color = title_color, 
                             title_font = title_font, title_offset = title_offset, 
                             title_bar_alpha =  title_bar_alpha, title_bar_color = title_bar_color,
                             title_size = title_size, preview = TRUE)
       } else {
         temp = rayimage::ray_read_image(temp)
-        rayimage::add_title(temp, title_text = title_text, title_color = title_color, 
+        rayimage::render_title(temp, title_text = title_text, title_color = title_color, 
                             title_font = title_font, title_offset = title_offset, 
                             title_bar_alpha =  title_bar_alpha, title_bar_color = title_bar_color,
                             title_size = title_size, filename = filename)

R/render_movie.R

@@ -206,7 +206,7 @@ render_movie = function(filename, type = "orbit", frames = 360, fps = 30,
       if(progbar) {
         pb$tick()
       }
-      rayimage::add_image_overlay(png_files[i], image_overlay = image_overlay_file,
+      rayimage::render_image_overlay(png_files[i], image_overlay = image_overlay_file,
                                             filename = png_files[i])
     }
   }
@@ -223,7 +223,7 @@ render_movie = function(filename, type = "orbit", frames = 360, fps = 30,
       if(progbar) {
         pb$tick()
       }
-      rayimage::add_vignette(png_files[i], vignette = vignette, filename = png_files[i], 
+      rayimage::render_vignette(png_files[i], vignette = vignette, filename = png_files[i], 
                              color = vignette_color,
                              radius = vignette_radius)
     }
@@ -241,7 +241,7 @@ render_movie = function(filename, type = "orbit", frames = 360, fps = 30,
       if(progbar) {
         pb$tick()
       }
-      rayimage::add_title(png_files[i], filename = png_files[i], title_text = title_text, 
+      rayimage::render_title(png_files[i], filename = png_files[i], title_text = title_text, 
                           title_bar_color = title_bar_color,title_bar_alpha = title_bar_alpha,
                           title_offset = title_offset, title_color = title_color,
                           title_position = title_position,

R/render_snapshot.R

@@ -194,14 +194,14 @@ render_snapshot = function(filename, clear=FALSE,
   }
   tempmap = png::readPNG(temp)
   if(has_overlay) {
-    tempmap = rayimage::add_image_overlay(tempmap, image_overlay = image_overlay_file)
+    tempmap = rayimage::render_image_overlay(tempmap, image_overlay = image_overlay_file)
   }
   if(vignette || is.numeric(vignette)) {
-    tempmap = rayimage::add_vignette(tempmap, vignette = vignette, color = vignette_color,
+    tempmap = rayimage::render_vignette(tempmap, vignette = vignette, color = vignette_color,
                                      radius = vignette_radius)
   }
   if(has_title) {
-    tempmap = rayimage::add_title(tempmap, title_text = title_text, 
+    tempmap = rayimage::render_title(tempmap, title_text = title_text, 
                                   title_bar_color = title_bar_color,title_bar_alpha = title_bar_alpha,
                                   title_offset = title_offset, title_color = title_color,
                                   title_position = title_position,

R/save_png.R

@@ -69,7 +69,7 @@ save_png = function(hillshade, filename,
     final[,,3] = hillshade
 
     if(has_title) {
-      final = rayimage::add_title(final, title_text = title_text, title_offset = title_offset,
+      final = rayimage::render_title(final, title_text = title_text, title_offset = title_offset,
                                            title_color = title_color, title_size = title_size,
                                            title_font = title_font, title_style = title_style,
                                            title_bar_color = title_bar_color, title_bar_alpha = title_bar_alpha, 
@@ -107,7 +107,7 @@ save_png = function(hillshade, filename,
       hillshade = temp_hillshade
     }
     if(has_title) {
-      hillshade = rayimage::add_title(hillshade, title_text = title_text, title_offset = title_offset,
+      hillshade = rayimage::render_title(hillshade, title_text = title_text, title_offset = title_offset,
                                   title_color = title_color, title_size = title_size,
                                   title_font = title_font, title_style = title_style,
                                   title_bar_color = title_bar_color, title_bar_alpha = title_bar_alpha, 

R/transform_into_heightmap_coords.R

@@ -17,14 +17,13 @@ transform_into_heightmap_coords = function(extent, heightmap, lat = NULL, long =
   if(is.null(long)) {
     long = (e["xmax"] + e["xmin"])/2
   }
-  if(is.null(heightmap)) {
-    vertex_info = get_ids_with_labels(typeval = c("surface", "surface_tris"))
-    nrow_map = max(rgl::rgl.attrib(vertex_info$id[1], "vertices")[,1]) - min(rgl::rgl.attrib(vertex_info$id[1], "vertices")[,1])
-    ncol_map = max(rgl::rgl.attrib(vertex_info$id[1], "vertices")[,3]) - min(rgl::rgl.attrib(vertex_info$id[1], "vertices")[,3])
-  } else {
-    ncol_map = ncol(heightmap)
-    nrow_map = nrow(heightmap)
+  vertex_info = get_ids_with_labels(typeval = "surface_tris")
+  if(nrow(vertex_info) > 1) {
+    warning("Multiple surfaces detected: only using the first surface to transform coords")
   }
+  ncol_map = vertex_info$ncol[[1]]
+  nrow_map = vertex_info$nrow[[1]]
+
   nrow_map = nrow_map - 1
   ncol_map = ncol_map - 1
   distances_x = (long-e["xmin"])/(e["xmax"] - e["xmin"]) * nrow_map + 1
@@ -67,6 +66,9 @@ transform_into_heightmap_coords = function(extent, heightmap, lat = NULL, long =
   } else {
     matrix_vals = (matrix(c(distances_x-nrow_map/2-1, offset, distances_y-ncol_map/2-1),ncol=3,nrow=length(altitude)))
   }
+  if(any(is.na(matrix_vals[,2]))) {
+    warning("Some coords outside of heightmap extent--the altitude of those points have been set to the heightmap minimum.")
+  }
   matrix_vals[is.na(matrix_vals[,2]),] = min(matrix_vals[,2], na.rm=TRUE)
   return(matrix_vals)
 }

R/transform_sf_to_raycoords.R

@@ -6,16 +6,13 @@ transform_polygon_into_raycoords = function(polygon, heightmap = NULL, e = NULL,
   if(inherits(polygon,"SpatialPolygonsDataFrame") || inherits(polygon,"SpatialPolygons")) {
     polygon = sf::st_as_sf(polygon)
   }
-  if(is.null(heightmap)) {
-    vertex_info = get_ids_with_labels(typeval = c("surface", "surface_tris"))
-    nrow_map = max(rgl::rgl.attrib(vertex_info$id[1], "vertices")[,1]) -
-      min(rgl::rgl.attrib(vertex_info$id[1], "vertices")[,1])
-    ncol_map = max(rgl::rgl.attrib(vertex_info$id[1], "vertices")[,3]) -
-      min(rgl::rgl.attrib(vertex_info$id[1], "vertices")[,3])
-  } else {
-    ncol_map = ncol(heightmap)
-    nrow_map = nrow(heightmap)
+  vertex_info = get_ids_with_labels(typeval = "surface_tris")
+  if(nrow(vertex_info) > 1) {
+    warning("Multiple surfaces detected: only using the first surface to transform coords")
   }
+  ncol_map = vertex_info$ncol[1]
+  nrow_map = vertex_info$nrow[1]
+
   ncol_map = ncol_map - 1
   nrow_map = nrow_map - 1
 
@@ -54,16 +51,22 @@ transform_polygon_into_raycoords = function(polygon, heightmap = NULL, e = NULL,
 #'@keywords internal
 transform_points_into_raycoords = function(points, heightmap = NULL, e = NULL, 
                                            top = NULL, bottom = NULL) {
-  if(is.null(heightmap)) {
-    vertex_info = get_ids_with_labels(typeval = c("surface", "surface_tris"))
-    nrow_map = max(rgl::rgl.attrib(vertex_info$id[1], "vertices")[,1]) -
-      min(rgl::rgl.attrib(vertex_info$id[1], "vertices")[,1])
-    ncol_map = max(rgl::rgl.attrib(vertex_info$id[1], "vertices")[,3]) -
-      min(rgl::rgl.attrib(vertex_info$id[1], "vertices")[,3])
-  } else {
-    ncol_map = ncol(heightmap)
-    nrow_map = nrow(heightmap)
+  vertex_info = get_ids_with_labels(typeval = "surface_tris")
+  if(nrow(vertex_info) > 1) {
+    warning("Multiple surfaces detected: only using the first surface to transform coords")
   }
+  ncol_map = vertex_info$ncol[1]
+  nrow_map = vertex_info$nrow[1]
+  # if(is.null(heightmap)) {
+  #   vertex_info = get_ids_with_labels(typeval = c("surface", "surface_tris"))
+  #   nrow_map = max(rgl::rgl.attrib(vertex_info$id[1], "vertices")[,1]) -
+  #     min(rgl::rgl.attrib(vertex_info$id[1], "vertices")[,1])
+  #   ncol_map = max(rgl::rgl.attrib(vertex_info$id[1], "vertices")[,3]) -
+  #     min(rgl::rgl.attrib(vertex_info$id[1], "vertices")[,3])
+  # } else {
+  #   ncol_map = ncol(heightmap)
+  #   nrow_map = nrow(heightmap)
+  # }
   ncol_map = ncol_map - 1
   nrow_map = nrow_map - 1 
   if(inherits(points,"sf")) {