mainpage.userdoc 2.24 KB
Newer Older
Matthias Möller's avatar
doc  
Matthias Möller committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
/** 
\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
16
First select one of the \ref decimaters .
Matthias Möller's avatar
doc  
Matthias Möller committed
17
The \ref incremental provides the best quality, while
Jan Möbius's avatar
Jan Möbius committed
18
the \ref multiple_choice is the fastest one.
Matthias Möller's avatar
doc  
Matthias Möller committed
19
20
21
22
23
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
24
25
26
27
28
29
30
change the constraint values and decimate again having 
the original error quadrics of your mesh.
Otherwise, by adding or removing constraints, you have to reinitialize
the decimater. This will update the error quadrics, so the next decimation will 
be based on the errors to the current mesh, and not the original mesh.
Also, changing the <b>\ref decimater</b>, or the <b>Decimation Order</b>, will
cause a re-initialization.
Matthias Möller's avatar
doc  
Matthias Möller committed
31
32
33
34
35
36
37

\note The <b>Initialization</b> saves the error quadric of each vertex.
They will not be updated, until <i>Initialize</i> is pressed again.




Jan Möbius's avatar
Jan Möbius committed
38
\section decimaters Decimaters
Matthias Möller's avatar
doc  
Matthias Möller committed
39
40
41

\subsection incremental Incremental Decimater

42
43
The incremental decimater checks and takes the best collapse in each iteration.
So, this decimater is the first choice for best <b>optimal results</b>, but might be slow.
Matthias Möller's avatar
doc  
Matthias Möller committed
44
45
46
47
Use \ref multiple_choice or \ref mixed to get faster, but less accurate results.

\subsection multiple_choice Multiple Choice Decimater

Jan Möbius's avatar
Jan Möbius committed
48
The multiple choice decimater checks Nuber of Random Samples and takes the best one for the next collapse.
49
As there is no heap involved, this is usually <b>faster</b> than the incremental approach but as it is randomized,
Matthias Möller's avatar
doc  
Matthias Möller committed
50
51
52
53
the result is not guarantied to be the best, but still inside the specified constraints.

\subsection mixed Mixed Decimater

54
55
Uses Multiple Choice Decimater and Incremental Decimater to get as <b>good and fast results</b> as possible.
This decimater uses several steps of the Multiple Choice Decimater with decreasing constraint threshold.
Matthias Möller's avatar
doc  
Matthias Möller committed
56
57
58
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.
*/