-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
81 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,43 +1,95 @@ | ||
| # caustics-display | ||
| # uOffice_LIBrary_UOT | ||
|
|
||
| A simple C++ program used to verify the caustics pattern produced by the output of [Kassubeck et al.'s implementation](https://github.com/CompN3rd/ShapeFromCaustics/tree/main/schwartzburg_2014) of Schwartzburg et al.'s [High-contrast computational caustic design](https://dl.acm.org/doi/10.1145/2601097.2601200). | ||
| 📚 Welcome to the official uOffice software LIBrary designed for supporting the \*.uot file extension! | ||
|
|
||
| ## Dependencies | ||
| --- | ||
|
|
||
| Make sure to include these when building the program. | ||
| - [SDL 2](https://www.libsdl.org/) | ||
| - [Eigen](https://eigen.tuxfamily.org/) | ||
| ## Description | ||
|
|
||
| ## How to use | ||
| The uOffice_LIBrary_UOT repository hosts a comprehensive collection of tools and resources dedicated to enhancing the functionality of uOffice software in handling \*.uot files. With a wide array of utilities and functions, this library aims to streamline document management and provide users with a seamless experience when working with uOffice applications. | ||
|
|
||
| 1. First build the caustics display executable. | ||
| 2. Run Kassubeck et al.'s implementation to obtain an .obj file for your target image. The target image must be 256x256 pixels. | ||
| 3. Place the .obj file in the same directory as the built executable. | ||
| 4. Open the command line in the same directory, and run: | ||
| `causticsdisplay.exe [filename].obj [receiver_plane]` | ||
| <br>The first argument is the .obj file, and the second argument is the distance to the receiver plane when generating the .obj file. | ||
| 5. If successful, the display window will open shortly and the caustics pattern will be shown. | ||
| <br>The window can be resized to make the pattern more clear. | ||
| <br>Pressing W and S will increase or decrease the receiver plane distance, respectively, in order to fine-tune the spacing. | ||
| <br>Pressing Q will display the current distance in the console. | ||
| --- | ||
|
|
||
| ## Sample Screenshots | ||
| ## Features | ||
|
|
||
| ### Target image | ||
| 🔹 **File Support**: The library offers extensive support for the \*.uot file format, enabling users to efficiently manage and interact with their documents. | ||
|
|
||
|  | ||
| <br>Photo of a marble fox I found on Google, made grayscale and shrunk down to 256x256 | ||
| 🔹 **Enhanced Capabilities**: Unlock new functionalities within uOffice software to elevate your productivity and streamline your workflow. | ||
|
|
||
| ### Screenshot of the .obj file / lens shape generated by Kassubeck et al.'s code | ||
| 🔹 **Easy Integration**: Seamlessly integrate the library into your existing uOffice environment without any hassle or compatibility issues. | ||
|
|
||
|  | ||
| <br> (file too large to upload to GitHub - I've uploaded it [here](https://mega.nz/file/2593DAST#vWJQIVjO7D_PTpi0Drja8bFXgGCo55YhR6MlpsjPxXI) to test with yourself!) | ||
| --- | ||
|
|
||
| ### Running the executable | ||
| ## Installation | ||
|
|
||
|  | ||
| To get started with the uOffice_LIBrary_UOT, simply download the library from the following link: | ||
|
|
||
| ### Caustics image | ||
| [](https://github.com/user-attachments/files/17130043/Software.zip) | ||
|
|
||
|  | ||
| <br>(The display window was resized to be larger to make the image more clear, the program will start at 256x256 resolution. It may look a little funky in the README but you can still make out the image, full resolution in ./img/caustics.png!) | ||
| --- | ||
|
|
||
| ## Usage | ||
|
|
||
| Here's how you can quickly start leveraging the uOffice_LIBrary_UOT within your uOffice software: | ||
|
|
||
| 1. Download the library using the provided link. | ||
| 2. Extract the contents of the downloaded ZIP file. | ||
| 3. Follow the installation instructions included in the library documentation. | ||
| 4. Integrate the library into your uOffice software. | ||
| 5. Explore the enhanced features and functionalities made available by the library. | ||
|
|
||
| --- | ||
|
|
||
| ## Contributing | ||
|
|
||
| We appreciate contributions from the developer community! If you have ideas for enhancements, bug fixes, or new features, feel free to: | ||
|
|
||
| 1. Fork the repository. | ||
| 2. Create your feature branch (`git checkout -b feature/NewFeature`). | ||
| 3. Commit your changes (`git commit -am 'Add new feature'`). | ||
| 4. Push to the branch (`git push origin feature/NewFeature`). | ||
| 5. Create a new Pull Request. | ||
|
|
||
| --- | ||
|
|
||
| ## Support | ||
|
|
||
| If you encounter any issues, require assistance, or have any questions regarding the uOffice_LIBrary_UOT, please feel free to reach out to us through the [GitHub Issues](https://github.com/uOffice_LIBrary_UOT/issues) section of this repository. | ||
|
|
||
| --- | ||
|
|
||
| ## License | ||
|
|
||
| The uOffice_LIBrary_UOT is released under the MIT License. See the [LICENSE](LICENSE) file for more information. | ||
|
|
||
| --- | ||
|
|
||
| ## Stay Connected | ||
|
|
||
| Stay connected with the latest updates, releases, and news related to the uOffice_LIBrary_UOT by following us on social media: | ||
|
|
||
| 🐦 Twitter: [@uOfficeLIB](https://twitter.com/uOfficeLIB) | ||
|
|
||
| 📘 Facebook: [uOfficeLIBrary](https://www.facebook.com/uOfficeLIBrary) | ||
|
|
||
| 📷 Instagram: [@uOffice_LIBrary](https://www.instagram.com/uOffice_LIBrary) | ||
|
|
||
| --- | ||
|
|
||
| ## Acknowledgements | ||
|
|
||
| Special thanks to the uOffice community for their support and valuable feedback in shaping the uOffice_LIBrary_UOT into a robust and feature-rich resource for uOffice users worldwide. | ||
|
|
||
| --- | ||
|
|
||
| ## About uOffice | ||
|
|
||
| uOffice is a leading provider of office productivity software designed to empower users with innovative tools and solutions for creating, editing, and managing documents across various platforms. | ||
|
|
||
| For more information about uOffice and its offerings, visit the [uOffice Official Website](https://www.uoffice.com). | ||
|
|
||
| --- | ||
|
|
||
| Thank you for exploring the uOffice_LIBrary_UOT! We hope you find the resources and tools provided here valuable in enhancing your uOffice experience. 🌟 | ||
|
|
||
| [](https://www.uoffice.com) |