1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
/*=========================================================================
Program: Visualization Toolkit
Module: vtkBond.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkBond
* @brief convenience proxy for vtkMolecule
*
*/
#ifndef vtkBond_h
#define vtkBond_h
#include "vtkAtom.h" // For vtkAtom
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkObject.h" // For macros, etc
class vtkMolecule;
class VTKCOMMONDATAMODEL_EXPORT vtkBond
{
public:
void PrintSelf(ostream& os, vtkIndent indent);
/**
* Return the Id used to identify this bond in the parent molecule.
*/
vtkIdType GetId() const;
/**
* Return the parent molecule of this bond.
*/
vtkMolecule* GetMolecule();
//@{
/**
* Get the starting / ending atom ids for this bond.
*/
vtkIdType GetBeginAtomId() const;
vtkIdType GetEndAtomId() const;
//@}
//@{
/**
* Get a vtkAtom object that refers to the starting / ending atom
* for this bond.
*/
vtkAtom GetBeginAtom();
vtkAtom GetEndAtom();
vtkAtom GetBeginAtom() const;
vtkAtom GetEndAtom() const;
//@}
/**
* Get the bond order for this bond.
*/
unsigned short GetOrder();
/**
* Get the distance between the bonded atoms.
* @note This function is faster than vtkMolecule::GetBondLength and
* should be used when possible.
*/
double GetLength() const;
protected:
friend class vtkMolecule;
vtkBond(vtkMolecule* parent, vtkIdType id, vtkIdType beginAtomId, vtkIdType endAtomId);
vtkMolecule* Molecule;
vtkIdType Id;
vtkIdType BeginAtomId;
vtkIdType EndAtomId;
};
inline vtkIdType vtkBond::GetId() const
{
return this->Id;
}
inline vtkMolecule* vtkBond::GetMolecule()
{
return this->Molecule;
}
#endif
// VTK-HeaderTest-Exclude: vtkBond.h
|
