Candidate_v1.7.0
        stable
      
      
        
          | Last change
 on this file since 6b7765 was             caece4, checked in by Frederik Heber <heber@…>, 11 years ago | 
        
          | 
Enhanced documentation significantly.
 went through all of the constructs and updated each.
enhanced documentation ofr Fragmentation::FragmentMolecule().
 | 
        
          | 
              
Property                 mode
 set to                 100644 | 
        
          | File size:
            1.6 KB | 
      
      
| Line |  | 
|---|
| 1 | /* | 
|---|
| 2 | * Project: MoleCuilder | 
|---|
| 3 | * Description: creates and alters molecular systems | 
|---|
| 4 | * Copyright (C)  2013 University of Bonn. All rights reserved. | 
|---|
| 5 | * Please see the LICENSE file or "Copyright notice" in builder.cpp for details. | 
|---|
| 6 | */ | 
|---|
| 7 |  | 
|---|
| 8 | /** | 
|---|
| 9 | * \file shaperegistry.dox | 
|---|
| 10 | * | 
|---|
| 11 | * Created on: Jan 28, 2013 | 
|---|
| 12 | *    Author: ankele | 
|---|
| 13 | */ | 
|---|
| 14 |  | 
|---|
| 15 | /** \page shaperegistry ShapeRegistry | 
|---|
| 16 | * | 
|---|
| 17 | * \section shape-registry-basics Basics | 
|---|
| 18 | * | 
|---|
| 19 | * Instances of \ref shapes with unique names can be stored inside the | 
|---|
| 20 | * ShapeRegistry. They can be selected via actions. | 
|---|
| 21 | * | 
|---|
| 22 | * There are special action to manipulate the currently selected shapes: | 
|---|
| 23 | *  - CombineShapesAction | 
|---|
| 24 | *  - RemoveShapeAction | 
|---|
| 25 | *  - RotateShapeAction | 
|---|
| 26 | *  - StretchShapeAction | 
|---|
| 27 | *  - TranslateShapeAction | 
|---|
| 28 | * | 
|---|
| 29 | * Some actions on the world (like selecting all atoms within a shape or | 
|---|
| 30 | * filling a shape with molecules) use the currently selected shapes in | 
|---|
| 31 | * the ShapeRegistry. | 
|---|
| 32 | * | 
|---|
| 33 | * GLWorldView is an observer to the ShapeRegistry. It always renders the | 
|---|
| 34 | * currently selected shapes into the scene. | 
|---|
| 35 | * | 
|---|
| 36 | * To do so, the shapes need to be tesselated (i.e. we need a triangle mesh). | 
|---|
| 37 | * Currently we find a number of points on the shape and then use the | 
|---|
| 38 | * Tesselation class. This happens when the shape is added to the registry. | 
|---|
| 39 | * GLWorldView caches the triangulation as long as the shape is inside the | 
|---|
| 40 | * registry. | 
|---|
| 41 | * | 
|---|
| 42 | * \todo It is planned to create a more specialized ShapeTesselation class. | 
|---|
| 43 | * Basic shapes (sphere, cube, etc.) would have predefined meshes. For combined | 
|---|
| 44 | * shaped these basic meshes could then be intersected. That would be faster | 
|---|
| 45 | * and allow correct rendering of topologically nontrivial shapes. | 
|---|
| 46 | * | 
|---|
| 47 | * \date 2013-02-22 | 
|---|
| 48 | * | 
|---|
| 49 | */ | 
|---|
       
      
  Note:
 See   
TracBrowser
 for help on using the repository browser.