KDE 4.2 API Reference kalzium
Avogadro::Primitive Class Reference
#include <primitive.h>
Detailed Description
Base class for all primitives (Molecule, Atom, Bond, Residue, ...).
Definition at line 46 of file src/primitive.h.
Public Types | |
| enum | Type { OtherType = 0, MoleculeType, AtomType, BondType, ResidueType, ChainType, SurfaceType, PlaneType, GridType, PointType, VectorType, NonbondedType, TextType, LastType, FirstType = OtherType } |
Signals | |
| void | updated () |
Public Member Functions | |
| unsigned long | id () const |
| QReadWriteLock * | lock () |
| Primitive (Type type, QObject *parent=0) | |
| Primitive (QObject *parent=0) | |
| void | setId (unsigned long m_id) |
| Type | type () const |
| void | update () |
| virtual | ~Primitive () |
Protected Member Functions | |
| Primitive (PrimitivePrivate &dd, Type type, QObject *parent=0) | |
| Primitive (PrimitivePrivate &dd, QObject *parent=0) | |
Protected Attributes | |
| PrimitivePrivate *const | d_ptr |
Properties | |
| Type | type |
Member Enumeration Documentation
This enum allows us to iterate through the various types of primitives.
Holds the primitive type.
- Enumerator:
-
OtherType Untyped Primitive. MoleculeType Molecule Primitive. AtomType Atom Primitive. BondType Bond Primitive. ResidueType Residue Primitive. ChainType Chain Primitive (i.e., a set of residues). SurfaceType Surface Primitive. PlaneType Plane Primitive. GridType Grid Primitive. PointType Points (i.e., non-atoms). VectorType Vectors (i.e., arrows, dipole moments). NonbondedType Non-bonded interactions (i.e., non-bond connections). TextType Text annoations. LastType End Placeholder. FirstType First Placeholder.
Definition at line 57 of file src/primitive.h.
Constructor & Destructor Documentation
| Avogadro::Primitive::Primitive | ( | QObject * | parent = 0 |
) |
Default constructor.
- Parameters:
-
parent the object parent
Definition at line 48 of file primitive.cpp.
Constructor.
- Parameters:
-
type the primitive type parent the object parent
Definition at line 50 of file primitive.cpp.
| Avogadro::Primitive::~Primitive | ( | ) | [virtual] |
| Avogadro::Primitive::Primitive | ( | PrimitivePrivate & | dd, | |
| QObject * | parent = 0 | |||
| ) | [protected] |
Definition at line 56 of file primitive.cpp.
| Avogadro::Primitive::Primitive | ( | PrimitivePrivate & | dd, | |
| Type | type, | |||
| QObject * | parent = 0 | |||
| ) | [protected] |
Definition at line 58 of file primitive.cpp.
Member Function Documentation
| unsigned long Avogadro::Primitive::id | ( | ) | const |
Definition at line 92 of file primitive.cpp.
| QReadWriteLock * Avogadro::Primitive::lock | ( | ) |
Definition at line 75 of file primitive.cpp.
| void Avogadro::Primitive::setId | ( | unsigned long | m_id | ) |
Definition at line 86 of file primitive.cpp.
| Type Avogadro::Primitive::type | ( | ) | const |
| void Avogadro::Primitive::update | ( | ) |
Function used to push changes to a primitive to the rest of the system.
At this time there is no way (other than this) to generate a signal when properties of a primitive change.
In the case of the Atom primitive, this should be called when changes to coordinates have been made.
Reimplemented in Avogadro::Molecule.
Definition at line 81 of file primitive.cpp.
| void Avogadro::Primitive::updated | ( | ) | [signal] |
Emitted when the primitive has been updated.
Member Data Documentation
PrimitivePrivate* const Avogadro::Primitive::d_ptr [protected] |
Definition at line 141 of file src/primitive.h.
Property Documentation
enum Primitive::Type Avogadro::Primitive::type [read] |
Definition at line 49 of file src/primitive.h.
The documentation for this class was generated from the following files:
