Skip to content

Commit

Permalink
Docs - Add images for Frames, User and Root Frames Solver UI widgets.
Browse files Browse the repository at this point in the history
  • Loading branch information
david-cattermole committed Nov 19, 2022
1 parent 765aa85 commit 87cdaa6
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 10 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 24 additions & 10 deletions docs/source/tools_solver_ui.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,9 @@ Solver Tabs
~~~~~~~~~~~

The Solver tabs define the different solvers and the options for each
solver. The different solvers tabs share options, such as frame range,
but each Solver tab is independent.
solver. The different solvers tabs share
:ref:`solver-ui-common-solver-options-ref`, such as frame range, but
each Solver tab is independent.

The documentation for each Solver tab is below.

Expand All @@ -102,16 +103,23 @@ The documentation for each Solver tab is below.
tools_solver_ui_tab_standard
tools_solver_ui_tab_camera

.. _solver-ui-common-solver-options-ref:

Common Solver Options
+++++++++++++++++++++
~~~~~~~~~~~~~~~~~~~~~

The options below are the same on one or many of the Solver tabs.

Frames
------
++++++

The Frames option defines the list of frames to be solved.

.. figure:: images/tools_solver_ui_solver_options_frames.png
:alt: Solver Frame Options
:align: center
:scale: 100%

Choose one of the options:

.. list-table:: Frames
Expand All @@ -133,6 +141,7 @@ Choose one of the options:
* - Custom Frames
- Manually type the frame numbers to be solved.


The frame numbers can be entered as '#-#' to define a range, or
'#,#,#,#' to define a list of individual frame numbers. Examples are
'1,10,20,30,40,50' or '10-20,30,40-50'.
Expand All @@ -145,7 +154,12 @@ currently created, and then reducing this number to '1' to solve each
frame.

User and Root Frames
--------------------
++++++++++++++++++++

.. figure:: images/tools_solver_ui_solver_options_user_root_frames.png
:alt: Solver User and Root Frame Options
:align: center
:scale: 100%

The `Root Frames` are used to solve static and animated attributes,
and are therefore not used with the :ref:`Basic Solver Tab
Expand Down Expand Up @@ -185,15 +199,15 @@ Therefore the full list of iterations look like this...
- Iteration 5: ``1,7,13,19,25,31,37,43,48,54,60,66,72,78,84,90,95``

Solve All at Once
-----------------
+++++++++++++++++

`Solve All at Once` will solve all frames in a single solver
step. This is the most accurate method of solving, because all
Attributes and Frames are considered when reducing the error, however
this is much slower.

Solve Only Root Frames
----------------------
++++++++++++++++++++++

`Solve Only Root Frames` will skip the last solver step when solving
only animated attributes for the full frame range. As a result only
Expand All @@ -206,23 +220,23 @@ option, or solve with the :ref:`Basic Solver Tab
<basic-solver-tab-heading>`.

Solve Focal Length
------------------
++++++++++++++++++

A toggle to allow focal length attributes to be solved. If this value
is disabled, all camera focal length attributes will be ignored. This
option is helpful to quickly enable/disable focal length attributes in
the solver.

Solve Lens Distortion
---------------------
+++++++++++++++++++++

A toggle to allow lens distortion attributes to be solved. If this
value is disabled, all camera lens distortion attributes will be
ignored. This option is helpful to quickly enable/disable lens
distortion attributes in the solver.

Evaluate Mesh Rivets
--------------------
++++++++++++++++++++

When enabled, *Evaluate Mesh Rivets* will change the internal
evaluation method to help solve "complex" node networks (such as Mesh
Expand Down

0 comments on commit 87cdaa6

Please sign in to comment.