Commit e2a543ea authored by Mike Kremer's avatar Mike Kremer

Added some doc files

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@5831 383ad7c9-94d9-4d36-a494-682f7c89f535
parent 38d7bad5
/** \page coreplugins Core plugins
*
* OpenFlipper comes along with some core plugins that are already integrated.
* These plugins provide the most basic functions like file reading and writing,
* some mesh transformation operations, data selection, etc.
*
* Here is an overview of the core plugins:
*
* - \ref datacontrol-plugin "Data Control Plugin"
* - \ref decimater-plugin "Decimater Plugin"
* - \ref move-plugin "Move Plugin"
* - \ref selections-plugin "Data Control Plugin"
* - \ref simplesmoother-plugin "Simple Smoother Plugin"
* - \ref smoother-plugin "Smoother Plugin"
*
*/
\ No newline at end of file
/** \page gui User interface concepts
*
* \section userInterface The user interface
*
* The OpenFlipper user interface is composed of four essential widgets.
*
* - \ref viewport_widget
* - \ref plugin_widget
* - \ref logging_widget
* - \ref tool_bar
*
* \section viewport_widget The viewport widget
*
* The viewport widget visualizes the whole scenegraph. One can adjust
* viewer specific settings by chosing <b>View</b> in OpenFlippers
* menu bar. Adjustable settings contain:
*
* - Drawmodes (points, wireframe, solid,...)
* - Projection mode (orthogonal, perspective)
* - Set / reset home view
* - Capture screenshots
* - Adapt colors such that they match the desired profile (for printing, presentation,...)
*
* You can switch to multi viewport mode by hitting space bar.
* See \ref view for more information on viewing modes.
*
* \image html viewport_widget.png The viewport widget
*
* \section plugin_widget The plugin widget
*
* The plugin widget shows the toolboxes of the loaded plugins. You can customize
* this widget's settings by clicking an the "Change View Mode"-button.
*
* \image html plugin_widget.png The plugin widget with simple smoother plugin opened
*
* \section logging_widget The logging widget
*
* The logging widget is used to display plugin specific information,
* warnings or errors. Here you can keep track of what is going on inside.
*
* \image html logging_widget.png The logging widget after opening a triangle mesh file
*
* \section tool_bar The tool bar
*
* The toolbar at the top of OpenFlipper's main window offers clickable icons to
* quickly access a plugins function.
*
* \image html tool_bar.png The tool bar
*/
/*! \mainpage OpenFlipper
/*! \mainpage OpenFlipper User Documentation
*\image html splash.png
* \section intro_sec Introduction
*
* This is the user documentation for the OpenFlipper project.
* OpenFlipper is a flexible geometry modeling and processing system.
*
*
* This manual is divided into the following pages:
* - \subpage gui "User interface concepts"
* - \subpage shortcuts "Keyboard shortcuts"
* - \subpage coreplugins "Core plugins"
* - \subpage scripting "Scripting"
* - \subpage view "View functions"
* - \subpage tools "Tools"
*/
/** \page scripting Scripting
*
* \section Overview
*
*/
\ No newline at end of file
/** \page shortcuts Datastructures
*
* \section Overview
*
*/
\ No newline at end of file
/** \page tools Tools
*
* \section Overview
*
*/
\ No newline at end of file
/** \page view View functions
*
* \section Overview
*
*/
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment