shamilton/LivePlotter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

readme mods

Browse Source
This commit is contained in:
Seth Hamilton
2025-09-11 14:37:56 -05:00
parent bedb7d93e9
commit 60ad2c5da5
1 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -2,7 +2,7 @@
LivePlotter is an opengl-based, 3d point plotting DLL. It is designed to be integrated into any project that needs to see 3d points plotted and updated in real time. It supposts simple camera control: rotate, pan, and zoom. Points can be given a "lifetime" during which their opacity will fade. The opacity of these points can be restored by updating their position. This allows an intuite representation of sensor readings (where the opacity of the point represents the age of the reading). LivePlotter is an opengl-based, 3d point plotting DLL. It is designed to be integrated into any project that needs to see 3d points plotted and updated in real time. It supposts simple camera control: rotate, pan, and zoom. Points can be given a "lifetime" during which their opacity will fade. The opacity of these points can be restored by updating their position. This allows an intuite representation of sensor readings (where the opacity of the point represents the age of the reading).
This DLL is designed to integrate easily into a C# application. A class that acomplishes this included. See [LivePlotter.cs](./LivePlotter.cs). This DLL is designed to integrate easily into a C# application. A class that acomplishes this included. See [LivePlotter.cs](./LivePlotter.cs). You'll need to insure `LivePlotter.dll` is in your project's build output directory.
![til](./demo.gif) ![til](./demo.gif)
@@ -18,10 +18,14 @@ Download the DLL from the latest release on the [releases page](https://git.the-
## Build from source (not recommended) ## Build from source (not recommended)
Building is a tad messy atm. I despise Visual Studio and like to manage my own build process. I prefer something simple like a script to build and that's currently what I have. I hope to fix this mess in the future. Building is a tad messy atm. I despise Visual Studio and like to manage my own build process. I prefer something simple like a script to build and that's currently what I have, but it's not nearly as clean as I'd like. I hope to fix this mess in the future.
1. You'll need git bash and an installation of MSVC (likely via downloading/installing Visual Studio and then installing the C++ build tools). 1. You'll need git bash and an installation of MSVC (likely via downloading/installing Visual Studio and then installing the C++ build tools).
2. Find `vcvars64.bat` in your installation and modify the path in [run_before_build.bat](.run_before_build.bat) to point to it. 2. Get the source code. `git clone --recurse-submodules https://git.the-embedded-lab.com/shamilton/LivePlotter.git`
3. Open git bash to the root directory of the project. 3. Build the glfw library. `cd ext/glfw`. `mkdir build && cd build`. Open GLFW.sln and build the solution.
4. Run `./run_before_build.bat` then `build.sh` 4. Find `vcvars64.bat` in your installation and modify the path in [run_before_build.bat](./run_before_build.bat) to point to it.
5. A folder bin/ should exist with `LivePlotter.dll` inside. 5. Open git bash to the root directory of the project.
6. Run `./run_before_build.bat` then `build.sh`
7. A folder bin/ should exist with `LivePlotter.dll` inside.
If issues arise, please feel free to create an issue on this repository.