33 lines
2.5 KiB
Markdown
33 lines
2.5 KiB
Markdown
# 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).
|
|
|
|
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.
|
|
|
|
|
|
|
|
*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*
|
|
|
|
# Acquiring the DLL
|
|
|
|
There are two main ways to get the DLL...
|
|
|
|
## Download from releases (recommended)
|
|
|
|
Download the DLL from the latest release on the [releases page](https://git.the-embedded-lab.com/shamilton/LivePlotter/releases).
|
|
|
|
## 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, 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).
|
|
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 and build the solution.
|
|
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. 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.
|
|
8. Copy the entire contents of the bin folder (preferably minus the intermediate build files... sorry) to your project's build output directory
|
|
|
|
If issues arise, please feel free to create an issue on this repository.
|