render_raymesh: Render Raymesh
In tylermorganwall/rayshader: Create Maps and Visualize Data in 2D and 3D

render_raymesh

R Documentation

Render Raymesh

Description

Adds 3D raymesh model to the current scene, using latitude/longitude or coordinates in the reference system defined by the extent object. If no altitude is provided, the raymesh will be elevated a constant offset above the heightmap. If the raymesh goes off the edge, the raymesh will be filtered out.

If no latitudes or longitudes are passed in, the raymesh will be plotted in the coordinate system set by the user-specified 'extent' argument as-is. Use this alongside 'save_multipolygonz_to_obj()' to plot 3D polygons imported from geospatial sources in the proper location (but for ease of use, use 'render_multipolygonz()' to plot this data directly).

Usage

render_raymesh(
  raymesh,
  extent = NULL,
  lat = NULL,
  long = NULL,
  altitude = NULL,
  xyz = NULL,
  zscale = 1,
  heightmap = NULL,
  load_normals = TRUE,
  change_material = TRUE,
  color = "grey50",
  offset = 0,
  obj_zscale = FALSE,
  swap_yz = NULL,
  angle = c(0, 0, 0),
  scale = c(1, 1, 1),
  clear_previous = FALSE,
  baseshape = "rectangle",
  flat_shading = FALSE,
  lit = FALSE,
  light_altitude = c(45, 30),
  light_direction = c(315, 135),
  light_intensity = 1,
  light_relative = FALSE,
  rgl_tag = "",
  ...
)

Arguments

`raymesh`	'raymesh' object (see the rayvertex package for a description)
`extent`	Either an object representing the spatial extent of the scene (either from the 'raster', 'terra', 'sf', or 'sp' packages), a length-4 numeric vector specifying 'c("xmin", "xmax","ymin","ymax")', or the spatial object (from the previously aforementioned packages) which will be automatically converted to an extent object.
`lat`	Vector of latitudes (or other coordinate in the same coordinate reference system as extent).
`long`	Vector of longitudes (or other coordinate in the same coordinate reference system as extent).
`altitude`	Default 'NULL'. Elevation of each point, in units of the elevation matrix (scaled by 'zscale'). If left 'NULL', this will be just the elevation value at ths surface, offset by 'offset'. If a single value, the OBJ will be rendered at that altitude.
`xyz`	Default 'NULL', ignored. A 3 column numeric matrix, with each row specifying the x/y/z coordinates of the OBJ model(s). Overrides lat/long/altitude and ignores extent to plot the OBJ in raw rgl coordinates.
`zscale`	Default '1'. The ratio between the x and y spacing (which are assumed to be equal) and the z axis in the original heightmap.
`heightmap`	Default 'NULL'. Automatically extracted from the rgl window–only use if auto-extraction of matrix extent isn't working. A two-dimensional matrix, where each entry in the matrix is the elevation at that point. All points are assumed to be evenly spaced.
`load_normals`	Default 'TRUE'. Whether to load normals for the 3D model.
`change_material`	Default 'TRUE'. Whether to change the raymesh material (to customize the color).
`color`	Default 'black'. Color of the 3D model, if 'load_material = FALSE'.
`offset`	Default '5'. Offset of the track from the surface, if 'altitude = NULL'.
`obj_zscale`	Default 'FALSE'. Whether to scale the size of the OBJ by zscale to have it match the size of the map. If zscale is very big, this will make the model very small.
`swap_yz`	Default 'NULL', defaults to 'FALSE' unless plotting raw coordinates (no lat or long passed). Whether to swap and Y and Z axes. (Y axis is vertical in rayshader coordinates, but data is often provided with Z being vertical).
`angle`	Default 'c(0,0,0)'. Angle of rotation around the x, y, and z axes. If this is a matrix or list, each row (or list entry) specifies the rotation of the nth model specified (number of rows/length of list must equal the length of 'lat'/'long').
`scale`	Default 'c(1,1,1)'. Amount to scale the 3D model in the x, y, and z axes. If this is a matrix or list, each row (or list entry) specifies the scale of the nth model specified (number of rows/length of list must equal the length of 'lat'/'long').
`clear_previous`	Default 'FALSE'. If 'TRUE', it will clear all existing points.
`baseshape`	Default 'rectangle'. Shape of the base. Options are 'c("rectangle","circle","hex")'.
`flat_shading`	Default ‘FALSE'. If 'TRUE', this will use rgl’s flat shading.
`lit`	Default 'TRUE'. Whether to light the polygons.
`light_altitude`	Default 'c(45, 60)'. Degree(s) from the horizon from which to light the polygons.
`light_direction`	Default 'c(45, 60)'. Degree(s) from north from which to light the polygons.
`light_intensity`	Default '0.3'. Intensity of the specular highlight on the polygons.
`light_relative`	Default 'FALSE'. Whether the light direction should be taken relative to the camera, or absolute.
`rgl_tag`	Default '""'. Tag to add to the rgl scene id, will be prefixed by '"objraymsh"'
`...`	Additional arguments to pass to 'rgl::triangles3d()'.