Skip to content

Commit

Permalink
Add documentation for Selection and Primitives settings
Browse files Browse the repository at this point in the history
  • Loading branch information
Matthew Mott committed Oct 16, 2019
1 parent f1d6637 commit 3c71c16
Show file tree
Hide file tree
Showing 2 changed files with 68 additions and 3 deletions.
24 changes: 24 additions & 0 deletions doc/manual.adoc
Expand Up @@ -752,6 +752,7 @@ selected object by *Left clicking* on them. By *Right clicking* on a texture you
can access a context menu with a single command *Seek in Media browser*, which
will highlight the clicked texture in the *Media* tab.

[[SurfaceInspector]]
==== Using the Surface Inspector

Once a texture is applied via the Media or Textures tabs, you will most likely
Expand Down Expand Up @@ -1548,12 +1549,35 @@ behaviour of the grid.
*Minor grid style*:: Choose the rendering style for the minor grid lines.
Available options are the same as the *Major grid style* combo box.

==== Selection settings

*Ignore light volume bounds when calculating default rotation pivot location*::
This option affects the behaviour of the <<ManipulatorModes,rotation tool>>
when multiple objects are selected. DarkRadiant will place the rotation widget
at the approximate "center of gravity" of the set of selected objects. If this
option is enabled, any selected lights will be treated as point entities, with
no volume in 3D space regardless of their actual light volumes. If this option
is disabled, the entire light volume will be taken into account as if the light
were a rectangular brush.

==== Undo settings

*Undo Queue Size*:: Use this spinbox to control the number of operations which
are saved onto DarkRadiant's internal undo stack. Larger values provide a
longer history of undoable operations, at the expense of requiring more memory.

==== Primitives settings

This page contains two options controlling the default behaviour of applied
textures. These values can be set on a per-object basis using the
<<SurfaceInspector,Surface Inspector>>.

*Default texture scale*:: Set a default scale factor for newly applied textures.

*Enable texture lock*:: Set the default value of the Texture Lock button. See
the <<SurfaceInspector,Surface Inspector>> section for more details on this
feature.

== Features for game distributors

DarkRadiant is designed to work out of the box with a standard Doom 3 or Dark
Expand Down
47 changes: 44 additions & 3 deletions doc/manual.html
Expand Up @@ -473,7 +473,7 @@ <h1>DarkRadiant User Guide</h1>
<ul class="sectlevel3">
<li><a href="#MediaTab">The Media tab</a></li>
<li><a href="#_the_textures_tab">The Textures tab</a></li>
<li><a href="#_using_the_surface_inspector">Using the Surface Inspector</a></li>
<li><a href="#SurfaceInspector">Using the Surface Inspector</a></li>
</ul>
</li>
<li><a href="#_working_with_entities">Working with entities</a>
Expand Down Expand Up @@ -527,7 +527,9 @@ <h1>DarkRadiant User Guide</h1>
<li><a href="#_autosave_settings">Autosave settings</a></li>
<li><a href="#_clipper_settings">Clipper settings</a></li>
<li><a href="#_grid_settings">Grid settings</a></li>
<li><a href="#_selection_settings">Selection settings</a></li>
<li><a href="#_undo_settings">Undo settings</a></li>
<li><a href="#_primitives_settings">Primitives settings</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -1774,7 +1776,7 @@ <h4 id="_the_textures_tab">The Textures tab</h4>
</div>
</div>
<div class="sect3">
<h4 id="_using_the_surface_inspector">Using the Surface Inspector</h4>
<h4 id="SurfaceInspector">Using the Surface Inspector</h4>
<div class="paragraph">
<p>Once a texture is applied via the Media or Textures tabs, you will most likely
wish to adjust the alignment and scale of the texture on the brush or patch
Expand Down Expand Up @@ -3083,6 +3085,23 @@ <h4 id="_grid_settings">Grid settings</h4>
</div>
</div>
<div class="sect3">
<h4 id="_selection_settings">Selection settings</h4>
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>Ignore light volume bounds when calculating default rotation pivot location</strong></dt>
<dd>
<p>This option affects the behaviour of the <a href="#ManipulatorModes">rotation tool</a>
when multiple objects are selected. DarkRadiant will place the rotation widget
at the approximate "center of gravity" of the set of selected objects. If this
option is enabled, any selected lights will be treated as point entities, with
no volume in 3D space regardless of their actual light volumes. If this option
is disabled, the entire light volume will be taken into account as if the light
were a rectangular brush.</p>
</dd>
</dl>
</div>
</div>
<div class="sect3">
<h4 id="_undo_settings">Undo settings</h4>
<div class="dlist">
<dl>
Expand All @@ -3095,6 +3114,28 @@ <h4 id="_undo_settings">Undo settings</h4>
</dl>
</div>
</div>
<div class="sect3">
<h4 id="_primitives_settings">Primitives settings</h4>
<div class="paragraph">
<p>This page contains two options controlling the default behaviour of applied
textures. These values can be set on a per-object basis using the
<a href="#SurfaceInspector">Surface Inspector</a>.</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>Default texture scale</strong></dt>
<dd>
<p>Set a default scale factor for newly applied textures.</p>
</dd>
<dt class="hdlist1"><strong>Enable texture lock</strong></dt>
<dd>
<p>Set the default value of the Texture Lock button. See
the <a href="#SurfaceInspector">Surface Inspector</a> section for more details on this
feature.</p>
</dd>
</dl>
</div>
</div>
</div>
</div>
</div>
Expand Down Expand Up @@ -3171,7 +3212,7 @@ <h4 id="_creating_an_assets_lst_file">Creating an assets.lst file</h4>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2019-10-08 20:46:42 BST
Last updated 2019-10-16 20:53:04 BST
</div>
</div>
</body>
Expand Down

0 comments on commit 3c71c16

Please sign in to comment.