brickr (version 0.3.5)

build_instructions: Create instruction manual for a 2D mosaic or 3D model

Description

Render faceted plot of instructions for 2D mosacis or 3D model objects. For mosaics, can specify the number of steps.

Usage

build_instructions(brickr_obj, num_steps = 6)

Arguments

brickr_obj

brickr mosaic or 3D model object.

num_steps

Number of discrete steps in instruction manual, for mosaics only.

Value

A single plot object of steps to build brickr model or mosaic.

Details

Instructions for 2D mosaics are split into sections beginning at the bottom of the image. This makes it easier to follow each row when building an actual brick mosaic.

3D model instructions are displayed one Level (z value) at a time. The current model level is clearly displayed, while the previous level is shows as transparent.

See Also

Other Resources: build_colors(), build_pieces_table(), build_pieces()

Examples

# NOT RUN {
# Import a jpeg or png
 demo_file <- system.file("extdata", "demo_img.jpg", 
                          package = "brickr", mustWork = TRUE)
 demo_image <- jpeg::readJPEG(demo_file)
 
 #Create a mosaic oject 
 
# }
# NOT RUN {
 mosaic <- demo_image %>% 
   image_to_mosaic(img_size = 24)
 
# }
# NOT RUN {
 
 #Rather than drawing the mosaic, use build_instructions() to draw instructions
 
# }
# NOT RUN {
  mosaic %>% 
   build_instructions()
 
# }
# NOT RUN {
#Change the number of steps for more detail
# }
# NOT RUN {
  mosaic %>% 
   build_instructions(num_steps = 9)
 
# }
# NOT RUN {
# }