source: src/documentation/constructs/shapes.dox@ 0f3042

Last change on this file since 0f3042 was eee1b7, checked in by Frederik Heber <heber@…>, 12 years ago

DOCU: Documentation on ShapeRegistry, QtUI changes, validators, and parameters.

  • Property mode set to 100644
File size: 1.4 KB
RevLine 
[ce133f]1/*
2 * Project: MoleCuilder
3 * Description: creates and alters molecular systems
4 * Copyright (C) 2010 University of Bonn. All rights reserved.
5 * Please see the LICENSE file or "Copyright notice" in builder.cpp for details.
6 */
7
8/**
[19bc74]9 * \file shapes.dox
[ce133f]10 *
[19bc74]11 * Created on: Oct 28, 2011
[ce133f]12 * Author: heber
13 */
[750cff]14
15/** \page shapes Shapes
16 *
17 * Shapes are present for denoting a specific region of the simulation domain.
[eee1b7]18 * There are four primitive types present:
[750cff]19 * - Sphere
20 * - Ellipsoid
21 * - Cuboid
[eee1b7]22 * - Cylinder
[750cff]23 *
[eee1b7]24 * Note that all may be modified (shrink/grow, rotate, morph) via an arbitrary
[750cff]25 * matrix.
26 *
27 * The shapes are for the moment only used within \ref descriptors to specify
28 * a specific subset of atoms, here that reside in a certain region of the
29 * simulation domain.
30 *
31 * \todo There is a certain relation between Tesselation and Shape. Hence, later
32 * Tesselation shall itself be a Shape, i.e. that describes a certain region in
33 * space, here via a tesselated mesh.
34 *
35 * Again, Shapes can be joined via boolean operators:
36 * - add
37 * - or
38 * - not
39 *
40 * And thus are a very powerful concept.
41 *
42 * E.g. a shape can be used like this
43 * \code
44 * Cuboid(Vector(0,0,0), Vector(2,2,2)) && !Sphere(Vector(1,1,1), 1.)
45 * \endcode
[eee1b7]46 * which would match any object within the cuboid from (0,0,0) to (2,2,2)
[750cff]47 * that is not in the unit sphere at (1,1,1).
48 *
49 *
[eee1b7]50 * \date 2013-02-07
[750cff]51 *
52 */
Note: See TracBrowser for help on using the repository browser.