Skip to content

Commit

Permalink
Update scheme prism docs (#482)
Browse files Browse the repository at this point in the history
  • Loading branch information
ChristopherHogan authored and stevengj committed Aug 31, 2018
1 parent 0e3ae6a commit bae74b1
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions doc/docs/Scheme_User_Interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -369,15 +369,15 @@ Polygonal prism type.

**`vertices` [list of `vector3`]**
The vertices that define the *bottom* of the prism (with the top of the prism being at the same coordinates shifted by `height*axis`). They must lie in a plane that's perpendicular to the `axis`. Note that infinite prism lengths are not supported. To simulate infinite geometry, just extend the edge of the prism beyond the cell.
The vertices that define the *bottom* of the prism (with the top of the prism being at the same coordinates shifted by `height*axis`). They must lie in a plane that's perpendicular to the `axis`. Note that infinite prism lengths are not supported. To simulate infinite geometry, just extend the edge of the prism beyond the cell. Though the `center` property is required (since the prism is a sublcass of `geometric-object`), it is currently unused.

**`height` [`number`]**
The prism thickness, extruded in the direction of `axis`. `infinity` can be used for infinite height.

**`axis` [`vector3`]**
The axis perpendicular to the prism. Defaults to `(0,0,1)`.
Defaults to `(vector3 0 0 1)`, which is currently the only supported axis for the prism.

These are some examples of geometric objects created using the above classes:

Expand Down Expand Up @@ -420,8 +420,9 @@ These are some examples of geometric objects created using the above classes:
(vector3 1 0 0)
(vector3 0.5 (/ (sqrt 3) -2) 0)
(vector3 -0.5 (/ (sqrt 3) -2) 0)))
(height 1.5)
(material cSi))))
(height 1.5)
(center (vector3 0 0))
(material cSi))))
```

### symmetry
Expand Down

0 comments on commit bae74b1

Please sign in to comment.