~ubuntu-branches/ubuntu/vivid/regina-normal/vivid

« back to all changes in this revision

Viewing changes to qtui/doc/regina/packet.docbook

  • Committer: Package Import Robot
  • Author(s): Ben Burton
  • Date: 2014-08-29 17:37:46 UTC
  • mfrom: (19.1.1 sid)
  • Revision ID: package-import@ubuntu.com-20140829173746-igmqc9b67y366a7u
Tags: 4.96-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
5
5
  <title>The Packet Tree</title>
6
6
 
7
7
  <para>
8
 
   A single Regina data file can store a range of objects, from
 
8
   A single Regina data file can store a rich variety of objects, from
9
9
   3-manifold triangulations and normal surfaces to &python; scripts,
10
10
   &pdf; documents and text notes.
11
11
   All of these objects are called <firstterm>packets</firstterm>,
30
30
    </imageobject>
31
31
   </inlinemediaobject>
32
32
  </para>
33
 
 </sect1>
34
 
 <sect1 id="packet-view">
35
 
  <title>Viewing and Editing Packets</title>
36
 
  <para>
37
 
   Each time you open a packet, you will see three buttons at the bottom
38
 
   of the window: <guibutton>Commit</guibutton>,
39
 
   <guibutton>Refresh</guibutton> and <guibutton>Close</guibutton>
40
 
   (all illustrated below).
41
 
   Pressing <guibutton>Close</guibutton> will simply close the packet
42
 
   again.  Pressing <guibutton>Refresh</guibutton> will reload the
43
 
   contents of the packet from &regina;'s mathematical engine (this
44
 
   should rarely be necessary, but the button is provided just in case).
45
 
   <guibutton>Commit</guibutton> should be disabled until you start
46
 
   making changes.
47
 
  </para>
48
 
  <para>
49
 
   <inlinemediaobject>
50
 
    <imageobject>
51
 
     <imagedata fileref="textview.png"/>
52
 
    </imageobject>
53
 
   </inlinemediaobject>
54
 
  </para>
55
 
  <para>
56
 
   Once you begin to edit the packet, the buttons will change to
57
 
   <guibutton>Commit</guibutton>, <guibutton>Discard</guibutton> and
58
 
   <guibutton>Close</guibutton> (again illustrated below).
59
 
   Your changes will not <emphasis>not take effect</emphasis>
60
 
   until you press <guibutton>Commit</guibutton> (after which you
61
 
   will not be able to undo them).
62
 
   Alternatively, you can undo your changes and revert to the original
63
 
   state of the packet by pressing <guibutton>Discard</guibutton>.
64
 
  </para>
65
 
  <para>
66
 
   <inlinemediaobject>
67
 
    <imageobject>
68
 
     <imagedata fileref="textedit.png"/>
69
 
    </imageobject>
70
 
   </inlinemediaobject>
71
 
  </para>
72
33
  <sect2 id="packet-uneditable">
73
34
   <title>Uneditable Packets</title>
74
35
 
75
36
   <para>
76
 
    Sometimes you will find that you cannot make changes to a packet
77
 
    at all.  This often happens when a packet is constrained by its
78
 
    children.  For instance, if a triangulation is parent to a
79
 
    normal surface list or an angle structure list
80
 
    then &regina; will insist that the triangulation does not change
81
 
    (so that normal coordinates and angle structure coordinates
82
 
    cannot be invalidated).
83
 
    Uneditable packets like this
84
 
    will be marked with a small padlock in the tree: see the
85
 
    Figure&nbsp;8 Knot Complement in the illustration below.
 
37
    Sometimes you will find that &regina; does not let you make changes
 
38
    to a packet.  This typically means that the packet is constrained by its
 
39
    children.
 
40
   </para>
 
41
   <para>
 
42
    For example, if a triangulation has normal surfaces or angle structures
 
43
    beneath it, then &regina; will not let you change the triangulation
 
44
    because this would invalidate the normal coordinates or angle structure
 
45
    coordinates.
 
46
   </para>
 
47
   <para>
 
48
    Uneditable packets such as this will be marked with a small padlock
 
49
    in the tree: see the Figure&nbsp;8 Knot Complement in the
 
50
    illustration below.
86
51
   </para>
87
52
   <para>
88
53
    <inlinemediaobject>
198
163
   </para>
199
164
  </sect2>
200
165
 
 
166
  <sect2 id="packet-snappea">
 
167
   <title>&snappea; Triangulations</title>
 
168
   <para>
 
169
    A <firstterm>&snappea; triangulation</firstterm> packet stores a
 
170
    3-manifold using &snappea;'s internal data structures
 
171
    (in contrast, the usual <link linkend="packet-triangulation">triangulation
 
172
    packet</link> uses &regina;'s own structures, which are independent
 
173
    of &snappea;).
 
174
    You can learn more about using &snappea; triangulations in the
 
175
    <link linkend="snappea">chapter on &snappea; triangulations</link>
 
176
    later in this handbook.
 
177
   </para>
 
178
   <para>
 
179
    The advantages of using a &snappea; triangulation is that it stores
 
180
    additional information that &regina; does not (such as fillings and
 
181
    peripheral curves), and it offers more direct access to the &snappea;
 
182
    kernel.  The main disadvantage is that you do not have the
 
183
    fine-grained control over the triangulation that &regina; offers you
 
184
    (in particular, you cannot manipulate the triangulation as freely).
 
185
    Of course &regina; offers you facilities to convert one into the other.
 
186
   </para>
 
187
   <para>
 
188
    &snappea; triangulations are marked by the following icon:
 
189
    <inlinemediaobject>
 
190
     <imageobject>
 
191
      <imagedata fileref="icon-snappea.png"/>
 
192
     </imageobject>
 
193
    </inlinemediaobject>
 
194
   </para>
 
195
   <para>
 
196
    <inlinemediaobject>
 
197
     <imageobject>
 
198
      <imagedata fileref="snappea.png"/>
 
199
     </imageobject>
 
200
    </inlinemediaobject>
 
201
   </para>
 
202
  </sect2>
 
203
 
201
204
  <sect2 id="packet-surfacelist">
202
205
   <title>Normal Surface Lists</title>
203
206
   <para>
427
430
 </sect1>
428
431
 
429
432
 <sect1 id="packet-operations">
430
 
  <title>Other Operations on Packets</title>
 
433
  <title>General Operations on Packets</title>
431
434
  <para>
432
435
   The <guimenu>Packet Tree</guimenu> menu contains
433
436
   operations that can be applied to any packet in &regina;.  Most of
513
516
    menu item.  &regina; will clone whatever packet is
514
517
    currently selected, and the clone will be added adjacent to it
515
518
    in the tree.
516
 
    The top-level packet at the root of the tree cannot be cloned.
517
519
   </para>
518
520
   <para>
519
521
    <inlinemediaobject>
641
643
  </sect2>
642
644
 
643
645
  <sect2 id="packet-refresh">
644
 
   <title>Refreshing Subtrees</title>
 
646
   <title>Refreshing the Tree</title>
645
647
 
646
648
   <para>
647
649
    The
648
650
    <menuchoice>
649
651
     <guimenu>Packet Tree</guimenu>
650
 
     <guimenuitem>Refresh Subtree</guimenuitem>
 
652
     <guimenuitem>Refresh Tree</guimenuitem>
651
653
    </menuchoice>
652
 
    menu item will reload a section of the packet tree from &regina;'s
 
654
    menu item will reload the entire packet tree from &regina;'s
653
655
    mathematical engine.  This should never be necessary, but the
654
656
    operation is provided in case the user interface gets out of sync.
655
657
    If this does happen, please <link linkend="services">let us know</link>
662
664
     </imageobject>
663
665
    </inlinemediaobject>
664
666
   </para>
665
 
   <para>
666
 
    Only the section of the tree beneath the selected packet will be
667
 
    reloaded (i.e., the selected packet, its children, their children
668
 
    and so on).  To refresh the entire tree, you should have the root
669
 
    packet selected.
670
 
   </para>
671
667
  </sect2>
672
668
 </sect1>
673
669
</chapter>