This project is a console-based Shape Generator program written in C++. It allows the user to create and save a variety of 3D shapes like spheres, planes, cubes, hexagons, pyramids, and tetrahedrons. The program takes user input for specific shape parameters, dynamically generates the shape, and outputs the shape data to a text file.
This project uses the GLM (OpenGL Mathematics) library for vector operations, and FMT for formatted output.
- Interactive User Input:
- The program accepts user input through the console to configure shapes.
- The user can choose from six different shapes to generate:
- Sphere
- Plane
- Cube
- Hexagon
- Pyramid
- Tetrahedron
- ESC Key Support: Pressing the ESC key exits the program at any time.
- File Output: Once a shape is generated, it is saved in a text file (
shape.txt) for later use. - Error Handling: Provides feedback for invalid input and ensures sensible defaults for shape parameters.
- C++20 or later
- GLM Library (OpenGL Mathematics) - for vector operations
- FMT Library (for formatted console output)
- Clone the repository:
git clone https://github.com/Muppetsg2/Shapes-Generator.git cd Shapes-Generator - Install vcpkg (if you haven't already):
git clone https://github.com/microsoft/vcpkg cd vcpkg .\bootstrap-vcpkg.bat
Note: If you have VS 2022 just check if you have installed vcpkg in your installation. You can find help on how to find if you have already installed vcpkg here.
- Integrate vcpkg with your MSBuild:
.\vcpkg integrate install - Open the project in Visual Studio. Visual Studio will automatically include the necessary dependencies from vcpkg.
- Install GLM and FMT using vcpkg:
.\vcpkg install glm fmt - Ensure you specify the correct include paths and link libraries provided by vcpkg
- Clone the repository:
git clone https://github.com/Muppetsg2/Shapes-Generator.git cd Shapes-Generator - Install the required dependencies (GLM and FMT):
sudo apt-get install libglm-dev libfmt-dev
Note: The libfmt-dev package may not be available in all repositories or might have a different name. If you encounter issues, check your official repository or consider using vcpkg for dependency management.
- Compile the project using g++:
g++ -std=c++20 main.cpp Shape.cpp Sphere.cpp Plane.cpp Cube.cpp Hexagon.cpp Pyramid.cpp Tetrahedron.cpp -o Shapes-Generator -lfmt
- Run the program:
./Shapes-Generator
- Launch the program. You'll see the start window with ASCII art and a prompt to choose a shape.
- Select a shape by entering a number between 1 and 6.
- If the shape requires parameters (e.g., a sphere or plane), enter the requested values.
- Once the shape is generated, it will be saved to
shape.txtin the program's directory, and you'll see how long the shape took to generate. - The file path of the saved shape will be displayed on the console.
- Exiting the Program: You can exit the program at any time by pressing the ESC key.
When generating a sphere:
┌──────────────────────────────────────────────────────────────────────────────────┐
│ │
│ ____ _ ____ _ │
│ / ___|| |__ __ _ _ __ ___ / ___| ___ _ __ ___ _ __ __ _| |_ ___ _ __ │
│ \___ \| '_ \ / _` | '_ \ / _ \ | | _ / _ \ '_ \ / _ \ '__/ _` | __/ _ \| '__| │
│ ___) | | | | (_| | |_) | __/ | |_| | __/ | | | __/ | | (_| | || (_) | | │
│ |____/|_| |_|\__,_| .__/ \___| \____|\___|_| |_|\___|_| \__,_|\__\___/|_| │
│ |_| │
│ │
│ Choose a shape to create │
│ │
│ Press ESC to exit the program │
│ │
└──────────────────────────────────────────────────────────────────────────────────┘
Choose a shape:
1. Sphere
2. Plane
3. Cube
4. Hexagon
5. Pyramid
6. Tetrahedron
Your choice: 1
Enter sphere number of horizontal segments (>= 2): 3
Enter sphere number of vertical segments (>= 3): 4
Start Generating Sphere!
Sphere Generated!
Shape Generated in 0.0001685s!
Choose an array format for saving:
1. Using std::vector
2. Using basic c++ array
Your choice: 1
Shape saved to file: C:\path\to\folder\shape.txtThe generated shape is saved to a file (shape.txt). For example, generating a sphere will produce the following kind of output:
std::vector<Vertex> vertices {
{ .Position = glm::vec3(0.f, 1.f, 0.f), .TexCoords = glm::vec2(0.5f, 0.f), .Normal = glm::vec3(0.f, 1.f, 0.f), .Tangent = glm::vec3(-1.f, 0.f, 0.f), .Bitangent = glm::vec3(0.f, -0.5f, -0.866025f) },
{ .Position = glm::vec3(0.f, 0.5f, 0.866025f), .TexCoords = glm::vec2(0.f, 0.333333f), .Normal = glm::vec3(0.f, 0.5f, 0.866025f), .Tangent = glm::vec3(0.707107f, 0.f, -0.707107f), .Bitangent = glm::vec3(0.707107f, -0.612372f, -0.353553f) },
{ .Position = glm::vec3(0.866025f, 0.5f, -0.f), .TexCoords = glm::vec2(0.25f, 0.333333f), .Normal = glm::vec3(0.866025f, 0.5f, -0.f), .Tangent = glm::vec3(0.196116f, 0.f, -0.980581f), .Bitangent = glm::vec3(0.369274f, -0.852803f, -0.369274f) },
{ .Position = glm::vec3(-0.f, 0.5f, -0.866025f), .TexCoords = glm::vec2(0.5f, 0.333333f), .Normal = glm::vec3(-0.f, 0.5f, -0.866025f), .Tangent = glm::vec3(-0.980581f, 0.f, -0.196116f), .Bitangent = glm::vec3(-0.f, -0.917663f, -0.39736f) },
{ .Position = glm::vec3(-0.866025f, 0.5f, 0.f), .TexCoords = glm::vec2(0.75f, 0.333333f), .Normal = glm::vec3(-0.866025f, 0.5f, 0.f), .Tangent = glm::vec3(-0.196116f, 0.f, 0.980581f), .Bitangent = glm::vec3(-0.369274f, -0.852803f, -0.369274f) },
{ .Position = glm::vec3(0.f, 0.5f, 0.866025f), .TexCoords = glm::vec2(1.f, 0.333333f), .Normal = glm::vec3(0.f, 0.5f, 0.866025f), .Tangent = glm::vec3(0.707107f, 0.f, 0.707107f), .Bitangent = glm::vec3(-0.547723f, -0.790569f, -0.273861f) },
{ .Position = glm::vec3(0.f, -0.5f, 0.866025f), .TexCoords = glm::vec2(0.f, 0.666667f), .Normal = glm::vec3(0.f, -0.5f, 0.866025f), .Tangent = glm::vec3(0.707107f, 0.f, -0.707107f), .Bitangent = glm::vec3(-0.547723f, -0.790569f, 0.273861f) },
{ .Position = glm::vec3(0.866025f, -0.5f, -0.f), .TexCoords = glm::vec2(0.25f, 0.666667f), .Normal = glm::vec3(0.866025f, -0.5f, -0.f), .Tangent = glm::vec3(-0.196116f, 0.f, -0.980581f), .Bitangent = glm::vec3(-0.369274f, -0.852803f, 0.369274f) },
{ .Position = glm::vec3(-0.f, -0.5f, -0.866025f), .TexCoords = glm::vec2(0.5f, 0.666667f), .Normal = glm::vec3(-0.f, -0.5f, -0.866025f), .Tangent = glm::vec3(-0.980581f, 0.f, 0.196116f), .Bitangent = glm::vec3(0.f, -0.917663f, 0.39736f) },
{ .Position = glm::vec3(-0.866025f, -0.5f, 0.f), .TexCoords = glm::vec2(0.75f, 0.666667f), .Normal = glm::vec3(-0.866025f, -0.5f, 0.f), .Tangent = glm::vec3(0.196116f, 0.f, 0.980581f), .Bitangent = glm::vec3(0.369274f, -0.852803f, 0.369274f) },
{ .Position = glm::vec3(0.f, -0.5f, 0.866025f), .TexCoords = glm::vec2(1.f, 0.666667f), .Normal = glm::vec3(0.f, -0.5f, 0.866025f), .Tangent = glm::vec3(0.707107f, 0.f, 0.707107f), .Bitangent = glm::vec3(0.707107f, -0.612372f, 0.353553f) },
{ .Position = glm::vec3(0.f, -1.f, 0.f), .TexCoords = glm::vec2(0.5f, 1.f), .Normal = glm::vec3(0.f, -1.f, 0.f), .Tangent = glm::vec3(-0.447214f, 0.f, -0.894427f), .Bitangent = glm::vec3(0.f, -0.5f, 0.866025f) }
};
std::vector<unsigned int> indices = {
2, 0, 1,
7, 6, 11,
3, 0, 2,
8, 7, 11,
4, 0, 3,
9, 8, 11,
5, 0, 4,
10, 9, 11,
2, 1, 6,
7, 2, 6,
3, 2, 7,
8, 3, 7,
4, 3, 8,
9, 4, 8,
5, 4, 9,
10, 5, 9
};Where the Vertex structure is defined as:
struct Vertex
{
glm::vec3 Position;
glm::vec2 TexCoord;
glm::vec3 Normal;
glm::vec3 Tangent;
glm::vec3 Bitangent;
};If you encounter issues:
- Ensure that you have installed all dependencies correctly.
- Check your console for any error messages related to input.
- Make sure that you are using a compatible version of C++ (C++20 or later).
This project is open-source and available under the MIT License.
MIT License Overview: The MIT License is a permissive free software license that allows users to use, modify, and distribute the software as they wish. Users can incorporate the code into their own projects, both commercial and non-commercial, as long as the original copyright notice and license are included in all copies or substantial portions of the software.
See the LICENSE file for more details.