|
Last change
on this file since 7305d5 was 7672551, checked in by Frederik Heber <heber@…>, 13 years ago |
|
Split off class definition of LinePoint from module Line.cpp
- added documentation section on the lines.
- some changes due to new include LinePoint.hpp.
|
-
Property mode
set to
100644
|
|
File size:
1.1 KB
|
| Line | |
|---|
| 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 | /**
|
|---|
| 9 | * \file lines.dox
|
|---|
| 10 | *
|
|---|
| 11 | * Herein, we explain the structural ideas behind lines and line segments.
|
|---|
| 12 | *
|
|---|
| 13 | * Created on: Jan 28, 2012
|
|---|
| 14 | * Author: heber
|
|---|
| 15 | */
|
|---|
| 16 |
|
|---|
| 17 | /**
|
|---|
| 18 | * \page lines Lines
|
|---|
| 19 | *
|
|---|
| 20 | * \section lines-types Types of Lines
|
|---|
| 21 | *
|
|---|
| 22 | * We have many different classes that all seem to have something to do with
|
|---|
| 23 | * lines. Let us here briefly explain which is which:
|
|---|
| 24 | * -# Line A line represents a two-dimensional object in Space stretching from
|
|---|
| 25 | * and to infinity on either end.
|
|---|
| 26 | * -# LineSegment the segment of a line is defined through two points which form
|
|---|
| 27 | * its start and end.
|
|---|
| 28 | * -# LinePoint a point on a specific line, identifiable and more so, alignable
|
|---|
| 29 | * by its parameter LinePoint::param.
|
|---|
| 30 | * -# LineSegmentSet a continous set of segments of lines, i.e. such that the
|
|---|
| 31 | * end point of the last is the starting point of the next.
|
|---|
| 32 | *
|
|---|
| 33 | * \date 2012-01-28
|
|---|
| 34 | *
|
|---|
| 35 | */
|
|---|
Note:
See
TracBrowser
for help on using the repository browser.
