QuickVtk

A live QML interpreter with embedded VTK support

1. Overview

QuickVtk is a live QML interpeter with built-in support for the VTK-Framework. You can simply learn or test QML code and develop prototypes in the domain of 2D/3D visualization by accessing VTK in a declarative way. To put it in one sentence: QuickVtk's main purpose is to enable reactive programming for VTK by utilizing the QML engine.

An embedded editor allows you to load, edit and compile QML code. Errors are shown directly in the UI and an embedded type browser gives a quick overview of all the different properties, methods and other information for a given type available in QuickVtk.

2. Screenshots

Different screenshots demonstrate some of QuickVtk's main features like 3D volume rendering, 2D image processing operations and mesh filters from VTK

3. Build Instruction

Documentation on how to build QuickVtk on the supported target platforms. Currently, you'll find only build instructions for macOS. The appropriate documentations for windows and linux will be comming soon.

• macOS
• Windows
• Linux

4. User Guide

See the first three articles on how to use QuickVtk in the user guide section.

5. Current Development

Check out the Issues section which basically serves the purpose of tracking the next steps along the development roadmap.

Currently, some documentation needs to be written and I'm focusing on that until the most important basics are covered. Stay tuned!

6. Contributing

Any contribution is helpful and welcome! There are different ways of how you can contribute to this project and get involved with development:

• Report an Issue simply by opening an issue here on GitHub with a detailed description if possible
• Request Features/Enhancements also by opening an issue (tag it with an enhancement label) and provide a brief explanation of the requested feature
• Open a Pull Request with your changes. Just make sure to create a new branch and reference the related issue to keep things organized

There are no hard rules in terms of coding style and such. Just take a look at some lines of code and that should be enough to discover some recurring patterns which keep the code more or less consistent.

7. Contact

If you're interested in the project, want to give some feedback or simply get in touch feel free to write a mail!

8. License

Copyright (c) 2016-2019, Alexander Eduard Szalo All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.