diff --git a/README.md b/README.md index 2a769cf..0326bab 100644 --- a/README.md +++ b/README.md @@ -1 +1,31 @@ -# createGrid +https://perinim.github.io/createGrid/ +# What is it? +createGrid() is a one-page application that lets you create elements with vertices fixed on a squared grid. You can export shapes in a single CSV file for further manipulation with third-party app. + +# Why? +To quickly generate grid elements which can be used for repetitive patterns. Main applications can be found on the analysis of new grids for Finite Element Methods (FEM) or Virtual Element Methods (VEM) algorithms. + +# Overview +User Interface where you can add closed shapes on a grid. +![overviewgrid](img_readme/overview_grid_star.PNG?raw=true "Overview Grid" ) + +The elements can be exported as a CSV file, which can then be used in third-party software, such as Matlab, to create new types of grid. In the matlab folder you will find a script to normalize and create the grid. +![matlabplot](img_readme/matlab_overview_star.PNG?raw=true "Matlab Grid") + +Shapes can be plot on matlab, normalizing the coordinates and displaying the enumeration of the elements. +![stargrid](img_readme/grid_star.PNG?raw=true "Star Grid") + +Also the properties of the grid can be adjusted, such as height, width, number of suddivisions etc., and the shapes will adjust accordingly. Right now the algorithm works well with square grids but can be adjusted to work also for rect grids. +![stargridrect](img_readme/star_rect_grid.PNG?raw=true "Star Rect Grid") + +# Roadmap +#### UI changes +- [x] Add Download CSV button +- [ ] Add camera to rotate the grid in 3D +- [ ] Add floating window for modifying some grid parameters +#### Objects changes +- [ ] Change grid subdivisions +- [ ] Add to grid object the angle of creation (you can have multiple planes to create 3d objects) +- [ ] Select each element and give possibility to move existing vertices +- [ ] Add patches to fill up gaps between shapes + diff --git a/img_readme/grid_star.PNG b/img_readme/grid_star.PNG new file mode 100644 index 0000000..ba3ad00 Binary files /dev/null and b/img_readme/grid_star.PNG differ diff --git a/img_readme/matlab_overview_star.PNG b/img_readme/matlab_overview_star.PNG new file mode 100644 index 0000000..6f025df Binary files /dev/null and b/img_readme/matlab_overview_star.PNG differ diff --git a/img_readme/matlab_plot.JPG b/img_readme/matlab_plot.JPG new file mode 100644 index 0000000..103eff7 Binary files /dev/null and b/img_readme/matlab_plot.JPG differ diff --git a/img_readme/overview_grid.PNG b/img_readme/overview_grid.PNG new file mode 100644 index 0000000..baf50af Binary files /dev/null and b/img_readme/overview_grid.PNG differ diff --git a/img_readme/overview_grid_star.PNG b/img_readme/overview_grid_star.PNG new file mode 100644 index 0000000..2290ae0 Binary files /dev/null and b/img_readme/overview_grid_star.PNG differ diff --git a/img_readme/star_rect_grid.PNG b/img_readme/star_rect_grid.PNG new file mode 100644 index 0000000..8c4a34d Binary files /dev/null and b/img_readme/star_rect_grid.PNG differ diff --git a/index.html b/index.html index df745b8..11cfd3b 100644 --- a/index.html +++ b/index.html @@ -2,9 +2,12 @@ + + + -

- createGrid() -

+ +

+ Warning! There are no elements on the grid! +
Create one using the 'Add' button. + +

+ +