4 Commits
v0.2.0 ... main

Author SHA1 Message Date
b2f27e0ec0 Update README.md 2025-09-16 23:45:24 +00:00
b4a53e4f58 Update README.md 2025-09-15 17:20:45 +00:00
fff343cdfb readme mods 2025-09-15 17:08:50 +00:00
5ccd71c285 Remove reference to git bash (no longer necessary) 2025-09-15 12:06:24 -05:00

View File

@@ -1,12 +1,12 @@
# Overview # Overview
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 intuitive 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 supports simple camera controls: 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. The goal here is to create an intuitive 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](./examples/LivePlotter.cs). Unfortunately the DLL also expects the presence of several other files currently, so you'll need to ensure **EVERYTHING** from the bin/ folder (that contains `LivePlotter.dll`) is in your project's build output directory. This DLL is designed to integrate easily into a C# application. A class that accomplishes this included. See [LivePlotter.cs](./examples/csharp/LivePlotter.cs). Unfortunately the DLL also expects the presence of several other files currently, so you'll need to ensure **EVERYTHING** from the bin/ folder (that contains `LivePlotter.dll`) is in your project's build output directory.
![til](./demo.gif) ![til](./demo.gif)
*Please note that this project is still considered a work in progress. I will avoid making api-breaking changes. Functionality may be added and code refactoring may occur in the future since I plan to use this for several projects* *Please note that this project is still considered a work in progress. The API may change in future revisions*
# Acquiring the DLL # Acquiring the DLL
@@ -18,9 +18,9 @@ Download the DLL from the latest release on the [releases page](https://git.the-
## Build from source (not recommended) ## Build from source (not recommended)
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 don't enjoy using 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.
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 an installation of MSVC (likely via downloading/installing Visual Studio and then installing the C++ build tools).
2. Get the source code. `git clone --recurse-submodules https://git.the-embedded-lab.com/shamilton/LivePlotter.git` 2. Get the source code. `git clone --recurse-submodules https://git.the-embedded-lab.com/shamilton/LivePlotter.git`
3. Build the glfw library. `cd ext/glfw`. `mkdir build && cd build && cmake ..`. Open GLFW.sln, Change the configuration to "Release, and build the solution. 3. Build the glfw library. `cd ext/glfw`. `mkdir build && cd build && cmake ..`. Open GLFW.sln, Change the configuration to "Release, and build the solution.
4. Find `vcvars64.bat` in your installation and modify the path in [activate.bat](./activate.bat) to point to it. 4. Find `vcvars64.bat` in your installation and modify the path in [activate.bat](./activate.bat) to point to it.