Changeset 8c9049 for src/documentation/constructs

Timestamp:

Mar 11, 2013, 10:31:46 PM (12 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:

e9bdef

Parents:

5c3ad5

git-author:

Frederik Heber <heber@…> (03/11/13 15:06:12)

git-committer:

Frederik Heber <heber@…> (03/11/13 22:31:46)

Message:

DOCU: Updates for qt-gui and shaperegistry documentation.

Location:

src/documentation/constructs

Files:

• qt-gui.dox (modified) (1 diff)
• shaperegistry.dox (modified) (2 diffs)

src/documentation/constructs/qt-gui.dox

@@ -109 +109 @@
  * \section QtInfoBox
  *
- * Shows information about the atom and molecule the cursor is currently hovering over.
+ * Shows information about the atom and molecule the cursor is currently hovering
+ * over inside the GLWorldView.
  *
- * The info pages are Observers of the respective atom/molecule. When receiving
- * e.g. QtAtomInfoPage::subjectKilled() they automatically clear the info box.
+ * GLWorldView emits hoverChanged signals (via QT's signal slot mechanism) which
+ * the QtInfoBox receives. QtInfoBox then creates its info pages for the atom
+ * being transmitted as the signal's parameter.
  *
- * \date 2013-02-07
+ * The info pages are Observers for the atom/molecule. When recieving subjectKilled
+ * they automatically clear the info box.
+ *
+ * \date 2013-02-22
  */

src/documentation/constructs/shaperegistry.dox

@@ -15 +15 @@
 /** \page shaperegistry ShapeRegistry
  *
+ * \section shape-registry-basics Basics
+ *
  * Instances of \ref shapes with unique names can be stored inside the
  * ShapeRegistry. They can be selected via actions.
@@ -29 +31 @@
  * the ShapeRegistry.
  *
- * \date 2013-01-28
+ * GLWorldView is an observer to the ShapeRegistry. It always renders the
+ * currently selected shapes into the scene.
+ *
+ * To do so, the shapes need to be tesselated (i.e. we need a triangle mesh).
+ * Currently we find a number of points on the shape and then use the
+ * Tesselation class. This happens when the shape is added to the registry.
+ * GLWorldView caches the triangulation as long as the shape is inside the
+ * registry.
+ *
+ * It is planned to create a more specialized ShapeTesselation class. Basic
+ * shapes (sphere, cube, etc.) would have predefined meshes. For combined
+ * shaped these basic meshes could then be intersected. That would be faster
+ * and allow correct rendering of topologically nontrivial shapes.
+ *
+ * \date 2013-02-22
  *
  */