Limework/biosphere2
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

Updated Shapes (markdown)

bi0qaw 2017-11-21 22:07:55 +01:00
parent ecc1e63c5d
commit 70d0bf9d9c
1 changed files with 10 additions and 122 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

132
Shapes.md

@ -1,126 +1,14 @@
## List of Shapes
* [Circle](#circle)
* [Cube](#cube)
* [Cube Outline](#cube-outline)
* [Helix](#helix)
* [Line](#line)
* [Polygon](#polygon)
* [Polygon Outline](#polygon-outline)
* [RandomSphere](#random-sphere)
* [Sphere](#sphere)
These are all the basic shapes you can get with Biosphere2.
***
All 2D shapes (Circle, Line, Polygon and Polygon Outline) are drawn in the horizontal plane (XZ plane). 3D shapes (Cube, Cube Outline, Helix, Random Sphere and Sphere) have also a y-axis component. The orientation of the axes is always indicated in the bottom left corner of the image. The purple particles show the center of the shape. This is the reference location in the location syntax and the vector 0, 0, 0 for the vector syntax.
* [Circle](circle)
* [Cube](cube)
* [Cube Outline](cube-outline)
* [Helix](helix)
* [Line](line)
* [Polygon](polygon)
* [Polygon Outline](polygon-outline)
* [RandomSphere](random-sphere)
* [Sphere](sphere)
***
## Circle
![](https://i.imgur.com/j51ka40.png)
Creates a list of locations or vectors in the shape of a circle. The amount of points is determined by the density and the circumference of the circle: `points = circumference * density = 2 * radius * PI * density`
### Vector Syntax
`circle with radius %number% and density %number%`
### Location Syntax
`circle at %location% with radius %number% and density %number%`
***
## Cube
![](https://i.imgur.com/b8lKhSQ.png)
Creates a list of locations or vectors in the shape of a cube. The radius determines the distance from the center to one of the vertices. If you want a cube with a certain edge length you have to use the following formula: `radius = edge length * sqrt(3) / 2`
### Vector Syntax
`cube with radius %number%`
### Location Syntax
`cube at %location% with radius %number%`
***
## Cube Outline
![](https://i.imgur.com/pt8KX2O.png)
Creates a list of locations or vectors in the shape of a cube with its edges. The radius determines the distance from the center to one of the vertices. The amount of points is determined by the density and the edge length. `density * edge length = amount of points on one edge`. If you want a cube with a certain edge length you have to use the following formula: `radius = edge length * sqrt(3) / 2`.
### Vector Syntax
`cube outline with radius %number% and density %number%`
### Location Syntax
`cube outline at %location% with radius %number% and density %number%`
***
## Helix
![](https://i.imgur.com/OoLM13C.png)
Creates a list of location or vectors in the shape of a helix. The step value determines the amount of blocks the helix will move upwards during one rotation. A negative step will invert the rotation direction of the helix. The total amount of points is determined by: `points = circumference * height * density = 2 * radius * PI * height * density`
### Vector Syntax
`helix with radius %number%, height %number%, step %number% and density %number%`
### Location Syntax
`helix at %location% with radius %number%, height %number%, step %number% and density %number%`
***
## Line
![](https://i.imgur.com/VOmDpUg.png)
Creates a list of locations or vectors in the shape of a line. The amount of points is determined by the density and the length of the line: `points = density * length`. `line with length %number% and density %number%` returns always a line in the positive x-direction (yaw = -90).
### Vector Syntax
```
line with length %number% and density %number%
vector line from %vector% to %vector% with density %number%
```
### Location Syntax
`line from %location% to %location% with density %number%`
***
## Polygon
![](https://i.imgur.com/Qit4MDg.png)
Creates list of locations or vectors in the shape of a polygon. The radius is the distance between the center and each point.
### Vector Syntax
`polygon with %number% points and radius %number%`
### Location Syntax
`polygon at %location% with %number% points and radius %number%`
***
## Polygon Outline
![](https://i.imgur.com/BSVMrQN.png)
Creates list of locations or vectors in the shape of a polygon with outlines. The radius is the distance between the center and each point. The amount of points for one line segment (between two vertices) is calculated by the edge length and the density: `points = edge length * density`
### Vector Syntax
`polygon outline with %number% points, radius %number% and density %number%`
### Location Syntax
`polygon outline at %location% with %number% points, radius %number% and density %number%`
***
## Random Sphere
![](https://i.imgur.com/mf5A1ji.png)
Creates a list of locations or vectors in the shape of a sphere. The points are randomly distributed on the sphere surface. The radius and the density determine the amount of points: `points = (radius * PI * density)^2`
### Vector Syntax
`random sphere with radius %number% and density %number%`
### Location Syntax
`random sphere at %location% with radius %number% and density %number%`
***
## Sphere
![](https://i.imgur.com/trB8zrH.png)
Creates a list of locations or vectors in the shape of a sphere. The sphere is formed by a series of circles with different diameters. The radius and the density determine the amount of points: `points = (radius * PI * density)^2`
### Vector Syntax
`sphere with radius %number% and density %number%`
### Location Syntax
`sphere at %location% with radius %number% and density %number%`
All 2D shapes (Circle, Line, Polygon and Polygon Outline) are drawn in the horizontal plane (XZ plane). 3D shapes (Cube, Cube Outline, Helix, Random Sphere and Sphere) have also a y-axis component. The orientation of the axes is always indicated in the bottom left corner of the image. The purple particles show the center of the shape. This is the reference location in the location syntax and the vector 0, 0, 0 for the vector syntax.