diff --git a/docs/source/images/tools_renderer_display_layers.png b/docs/source/images/tools_renderer_display_layers.png deleted file mode 100644 index 7bd977c00..000000000 Binary files a/docs/source/images/tools_renderer_display_layers.png and /dev/null differ diff --git a/docs/source/images/tools_renderer_globals_silhouette.png b/docs/source/images/tools_renderer_globals_silhouette.png new file mode 100644 index 000000000..aece5949c Binary files /dev/null and b/docs/source/images/tools_renderer_globals_silhouette.png differ diff --git a/docs/source/images/tools_renderer_menu.png b/docs/source/images/tools_renderer_menu.png index 659f4cffe..bfc705cb8 100644 Binary files a/docs/source/images/tools_renderer_menu.png and b/docs/source/images/tools_renderer_menu.png differ diff --git a/docs/source/images/tools_renderer_menu_silhouette.png b/docs/source/images/tools_renderer_menu_silhouette.png new file mode 100644 index 000000000..6a289f832 Binary files /dev/null and b/docs/source/images/tools_renderer_menu_silhouette.png differ diff --git a/docs/source/images/tools_renderer_menu_standard.png b/docs/source/images/tools_renderer_menu_standard.png new file mode 100644 index 000000000..4005a4295 Binary files /dev/null and b/docs/source/images/tools_renderer_menu_standard.png differ diff --git a/docs/source/images/tools_renderer_silhouette_viewport.png b/docs/source/images/tools_renderer_silhouette_viewport.png new file mode 100644 index 000000000..0e7eb431f Binary files /dev/null and b/docs/source/images/tools_renderer_silhouette_viewport.png differ diff --git a/docs/source/tools_displaytools.rst b/docs/source/tools_displaytools.rst index 706e34185..e4e8ada91 100644 --- a/docs/source/tools_displaytools.rst +++ b/docs/source/tools_displaytools.rst @@ -134,7 +134,7 @@ Set Mesh Hold-Outs This tool is used to force mesh nodes to be rendered as hold-out in the viewport, or not. -This is similar to assigning a UseBackground shader, to geometry, +This is similar to assigning a `useBackground` shader, to geometry, however this tool avoids the need to create a shader, and manage assignments. diff --git a/docs/source/tools_renderer.rst b/docs/source/tools_renderer.rst index bdfc6fae8..efce8b9b8 100644 --- a/docs/source/tools_renderer.rst +++ b/docs/source/tools_renderer.rst @@ -1,37 +1,165 @@ .. _renderer-ref: -MM Renderer -=========== +Viewport Renderers +================== -`MM Renderer` is a Viewport 2.0 renderer designed to add helpful -features for use with MatchMove workflows and reviews. - -This tool is currently only in beta, and is not enabled in stable `MM -Solver` releases. +`MM Solver` comes with specialised Viewport 2.0 renderers designed to +add helpful features for use with MatchMove workflows and reviews. .. figure:: images/tools_renderer_menu.png :alt: Viewport Renderer menu :align: center :scale: 80% - Enable `MM Renderer` in the "Renderer" menu on each Viewport. + Viewport 2.0 "Renderer" menu. + +Currently the following Viewport 2.0 renderers are available. + +.. list-table:: MM Solver Renderers + :widths: auto + :header-rows: 1 + + * - Name + - Description + + * - :ref:`MM Standard Renderer ` + - Identical to default "Viewport 2.0", but correctly works with + `MM ImagePlane` nodes in from hold-outs, either using Hold Out + attributes or `Use Background` shaders. + + * - :ref:`MM Silhouette Renderer ` + - Identical to `MM Standard Renderer`, but adds a silhouette + outline edge to all rendered meshes in the viewport. + +.. _renderer-standard-ref: + +MM Standard Renderer +==================== + +`MM Standard Renderer` is a Viewport 2.0 renderer designed to add +helpful features for use with MatchMove workflows and reviews. + +`MM Standard Renderer` is different from regular Viewport 2.0 because +it can display `MM Image Plane` nodes with native `useBackground` +shaders (or Hold-Out geometry). + +Usage +~~~~~ + +1) To use `MM Standard Renderer`, load the ``mmSolver`` plug-in (for +example open the Solver UI to ensure the plug-in is loaded), then use +the Viewport's "Renderer" menu to switch to ``MM Standard Renderer``. + +.. figure:: images/tools_renderer_menu_standard.png + :alt: Viewport Renderer menu for `MM Standard Renderer`. + :align: center + :scale: 80% + + Enable `MM Standard Renderer` in the Viewport "Renderer" menu. + +2) Use the Maya viewport and playblast as normal. + +.. _renderer-silhouette-ref: + +MM Silhouette Renderer +====================== + +The `MM Silhouette Renderer` is used to add silhouette outline edge to +rendered geometry, allowing the artist to clearly see the edges of a +mesh against an image sequence. + +This rendering effect is particularly effective when the geometry +contains a Hold-Out effect using a `useBackground` shader or hold-out +attributes (see :ref:`Set Mesh Hold-Out ` +tool). + +.. figure:: images/tools_renderer_silhouette_viewport.png + :alt: Example green silhouette effect on shaded objects. + :align: center + :scale: 80% + + Example green silhouette effect on shaded objects. + +.. note:: `MM Silhouette Renderer` requires the use of the OpenGL + graphics API backend; DirectX is not supported. + +Usage +~~~~~ + +1) To use `MM Silhouette Renderer`, load the ``mmSolver`` plug-in (for +example open the Solver UI to ensure the plug-in is loaded), then use +the Viewport's "Renderer" menu to switch to ``MM Silhouette +Renderer``. + +.. figure:: images/tools_renderer_menu_silhouette.png + :alt: Viewport Renderer menu for `MM Silhouette Renderer`. + :align: center + :scale: 80% + + Enable `MM Silhouette Renderer` in the Viewport "Renderer" menu. + +2) Click viewport panel menu "Renderer > MM Silhouette Renderer + [Option Box]" to open the :ref:`renderer settings + ` in the Attribute Editor. + +3) Adjust Silhouette settings as needed for desired effect. + +4) Use the Maya viewport and playblast as normal. + +.. _renderer-silhouette-settings-ref: + +Settings +~~~~~~~~ + +The settings for the `MM Silhouette Renderer` affect all open viewport +panels using the same renderer and allow adjusting the silhouette +effect, including the color and opacity. + +.. figure:: images/tools_renderer_globals_silhouette.png + :alt: The global settings for the `MM Silhouette Renderer` in the + Attribute Editor. + :align: center + :scale: 80% + + The global settings for the `MM Silhouette Renderer` in the + Attribute Editor. + + +.. list-table:: MM Silhouette Renderer Settings + :widths: auto + :header-rows: 1 + + * - Name + - Description + + * - Depth Offset + - The separation between the invisible solid geometry and the + wireframe mesh. Adjust to lower values if small-mesh artifacts + are visible. Set to ``0.0`` to create a shaded wireframe + effect. + + * - Width + - The width of the silhouette lines. -`MM Renderer` is different from regular Viewport 2.0 because it has -the following features: + * - Override Color + - When enabled, all objects will use the silhouette color + below. When disabled, the wireframe color of the object is used + for each object's lines. -- Display of MM Image Plane nodes with native useBackground shaders. + * - Color + - The override color for silhouette lines. -Getting Started -~~~~~~~~~~~~~~~ + * - Alpha + - The global opacity of the silhouette lines. -To use `MM Renderer`, simply load the ``mmSolver`` plug-in (for -example open the Solver UI to ensure the plug-in is loaded), then -use the Viewport's "Renderer" menu to switch to ``MM Renderer``. + * - Cull Face + - Backface culling for solid invisible mesh surfaces. For meshes + with inverted normals values other than ``Back``; Options are + ``Back``, ``Front`` or ``FrontAndBack``. -Known Issues -~~~~~~~~~~~~ + * - (debug) Enable + - Toggle the silhouette effect on/off. -`MM Renderer` is *beta* software and is only released in ``beta`` -versions of `MM Solver`. There are numerous bugs and issues that are -not yet resolved and the viewport renderer is available as a preview -only. + * - (debug) Operation Number + - Used internally to draw only the first N number of rendering + operations inside the renderer.