mirror of
https://github.com/ryantimpe/brickr.git
synced 2026-01-01 19:29:29 -06:00
318 lines
17 KiB
HTML
318 lines
17 KiB
HTML
<!-- Generated by pkgdown: do not edit by hand -->
|
|
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>Convert a table into a 'brickr' 3D object — bricks_from_table • brickr</title>
|
|
|
|
<!-- favicons -->
|
|
<link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png">
|
|
<link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png">
|
|
<link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png" />
|
|
<link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png" />
|
|
<link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png" />
|
|
<link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png" />
|
|
|
|
<!-- jquery -->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
|
|
<!-- Bootstrap -->
|
|
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous" />
|
|
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script>
|
|
|
|
<!-- bootstrap-toc -->
|
|
<link rel="stylesheet" href="../bootstrap-toc.css">
|
|
<script src="../bootstrap-toc.js"></script>
|
|
|
|
<!-- Font Awesome icons -->
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous" />
|
|
|
|
<!-- clipboard.js -->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script>
|
|
|
|
<!-- headroom.js -->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script>
|
|
|
|
<!-- pkgdown -->
|
|
<link href="../pkgdown.css" rel="stylesheet">
|
|
<script src="../pkgdown.js"></script>
|
|
|
|
|
|
|
|
<link href="../extra.css" rel="stylesheet">
|
|
|
|
|
|
<meta property="og:title" content="Convert a table into a 'brickr' 3D object — bricks_from_table" />
|
|
<meta property="og:description" content="Create a 3D brick object from a data frame. Left-most column is level/height/z dimension, with rows as Y axis and columns as X axis." />
|
|
<meta property="og:image" content="http://brickr.org/logo.png" />
|
|
|
|
|
|
|
|
|
|
<!-- mathjax -->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script>
|
|
|
|
<!--[if lt IE 9]>
|
|
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
|
|
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
|
<![endif]-->
|
|
|
|
|
|
|
|
</head>
|
|
|
|
<body data-spy="scroll" data-target="#toc">
|
|
<div class="container template-reference-topic">
|
|
<header>
|
|
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
<span class="navbar-brand">
|
|
<a class="navbar-link" href="../index.html">brickr</a>
|
|
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.3.4</span>
|
|
</span>
|
|
</div>
|
|
|
|
<div id="navbar" class="navbar-collapse collapse">
|
|
<ul class="nav navbar-nav">
|
|
<li>
|
|
<a href="../index.html">
|
|
<span class="fas fa fas fa-home fa-lg"></span>
|
|
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../reference/index.html">Reference</a>
|
|
</li>
|
|
<li>
|
|
<a href="../articles/index.html">Articles</a>
|
|
</li>
|
|
<li>
|
|
<a href="../news/index.html">Changelog</a>
|
|
</li>
|
|
</ul>
|
|
<ul class="nav navbar-nav navbar-right">
|
|
<li>
|
|
<a href="https://github.com/ryantimpe/brickr/">
|
|
<span class="fab fa fab fa-github fa-lg"></span>
|
|
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
|
|
</div><!--/.nav-collapse -->
|
|
</div><!--/.container -->
|
|
</div><!--/.navbar -->
|
|
|
|
|
|
|
|
</header>
|
|
|
|
<div class="row">
|
|
<div class="col-md-9 contents">
|
|
<div class="page-header">
|
|
<h1>Convert a table into a 'brickr' 3D object</h1>
|
|
<small class="dont-index">Source: <a href='https://github.com/ryantimpe/brickr/blob/master/R/bricks-from-tables.R'><code>R/bricks-from-tables.R</code></a></small>
|
|
<div class="hidden name"><code>bricks_from_table.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description">
|
|
<p>Create a 3D brick object from a data frame. Left-most column is level/height/z dimension, with rows as Y axis and columns as X axis.</p>
|
|
</div>
|
|
|
|
<pre class="usage"><span class='fu'>bricks_from_table</span>(
|
|
<span class='no'>matrix_table</span>,
|
|
<span class='kw'>color_guide</span> <span class='kw'>=</span> <span class='kw pkg'>brickr</span><span class='kw ns'>::</span><span class='no'><a href='lego_colors.html'>lego_colors</a></span>,
|
|
<span class='kw'>piece_matrix</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
|
|
<span class='kw'>use_bricks</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
|
|
<span class='kw'>.re_level</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>,
|
|
<span class='kw'>increment_level</span> <span class='kw'>=</span> <span class='fl'>0</span>,
|
|
<span class='kw'>min_level</span> <span class='kw'>=</span> <span class='fl'>1</span>,
|
|
<span class='kw'>max_level</span> <span class='kw'>=</span> <span class='fl'>Inf</span>,
|
|
<span class='kw'>increment_x</span> <span class='kw'>=</span> <span class='fl'>0</span>,
|
|
<span class='kw'>max_x</span> <span class='kw'>=</span> <span class='fl'>Inf</span>,
|
|
<span class='kw'>increment_y</span> <span class='kw'>=</span> <span class='fl'>0</span>,
|
|
<span class='kw'>max_y</span> <span class='kw'>=</span> <span class='fl'>Inf</span>,
|
|
<span class='kw'>exclude_color</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
|
|
<span class='kw'>exclude_level</span> <span class='kw'>=</span> <span class='kw'>NULL</span>
|
|
)</pre>
|
|
|
|
<h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
|
|
<table class="ref-arguments">
|
|
<colgroup><col class="name" /><col class="desc" /></colgroup>
|
|
<tr>
|
|
<th>matrix_table</th>
|
|
<td><p>A data frame of a 3D brick model design. Left-most column is level/height/z dimension, with rows as Y axis and columns as X axis. See example. Use <code><a href='https://tibble.tidyverse.org/reference/tribble.html'>tribble</a></code> for ease.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>color_guide</th>
|
|
<td><p>A data frame linking numeric <code>.value</code> in <code>matrix_table</code> to official LEGO color names. Defaults to data frame 'lego_colors'.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>piece_matrix</th>
|
|
<td><p>A data frame in same shape as <code>matrix_table</code> with piece shape IDs.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>use_bricks</th>
|
|
<td><p>Array of brick sizes to use in mosaic. Defaults to <code><a href='https://rdrr.io/r/base/c.html'>c('4x2', '2x2', '3x1', '2x1', '1x1')</a></code>`. '1x1' will always be considered.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>.re_level</th>
|
|
<td><p>Logical to reassign the Level/z dimension to layers in alphanumeric order. Set to FALSE to explicitly provide levels.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>increment_level</th>
|
|
<td><p>Default '0'. Use in animations. Shift Level/z dimension by an integer.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>min_level</th>
|
|
<td><p>Default '1'. Use in animations. Any Level/z values below this value will be cut off.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>max_level</th>
|
|
<td><p>Default 'Inf'. Use in animations. Any Level/z values above this value will be cut off.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>increment_x</th>
|
|
<td><p>Default '0'. Use in animations. Shift x dimension by an integer.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>max_x</th>
|
|
<td><p>Default 'Inf'. Use in animations. Any x values above this value will be cut off.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>increment_y</th>
|
|
<td><p>Default '0'. Use in animations. Shift y dimension by an integer.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>max_y</th>
|
|
<td><p>Default 'Inf'. Use in animations. Any y values above this value will be cut off.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>exclude_color</th>
|
|
<td><p>Numeric array of color ID numbers to exclude.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>exclude_level</th>
|
|
<td><p>Numeric array of Level/z dimensions to exclude.</p></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
|
|
|
|
<p>A list with elements <code>Img_lego</code> to pass to <code><a href='build_bricks.html'>build_bricks</a></code>.</p>
|
|
<h2 class="hasAnchor" id="see-also"><a class="anchor" href="#see-also"></a>See also</h2>
|
|
|
|
<div class='dont-index'><p>Other 3D Models:
|
|
<code><a href='bricks_from_coords.html'>bricks_from_coords</a>()</code>,
|
|
<code><a href='bricks_from_excel.html'>bricks_from_excel</a>()</code>,
|
|
<code><a href='bricks_from_mosaic.html'>bricks_from_mosaic</a>()</code>,
|
|
<code><a href='build_bricks.html'>build_bricks</a>()</code></p></div>
|
|
|
|
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
|
|
<pre class="examples"><div class='input'><span class='co'>#This is a 4x2 brick. One level high, 2 x-values (columns), 4 y-values (rows).</span>
|
|
<span class='no'>brick</span> <span class='kw'><-</span> <span class='fu'><a href='https://rdrr.io/r/base/data.frame.html'>data.frame</a></span>(
|
|
<span class='kw'>Level</span><span class='kw'>=</span><span class='st'>"A"</span>,
|
|
<span class='kw'>X1</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/rep.html'>rep</a></span>(<span class='fl'>3</span>,<span class='fl'>4</span>), <span class='co'>#The number 3 is the brickrID for 'bright red'</span>
|
|
<span class='kw'>X2</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/rep.html'>rep</a></span>(<span class='fl'>3</span>,<span class='fl'>4</span>)
|
|
)
|
|
|
|
<span class='no'>brick</span> <span class='kw'>%>%</span>
|
|
<span class='fu'>bricks_from_table</span>() <span class='kw'>%>%</span>
|
|
<span class='fu'><a href='build_bricks.html'>build_bricks</a></span>()
|
|
|
|
<span class='kw pkg'>rgl</span><span class='kw ns'>::</span><span class='fu'><a href='https://rdrr.io/pkg/rgl/man/scene.html'>clear3d</a></span>()
|
|
|
|
<span class='co'>#Build on top of each other by changing the Level value.</span>
|
|
<span class='co'>#This example builds a blue 2x2 brick on top of a red 2x2</span>
|
|
<span class='no'>brick</span> <span class='kw'><-</span> <span class='fu'><a href='https://rdrr.io/r/base/data.frame.html'>data.frame</a></span>(
|
|
<span class='kw'>Level</span><span class='kw'>=</span><span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='st'>"A"</span>, <span class='st'>"A"</span>, <span class='st'>"B"</span>, <span class='st'>"B"</span>),
|
|
<span class='kw'>X1</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='fl'>3</span>, <span class='fl'>3</span>, <span class='fl'>4</span>, <span class='fl'>4</span>), <span class='co'>#3 is red, 4 is blue</span>
|
|
<span class='kw'>X2</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='fl'>3</span>, <span class='fl'>3</span>, <span class='fl'>4</span>, <span class='fl'>4</span>)
|
|
)
|
|
|
|
<span class='no'>brick</span> <span class='kw'>%>%</span>
|
|
<span class='fu'>bricks_from_table</span>() <span class='kw'>%>%</span>
|
|
<span class='fu'><a href='build_bricks.html'>build_bricks</a></span>()
|
|
|
|
<span class='kw pkg'>rgl</span><span class='kw ns'>::</span><span class='fu'><a href='https://rdrr.io/pkg/rgl/man/scene.html'>clear3d</a></span>()
|
|
|
|
<span class='co'>#Provide an additional piece_matrix argument to change the default brick shape.</span>
|
|
<span class='no'>pieces</span> <span class='kw'><-</span> <span class='fu'><a href='https://rdrr.io/r/base/data.frame.html'>data.frame</a></span>(
|
|
<span class='kw'>Level</span><span class='kw'>=</span><span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='st'>"A"</span>, <span class='st'>"A"</span>, <span class='st'>"B"</span>, <span class='st'>"B"</span>),
|
|
<span class='kw'>X1</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='st'>"b"</span>, <span class='st'>"b"</span>, <span class='st'>"p"</span>, <span class='st'>"p"</span>), <span class='co'>#b is brick (default), p is plate</span>
|
|
<span class='kw'>X2</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='st'>"b"</span>, <span class='st'>"b"</span>, <span class='st'>"p"</span>, <span class='st'>"p"</span>)
|
|
)
|
|
|
|
<span class='co'># \donttest{</span>
|
|
<span class='no'>brick</span> <span class='kw'>%>%</span>
|
|
<span class='fu'>bricks_from_table</span>(<span class='kw'>piece_matrix</span><span class='kw'>=</span><span class='no'>pieces</span>) <span class='kw'>%>%</span>
|
|
<span class='fu'><a href='build_bricks.html'>build_bricks</a></span>()
|
|
|
|
<span class='kw pkg'>rgl</span><span class='kw ns'>::</span><span class='fu'><a href='https://rdrr.io/pkg/rgl/man/scene.html'>clear3d</a></span>()
|
|
<span class='co'># }</span>
|
|
|
|
<span class='co'>#Provide a custom table of colors </span>
|
|
<span class='no'>custom_colors</span> <span class='kw'><-</span> <span class='fu'><a href='https://rdrr.io/r/base/data.frame.html'>data.frame</a></span>(
|
|
<span class='kw'>.value</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='fl'>3</span>, <span class='fl'>4</span>),
|
|
<span class='kw'>Color</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='st'>"Bright orange"</span>, <span class='st'>"Dark green"</span>)
|
|
)
|
|
|
|
<span class='co'># \donttest{</span>
|
|
<span class='no'>brick</span> <span class='kw'>%>%</span>
|
|
<span class='fu'>bricks_from_table</span>(<span class='kw'>color_guide</span> <span class='kw'>=</span> <span class='no'>custom_colors</span>) <span class='kw'>%>%</span>
|
|
<span class='fu'><a href='build_bricks.html'>build_bricks</a></span>()
|
|
|
|
<span class='kw pkg'>rgl</span><span class='kw ns'>::</span><span class='fu'><a href='https://rdrr.io/pkg/rgl/man/scene.html'>clear3d</a></span>()
|
|
<span class='co'># }</span>
|
|
|
|
<span class='co'>#Limit the size of bricks used in the model with use_bricks</span>
|
|
<span class='co'># \donttest{</span>
|
|
<span class='no'>brick</span> <span class='kw'>%>%</span>
|
|
<span class='fu'>bricks_from_table</span>(<span class='kw'>use_bricks</span> <span class='kw'>=</span> <span class='st'>"2x1"</span>) <span class='kw'>%>%</span> <span class='co'>#Only use 2x1 bricks.</span>
|
|
<span class='fu'><a href='build_bricks.html'>build_bricks</a></span>()
|
|
|
|
<span class='kw pkg'>rgl</span><span class='kw ns'>::</span><span class='fu'><a href='https://rdrr.io/pkg/rgl/man/scene.html'>clear3d</a></span>()
|
|
<span class='co'># }</span></div></pre>
|
|
</div>
|
|
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
|
|
<nav id="toc" data-toggle="toc" class="sticky-top">
|
|
<h2 data-toc-skip>Contents</h2>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<footer>
|
|
<div class="copyright">
|
|
<p>Developed by Ryan Timpe.</p>
|
|
</div>
|
|
|
|
<div class="pkgdown">
|
|
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.5.1.</p>
|
|
</div>
|
|
|
|
</footer>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|
|
|
|
|