Revision: 54523
http://brlcad.svn.sourceforge.net/brlcad/?rev=54523&view=rev
Author: r_weiss
Date: 2013-03-01 21:58:56 +0000 (Fri, 01 Mar 2013)
Log Message:
-----------
Update to the mged 'gr' command documentation.
Modified Paths:
--------------
brlcad/trunk/doc/docbook/system/mann/en/gr.xml
Modified: brlcad/trunk/doc/docbook/system/mann/en/gr.xml
===================================================================
--- brlcad/trunk/doc/docbook/system/mann/en/gr.xml 2013-03-01 21:22:46 UTC
(rev 54522)
+++ brlcad/trunk/doc/docbook/system/mann/en/gr.xml 2013-03-01 21:58:56 UTC
(rev 54523)
@@ -13,7 +13,7 @@
<refname>gr</refname>
<refname>dg</refname>
<refpurpose>
- Add or remove primitives from a group using a GUI selection box. dg
exits grouper mode.
+ Add or remove primitives or primitive parents from a group using a GUI
selection box. dg exits grouper mode.
</refpurpose>
</refnamediv>
@@ -27,35 +27,33 @@
<arg choice="plain" rep="norepeat"><replaceable>-</replaceable></arg>
</group>
<arg choice="opt"
rep="norepeat"><replaceable>ListLimit</replaceable></arg>
+ <arg choice="opt" rep="norepeat"><replaceable>-p</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsection xml:id="description"><title>DESCRIPTION</title>
- <para>Allows primitives to be added or removed from a group by selecting
- them on the MGED display using a selection box. Primitives are identified
- by the location of their vertices on the display. For example, a portion of
- a primitive may be within the selection box but if none of its vertices are
- then it is not considered within the section box. Because of this,
- primitives can only be selected if they are displayed in wireframe. Drawing
- a selection box (left to right), primitives completely in the box are
- selected. Drawing the selection box (right to left), primitives completely
- and partly in the box are selected. To start grouper use the command 'gr'
- or 'grouper'. Press and hold the center mouse button then drag the mouse to
- create the selection box. If there are a large number of vertices within
- the selection box, there will be a delay before the selected primitives are
- highlighted and control of MGED is returned to the user. To exit grouper
- mode, hold down the 'ctrl' key and single-click the center mouse button.
- You can also exit grouper mode with the 'dg' or 'done_grouper' commands.
- Primitives in the group, while in grouper mode, will be displayed (i.e.
- highlighted) in yellow wireframe. When entering grouper mode, if the chosen
- group already contains primitives, these existing primitives will be
- immediately displayed in yellow wireframe. As primitives are added to the
- group, they will also be highlighted in yellow. When you exit grouper mode,
- the yellow highlights will be removed.</para>
- <para>Caveats: When primitives are added to the group, they will lose any
- translation matrices used to place them into the position where they were
- selected. A workaround for this would be to use the 'xpush' command to push
- the translation matrices down to the primitives before using grouper.</para>
+ <para>Allows primitives or primitive parents to be added or removed from a
+ group by selecting them on the MGED display using a selection box. Objects
+ are identified by the location of their vertices on the display. For example,
+ a portion of a object may be within the selection box but if none of its
vertices
+ are then it is not considered within the section box. Because of this, objects
+ can only be selected if they are displayed in wireframe. Drawing a selection
box
+ (left to right), objects completely in the box are selected. Drawing the
selection
+ box (right to left), objects completely and partly in the box are selected. To
+ start grouper use the command 'gr' or 'grouper'. Press and hold the center
mouse
+ button then drag the mouse to create the selection box. If there are a large
number
+ of vertices on the display, there will be a delay before the selected objects
are
+ highlighted and control of MGED is returned to the user. To exit grouper
mode, hold
+ down the 'ctrl' key and single-click the center mouse button. You can also
exit
+ grouper mode with the 'dg' or 'done_grouper' commands. Objects in the group,
while
+ in grouper mode, will be displayed (i.e. highlighted) in yellow wireframe.
When
+ entering grouper mode, if the chosen group already contains objects, these
+ existing objects will be immediately displayed in yellow wireframe. As objects
+ are added to the group, they will also be highlighted in yellow. When you exit
+ grouper mode, the yellow highlights will be removed.</para>
+ <para>Caveats: This command will not function as expected if a selected
+ object has matrices applied. The xpush command can resolve this
+ limitation.</para>
</refsection>
<refsection xml:id="options"><title>OPTIONS</title>
@@ -64,34 +62,43 @@
<term><option>GroupName</option></term>
<listitem>
<para>
- The name of the group to add or remove primitives.
+ The name of the group to add/remove primitives or primitive parents.
</para>
</listitem>
</varlistentry>
-
<varlistentry>
<term><option>+</option></term>
<term><option>-</option></term>
<listitem>
<para>
- Indicates if to add or remove primitives.
+ Indicates if to add or remove from group.
</para>
</listitem>
</varlistentry>
-
<varlistentry>
<term><option>ListLimit</option></term>
<listitem>
<para>
- As primitives are selected using a selection box, the names of the
- primitives can be listed. This option controls the number of
- entries which will be listed. By default this value is zero. All
- selected primitives will be listed, assuming the 'ListLimit' is
- high enough, even if they are not added to the group. This will
- happen if some of the selected primitives are already in the group.
+ As primitives/parents are selected using a selection box, the
+ names of the selected objects can be listed. This option controls
+ the number of entries which will be listed. By default this value
+ is zero. All selected objects will be listed, assuming the
+ 'ListLimit' is high enough, even if they are not added to the
+ group. This will happen if some of the selected objects are already
+ in the group.
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><option>-p</option></term>
+ <listitem>
+ <para>
+ Places the parent of the selected primitives in the group instead of
+ the primitives. With the '-p' option, if the primitive does not have a
+ parent (i.e. is in the root) it will be ignored.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</refsection>
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Everyone hates slow websites. So do we.
Make your web apps faster with AppDynamics
Download AppDynamics Lite for free today:
http://p.sf.net/sfu/appdyn_d2d_feb
_______________________________________________
BRL-CAD Source Commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/brlcad-commits
