bricks_from_excel: Convert an Excel 'brickr' template into a 3D object
In ryantimpe/brickr: Emulate LEGO Bricks in 2D and 3D

bricks_from_excel

R Documentation

Convert an Excel 'brickr' template into a 3D object

Description

Build a 3D model from an Excel template. A single data frame includes both the instructions and the color guides.

Usage

bricks_from_excel(
  excel_table,
  piece_table = NULL,
  use_bricks = NULL,
  repeat_levels = 1,
  increment_level = 0,
  min_level = 1,
  max_level = Inf,
  increment_x = 0,
  max_x = Inf,
  increment_y = 0,
  max_y = Inf,
  exclude_color = NULL,
  exclude_level = NULL
)

Arguments

`excel_table`	Sheet imported from a brickr Excel template to build model. This differs slightly from `bricks_from_table` because a single data frame has both the brick coordinates and color table.
`piece_table`	Sheet identical in shape to `excel_table` with piece shape IDs.
`use_bricks`	Array of brick sizes to use in mosaic. Defaults to `c('4x2', '3x2', '2x2', '3x1', '2x1', '1x1')`'.
`repeat_levels`	How many times to repeat a level. Can save time in model planning. Default is 1.
`increment_level`	Default '0'. Use in animations. Shift Level/z dimension by an integer.
`min_level`	Default '1'. Use in animations. Any Level/z values below this value will be cut off.
`max_level`	Default 'Inf'. Use in animations. Any Level/z values above this value will be cut off.
`increment_x`	Default '0'. Use in animations. Shift x dimension by an integer.
`max_x`	Default 'Inf'. Use in animations. Any x values above this value will be cut off.
`increment_y`	Default '0'. Use in animations. Shift y dimension by an integer.
`max_y`	Default 'Inf'. Use in animations. Any y values above this value will be cut off.
`exclude_color`	Numeric array of color ID numbers to exclude.
`exclude_level`	Numeric array of Level/z dimensions to exclude.

Value

A list with elements Img_lego to pass to build_bricks.

Examples

#This creates a 1x3 red brick.
demo_excel <- tibble::tribble(
~Level, ~"1", ~"2", ~"3", ~user_color, ~LEGO_color,
 "A",  1,  1,  1,           1, "Bright red" 
)

demo_excel %>% 
 bricks_from_excel() %>% 
 build_bricks()
 
 rgl::clear3d()
 
#To change the pieces, import a second table in the same shape, but with piece IDs.
demo_pieces <- tibble::tribble(
~Level, ~"1", ~"2", ~"3",
 "A",  "w4",  "c1",  "w2"    
)

demo_excel %>% 
 bricks_from_excel(piece_table = demo_pieces) %>% 
 build_bricks()
 
 rgl::clear3d()

ryantimpe/brickr documentation built on Jan. 15, 2024, 10:29 p.m.