Changeset caece4 for src/documentation/userinterfaces/graphical.dox

Timestamp:

May 20, 2014, 9:14:56 AM (11 years ago)

Author:

Frederik Heber <heber@…>

Branches:

Action_Thermostats, Add_AtomRandomPerturbation, Add_FitFragmentPartialChargesAction, Add_RotateAroundBondAction, Add_SelectAtomByNameAction, Added_ParseSaveFragmentResults, AddingActions_SaveParseParticleParameters, Adding_Graph_to_ChangeBondActions, Adding_MD_integration_tests, Adding_ParticleName_to_Atom, Adding_StructOpt_integration_tests, AtomFragments, Automaking_mpqc_open, AutomationFragmentation_failures, Candidate_v1.5.4, Candidate_v1.6.0, Candidate_v1.6.1, ChangeBugEmailaddress, ChangingTestPorts, ChemicalSpaceEvaluator, CombiningParticlePotentialParsing, Combining_Subpackages, Debian_Package_split, Debian_package_split_molecuildergui_only, Disabling_MemDebug, Docu_Python_wait, EmpiricalPotential_contain_HomologyGraph, EmpiricalPotential_contain_HomologyGraph_documentation, Enable_parallel_make_install, Enhance_userguide, Enhanced_StructuralOptimization, Enhanced_StructuralOptimization_continued, Example_ManyWaysToTranslateAtom, Exclude_Hydrogens_annealWithBondGraph, FitPartialCharges_GlobalError, Fix_BoundInBox_CenterInBox_MoleculeActions, Fix_ChargeSampling_PBC, Fix_ChronosMutex, Fix_FitPartialCharges, Fix_FitPotential_needs_atomicnumbers, Fix_ForceAnnealing, Fix_IndependentFragmentGrids, Fix_ParseParticles, Fix_ParseParticles_split_forward_backward_Actions, Fix_PopActions, Fix_QtFragmentList_sorted_selection, Fix_Restrictedkeyset_FragmentMolecule, Fix_StatusMsg, Fix_StepWorldTime_single_argument, Fix_Verbose_Codepatterns, Fix_fitting_potentials, Fixes, ForceAnnealing_goodresults, ForceAnnealing_oldresults, ForceAnnealing_tocheck, ForceAnnealing_with_BondGraph, ForceAnnealing_with_BondGraph_continued, ForceAnnealing_with_BondGraph_continued_betteresults, ForceAnnealing_with_BondGraph_contraction-expansion, FragmentAction_writes_AtomFragments, FragmentMolecule_checks_bonddegrees, GeometryObjects, Gui_Fixes, Gui_displays_atomic_force_velocity, ImplicitCharges, IndependentFragmentGrids, IndependentFragmentGrids_IndividualZeroInstances, IndependentFragmentGrids_IntegrationTest, IndependentFragmentGrids_Sole_NN_Calculation, JobMarket_RobustOnKillsSegFaults, JobMarket_StableWorkerPool, JobMarket_unresolvable_hostname_fix, MoreRobust_FragmentAutomation, ODR_violation_mpqc_open, PartialCharges_OrthogonalSummation, PdbParser_setsAtomName, PythonUI_with_named_parameters, QtGui_reactivate_TimeChanged_changes, Recreated_GuiChecks, Rewrite_FitPartialCharges, RotateToPrincipalAxisSystem_UndoRedo, SaturateAtoms_findBestMatching, SaturateAtoms_singleDegree, StoppableMakroAction, Subpackage_CodePatterns, Subpackage_JobMarket, Subpackage_LinearAlgebra, Subpackage_levmar, Subpackage_mpqc_open, Subpackage_vmg, Switchable_LogView, ThirdParty_MPQC_rebuilt_buildsystem, TrajectoryDependenant_MaxOrder, TremoloParser_IncreasedPrecision, TremoloParser_MultipleTimesteps, TremoloParser_setsAtomName, Ubuntu_1604_changes, stable

Children:

6029a6

Parents:

74459a

git-author:

Frederik Heber <heber@…> (03/20/14 17:23:35)

git-committer:

Frederik Heber <heber@…> (05/20/14 09:14:56)

Message:

Enhanced documentation significantly.

• went through all of the constructs and updated each.
• enhanced documentation ofr Fragmentation::FragmentMolecule().

File:

• src/documentation/userinterfaces/graphical.dox (modified) (4 diffs)

src/documentation/userinterfaces/graphical.dox

@@ -16 +16 @@
  * \page userinterfaces-graphical Graphical User Interface
  *
- * The GUI is based on Qt4. It used Qt3D for displaying the GlWorldView and
+ * The GUI is based on Qt4. It uses Qt3D for displaying the GlWorldView and
  * allowing for easy selecting of atoms and molecules.
  *
@@ -23 +23 @@
  * - a world view, implemented in GLWorldView, displaying atoms and bonds
  *   and allowing for selecting them.
- * - A list of all currently selected molecules.
- * - A list of all currently present molecules.
+ * - a tab widget on the right with hover info and a list of shapes.
+ * - a tab widget below the world view enlisting molecules, elements, fragments,
+ *   and homologies.
+ *
  *
  * \section userinterfaces-graphical-query Queries in the graphical interface.
  *
- * As all Action always instantiate a Dialog which behaves differently for
+ * As all Action's always instantiate a Dialog which behaves differently for
  * each of the three user interface, we give a brief description of what it
  * does here.
@@ -36 +38 @@
  * Eventually, this concatenated dialog is presented to the user -- it might
  * be empty though as well -- he enters all values and clicks accept (even
- * in case of an empty dialog). These values are passed via a Pipe mechanism
- * (this is a workaround as Qt's moc does not liked nested classes) to the
- * ValueStorage.
+ * in case of an empty dialog). These values are inspected with each Option's
+ * validator and only if all are true, accept is actually clickable. If not, at
+ * least one option is still invalid.
+ *
  *
  * \section userinterfaces-graphical-world_view How the World view works ...
  *
- * GLWorldView handles the Observer translation to Qt's own mechanism. Also, it
- * contains an instance of the GLWorldScene. This instance knows about all
+ * GLWorldView handles the Observer translation to Qt's own signal/slot mechanism. 
+ * Also, it contains an instance of the GLWorldScene. This instance knows all about
  * atoms and bonds present in this scene, i.e. it has lists on them and handles
  * adding and removing. Objects in this scene are GLMoleculeObject's which
@@ -53 +56 @@
  *
  *
- * \date 2012-01-05
+ * \date 2014-03-10
  *
  */