Commit c217266d authored by Matthias Möller's avatar Matthias Möller

doc

refs #358

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@15727 383ad7c9-94d9-4d36-a494-682f7c89f535
parent e59026b8
......@@ -119,6 +119,36 @@ void DecimaterPlugin::initializePlugin()
toolIcon_ = new QIcon(OpenFlipper::Options::iconDirStr()+OpenFlipper::Options::dirSeparator()+"decimater.png");
emit addToolbox( tr("Decimater") , tool_, toolIcon_ );
WhatsThisGenerator generator("Decimater");
tool_->pbDecimate->setWhatsThis(tool_->pbDecimate->whatsThis()+generator.generateLink("quick_tutorial"));
tool_->pbInitialize->setWhatsThis(tool_->pbInitialize->whatsThis()+generator.generateLink("quick_tutorial"));
tool_->rbUseDecimater->setWhatsThis(tool_->rbUseDecimater->whatsThis()+generator.generateLink("incremental"));
tool_->rbUseMC->setWhatsThis(tool_->rbUseMC->whatsThis()+generator.generateLink("multiple_choice"));
tool_->rbUseMixed->setWhatsThis(tool_->rbUseMixed->whatsThis()+generator.generateLink("mixed"));
tool_->cbDistance->setWhatsThis(tool_->cbDistance->whatsThis()+generator.generateLink());
tool_->cbNormalDev->setWhatsThis(tool_->cbNormalDev->whatsThis()+generator.generateLink());
tool_->cbEdgeLength->setWhatsThis(tool_->cbEdgeLength->whatsThis()+generator.generateLink());
tool_->cbIndependentSets->setWhatsThis(tool_->cbIndependentSets->whatsThis()+generator.generateLink());
tool_->cbRoundness->setWhatsThis(tool_->cbRoundness->whatsThis()+generator.generateLink());
tool_->cbAspectRatio->setWhatsThis(tool_->cbAspectRatio->whatsThis()+generator.generateLink());
tool_->rbByDistance->setWhatsThis(tool_->rbByDistance->whatsThis()+generator.generateLink());
tool_->rbByEdgeLength->setWhatsThis(tool_->rbByEdgeLength->whatsThis()+generator.generateLink());
tool_->rbByNormalDeviation->setWhatsThis(tool_->rbByNormalDeviation->whatsThis()+generator.generateLink());
tool_->rbConstraintsOnly->setWhatsThis(tool_->rbConstraintsOnly->whatsThis()+generator.generateLink());
tool_->rbTriangles->setWhatsThis(tool_->rbTriangles->whatsThis()+generator.generateLink());
tool_->rbVertices->setWhatsThis(tool_->rbVertices->whatsThis()+generator.generateLink());
tool_->randomSamplesCounter->setWhatsThis(tool_->randomSamplesCounter->whatsThis()+generator.generateLink("multiple_choice"));
tool_->mixedFactorCounter->setWhatsThis(tool_->mixedFactorCounter->whatsThis()+generator.generateLink("mixed"));
tool_->roundness->setWhatsThis(tool_->roundness->whatsThis()+generator.generateLink());
tool_->aspectRatio->setWhatsThis(tool_->aspectRatio->whatsThis()+generator.generateLink());
tool_->distance->setWhatsThis(tool_->distance->whatsThis()+generator.generateLink());
tool_->edgeLength->setWhatsThis(tool_->edgeLength->whatsThis()+generator.generateLink());
tool_->normalDeviation->setWhatsThis(tool_->normalDeviation->whatsThis()+generator.generateLink());
}
/** \brief Initialization of the plugin when it is loaded by the core
......
This diff is collapsed.
/**
\mainpage Documentation for Decimater Plugin
\section Summary
Decimates a given mesh to a low poly mesh.
\ref quick_tutorial
\ref decimater :
\li \ref incremental
\li \ref multiple_choice
\li \ref mixed
\section quick_tutorial Quick Tutorial
First select one of the \ref decimater .
The \ref incremental provides the best quality, while
the \multiple_choice is the fastest one.
Now, you can choose your constraints and the decimation order.
Don't forget to define stop conditions.
If done, press <i>Initialize</i> and then <i>Decimate</i>.
After pressing "Initialize" or <i>Decimate</i>, it is possible to
change the constraints' values and decimate again having
the original error quadrics of you mesh.
Otherwise, by adding or removing contraints, you have to reinitialize
the decimater. This will update the error quadrics, so the next decimatation
might be less accurate.
Also, changing the <b>\ref decimater</b>, or the <b>Decimition Order</b>, will
cause a reinitialization.
\note The <b>Initialization</b> saves the error quadric of each vertex.
They will not be updated, until <i>Initialize</i> is pressed again.
\section decimater Decimater
\subsection incremental Incremental Decimater
The incremental decimater checks and takes each iteration the best collapse.
So, this decimater is the first choice for the <b>best results</b>, but might be slow.
Use \ref multiple_choice or \ref mixed to get faster, but less accurate results.
\subsection multiple_choice Multiple Choice Decimater
The multiple choice decimater checks #Random Samples and takes the best one for the next collapse.
As there is no heap involved, this is <b>faster</b> than the incremental decimater but as it is randomized,
the result is not guarantied to be the best, but still inside the specified constraints.
\subsection mixed Mixed Decimater
Uses Multiple Choice Decimater and Incremental Decimater to get <b>good and fast results</b> as possible.
This decimater uses several steps of the Multiple Choice Decimater with increasing constraint threshold.
When 80% of the maximal error are reached or 80% of the collapses have been performed,
it switches back to the Incremental Decimater to do the rest.
*/
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