---------------- rtVTK v1.3.7 ---------------- Original implementation by Christiaan Gribble, Jeremy Fisher, Daniel Eby, Ed Quigley, Gideon Ludwig, Frank Serra, and Andrew Claudy Copyright (c) 2012-2014, Christiaan Gribble Copyright (c) 2012, Grove City College This package contains full source code for the core components of the Ray Tracing Visualization Toolkit, as described in the i3D 2012 paper: C. Gribble, J. Fisher, D. Eby, E. Quigley, and G. Ludwig. Ray Tracing Visualization Toolkit. In ACM SIGGRAPH Symposium on Interactive 3D Graphics & Games, March 2012. http://www.rtvtk.org/~cgribble/research/papers/gribble12ray.pdf The source code is distributed under the BSD 3-Clause License (see LICENSE); the latest public release can be downloaded directly from the rtVTK web site: http://www.rtvtk.org/downloads/ HTTP access to the current rtVTK development repository via git is also available: git clone http://www.rtvtk.org/code/rtVTK.git ------------------------ Building from source ------------------------ rtVTK builds and executes on several *NIX, Windows, and Mac OS X platforms. While the specific steps will vary from one platform to the next, the general process to build rtVTK from source is as follows: 1. Install the rtVTK dependencies (see below) 2. Obtain the rtVTK source code 3. Navigate to the build directory and run CMake 4. Build the rtVTK runtime libraries and executable 5. Run the program We have successfully compiled rtVTK on several distributions of Linux with both clang and gcc, as well as on Windows 7 with Visual Studio 2010 and Mac OS X 10.9 with Xcode 5. ---------------- Dependencies ---------------- rtVTK depends on the following third-party software packages. Please note that packages names and versions for your preferred platform may differ slightly from those that follow: - CMake v2.8 - Qt v4.8.5 SDK - OpenGL Utility Toolkit v3.7 (GLUT) - OpenGL Extension Wrangler v1.8 (GLEW) - Doxygen v1.8.4 (optional, but recommended) - Xcode 5 (Mac OS X only, optional; can use *NIX-style build process) - Visual Studio 2010 (Windows only) In addition, some rtVTK plugins depend on: - CUDA v5.0 - OpenCL v1.2 - Rayforce v2.0 These dependencies are optional: when the packages are not available, either the corresponding plugins are not built or some functionality may be disabled. In Windows, Doxygen does not properly generate rtVTK documentation if the path to either the source code or the build directory has one or more spaces. There are several options to workaround this issue: - Choose source/destination directories without whitespace. - After running CMake, manually edit doxyfile entries so that all directory paths are surrounded by double quotes (e.g., "C:\Documents and Settings\username\path to rtVTK"). - Use doxywizard to generate the rtVTK documentation manually. This problem may occur on *NIX and Mac OS X platforms as well. ------------------- Version history ------------------- v1.3.7, 06 February 2014 - Add cuPluginTemplate plugin - Add Rayforce plugin collection (rfGraphViz, rfRenderer) - Improve RL file format - Add new RL ray types - Add support for multiple trees in rl::ImmediateMode - Add ability to handle multiple head rays per tree in RL - Add 'seekto' functionality to rlRenderer for oneshot rendering - Add support for multi-sampling ray visualization in rlRenderer - Add support for new RL ray types in rlRenderer - Improve scaling of visual elements generated by rlRenderer - Add support for comments in 'shaders' block of IW models - Add ability to override scene's mesh and view files from command line - Improve functionality of interactive camera - Avoid copying runtime files unnecessarily during CMake configuration - Expose use of QPixmap for oneshot rendering during CMake configuration - Various bug fixes and general improvements v0.9.7, 22 January 2013 - Add support for camera path recording and playback - Add oneshot rendering from command line - Add command line and per-plugin option processing - Add support for persistent configuration files - Add support for named objects in Wavefront OBJ loader (via 'o' tag) - Improve functionality of interactive camera - Add frame rate display while idling - Add exception handling to some Core library components - Various bug fixes and general improvements v0.7.6, 08 October 2012 - Add SimpleRT plugin collection (bvhRenderer, srtRenderer) - Add 2D/3D composition plugin (glDepthOnly) - Add support for rl::ImmediateMode in rlRenderer - Add user-configurable mouse button actions - Add support for color mapping scalar values - Various bug fixes and general improvements v0.6.0, 12 August 2012 - Initial public source code release v0.6.0-prerelease, 8 August 2012 - Initial public release of rtVTK binary installers ---------------- Known issues ---------------- As of v1.3.7, we are aware of (and working to resolve, where possible) the following issues: - The SimpleRT path tracer (srtRenderer) does not work correctly in OpenCL::GPU mode on Mac OS X. - The Unity window manager seems to ignore Qt's Motif/NetWM window hints that remove the maximize button from rtVTK's main window; clicking this button leads to strange behavior. - An issue with timer dialog destruction sometimes causes rtVTK to issue the following warning on exit: QObject::killTimers: timers cannot be stopped from another thread - Qt does not render the timer dialog with the correct color scheme in Windows 7 (32-bit). - Qt does not render some user interface widgets correctly in Mac OS X. - Qt v4.8.5 reports Mac OS X 10.9 as an unsupported version, leading to warnings during compilation. - Parts of the GLU and GLUT APIs used by rtVTK are deprecated in Mac OS X 10.9, leading to warnings during compilation. Contact "support@rtvtk.org" to report new issues. Please note that rtVTK is maintained by a small group of unpaid volunteers, so a resolution may not be immediately forthcoming; however, we will do our best to prioritize and resolve reported issues in a timely manner. ------------------- Acknowledgments ------------------- Prior to v0.6.0, rtVTK development was funded in part by research grants from the II-VI Foundation and the Grove City College Swezey Research Fund. The Cornell Box model distributed with rtVTK is based on the original Cornell Box data provided by the Cornell University Program of Computer Graphics; please visit the Cornell Box web site at: http://www.graphics.cornell.edu/online/box/ for more information.