source: trunk/documents/UserDoc/DocBookUsersGuides/ForApplicationDeveloper/xml/Detector/geomEditor.xml @ 905

<!-- ******************************************************** -->
<!--                                                          -->
<!--  [History]                                               -->
<!--    Converted to DocBook: Katsuya Amako, Aug-2006         -->
<!--    Changed by: Gabriele Cosmo, 18-Apr-2005               -->
<!--                                                          -->
<!-- ******************************************************** -->


<!-- ******************* Section (Level#2) ****************** -->
<sect2 id="sect.Geom.Edit">
<title>
A Simple Geometry Editor
</title>

<para>
GGE is the Geant4 Graphical Geometry Editor. It is implemented
in JAVA and is part of the Momo environment. GGE aims to serve
physicists who have a little knowledge of C++ and the Geant4
toolkit to construct his or her own detector geometry in a
graphical manner.
</para>

<para>
GGE provides methods to:

<orderedlist spacing="compact">
  <listitem><para>
    construct a detector geometry including <literal>G4Element</literal>,
    <literal>G4Material</literal>, <literal>G4Solids</literal>, 
    <literal>G4LogicalVolume</literal>,
    <literal>G4PVPlacement</literal>, etc.
  </para></listitem>
  <listitem><para>
    view the detector geometry using existing visualization system like DAWN
  </para></listitem>
  <listitem><para>
    keep the detector object in a persistent way
  </para></listitem>
  <listitem><para>
    produce corresponding C++ codes after the norm of Geant4 toolkit
  </para></listitem>
  <listitem><para>
    make a Geant4 executable under adequate environment
  </para></listitem>
</orderedlist>
</para>

<para>
GGE is implemented with Java, using Java Foundation Class,
Swing and is part of Java MOMO Framework. In essence, GGE is made
a set of tables which contain all relevant parameters to construct 
a simple detector geometry.
</para>

<para>
The software, installation instructions and notes for GGE and other
JAVA-based UI tools part of the MOMO Framework can be found in the 
Geant4 distribution under the <literal>geant4/enviroments/MOMO</literal>
directory.
</para>

<!-- ******************* Section (Level#3) ****************** -->
<sect3 id="sect.Geom.Edit.Mate">
<title>
Materials: elements and mixtures
</title>

<para>
GGE provides the database of elements in a form of the periodic
table, which users can use to construct new materials. GGE provides
a pre-constructed database of materials taken from the PDG book.
They can be loaded, used, edited and saved as persistent
objects.
</para>

<para>
Users can also create new materials either from scratch or by
combining other materials.

<itemizedlist spacing="compact">
  <listitem><para>
    creating a material from scratch:
    <para>
    <informaltable>
    <tgroup cols="11">
    <tbody>
    <row>
      <entry>Use</entry>
      <entry>Name</entry>
      <entry>A</entry>
      <entry>Z</entry>
      <entry>Density</entry>
      <entry>Unit</entry>
      <entry>State</entry>
      <entry>Temperature</entry>
      <entry>Unit</entry>
      <entry>Pressure</entry>
      <entry>Unit</entry>
    </row>
    </tbody>
    </tgroup>
    </informaltable>
    </para>
    <para>
    Only the elements and materials used in the logical volumes are
    kept in the detector object and are used to generate C++
    constructors. <emphasis role="bold">Use</emphasis> marks the used materials.
    </para>
  </para></listitem>
  <listitem><para>
    Constructor to create a material from a combination of
    elements, subsequently added via <literal>AddElement</literal>
    <para>
    <informaltable>
    <tgroup cols="9">
    <tbody>
    <row>
      <entry>Use</entry>
      <entry>Name</entry>
      <entry>Elements</entry>
      <entry>Density</entry>
      <entry>Unit</entry>
      <entry>State</entry>
      <entry>Temperature</entry>
      <entry>Unit</entry>
      <entry>Pressure</entry>
      <entry>Unit</entry>
    </row>
    </tbody>
    </tgroup>
    </informaltable>
    </para>

    <para>
    By clicking the column <emphasis role="bold">Elements</emphasis>, a new 
    window is open to select one of two methods:

    <itemizedlist spacing="compact">
      <listitem><para>
        Add an element, giving fraction by weight
      </para></listitem>
      <listitem><para>
        Add an element, giving number of atoms.
      </para></listitem>
    </itemizedlist>
    </para>
  </para></listitem>
</itemizedlist>
</para>

</sect3>

<!-- ******************* Section (Level#3) ****************** -->
<sect3 id="sect.Geom.Edit.Solids">
<title>
Solids
</title>

<para>
The most popular CSG solids (<literal>G4Box</literal>, <literal>G4Tubs</literal>,
<literal>G4Cons</literal>, <literal>G4Trd</literal>) and specific BREPs solids 
(Pcons, Pgons) are supported at present. All related parameters of such a
solid can be specified in a parameter widget.
</para>

<para>
Users will be able to view each solid using DAWN.
</para>

</sect3>

<!-- ******************* Section (Level#3) ****************** -->
<sect3 id="sect.Geom.Edit.LogVol">
<title>
Logical Volume
</title>

<para>
GGE can specify the following items:

<informaltable>
<tgroup cols="4">
<tbody>
<row>
  <entry>Name</entry>
  <entry>Solid</entry>
  <entry>Material</entry>
  <entry>VisAttribute</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>

<para>
The construction and assignment of appropriate entities for
<literal>G4FieldManager</literal> and <literal>G4VSensitiveDetector</literal> 
are left to the user.
</para>

</sect3>

<!-- ******************* Section (Level#3) ****************** -->
<sect3 id="sect.Geom.Edit.PhysVol">
<title>
Physical Volume
</title>

<para>
A single copy of a physical volume can be created. Also repeated
copies can be created in several manners. First, a user can
translate the logical volume linearly.

<informaltable>
<tgroup cols="9">
<tbody>
<row>
  <entry>Name</entry>
  <entry>LogicalVolume</entry>
  <entry>MotherVolume</entry>
  <entry>Many</entry>
  <entry>X0, Y0, Z0</entry>
  <entry>Direction</entry>
  <entry>StepSize</entry>
  <entry>Unit</entry>
  <entry>CopyNumber</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>

<para>
Combined translation and rotation are also possible, placing an
object repeatedly on a ``cylindrical'' pattern. Simple models of
replicas and parametrised volume are also implemented. In the
replicas, a volume is slices to create new sub-volumes. In
parametrised volumes, several patterns of volumes can be
created.
</para>

</sect3>

<!-- ******************* Section (Level#3) ****************** -->
<sect3 id="sect.Geom.Edit.GeneCode">
<title>
Generation of C++ code: <literal>MyDetectorConstruction.cc</literal>
</title>

<para>
By simply pushing a button, source code in the form of an
include file and a source file are created. They are called
<literal>MyDetectorConstruction.cc</literal> and <literal>.hh</literal> files. 
They reflect all current user modifications in real-time.
</para>

</sect3>

<!-- ******************* Section (Level#3) ****************** -->
<sect3 id="sect.Geom.Edit.Vis">
<title>
Visualization
</title>

<para>
Examples of individual solids can be viewed with the help of
DAWN. The visualization of the whole geometry is be done after the
compilation of the source code <literal>MyDetectorConstruction.cc</literal>
with appropriate parts of Geant4. (In particular only the geometry
and visualization, together with the small other parts they depend
on, are needed.)
</para>


</sect3>
</sect2>