The Gnome Chemistry Utils
0.12.11
|
#include <gcp/electron.h>
Public Member Functions | |
Electron (Atom *pAtom, bool IsPair) | |
~Electron () | |
bool | IsPair () |
char | GetPosition (double *angle, double *distance) |
void | SetPosition (unsigned char Pos, double angle=0., double distance=0.) |
void | AddItem () |
void | SetSelected (int state) |
xmlNodePtr | Save (xmlDocPtr xml) const |
bool | Load (xmlNodePtr node) |
bool | OnSignal (gcu::SignalId Signal, gcu::Object *Child) |
void | Transform2D (gcu::Matrix2D &m, double x, double y) |
std::string | Name () |
Represents either single elecgtrons or electrons pairs.
Definition at line 44 of file electron.h.
gcp::Electron::Electron | ( | Atom * | pAtom, |
bool | IsPair | ||
) |
pAtom | the Atom to which the electrons belong. |
IsPair | true for an electron pair and false for a single electron. |
Constructs a new electron representation.
The destructor
void gcp::Electron::AddItem | ( | ) | [virtual] |
Used to add a representation of the Electron in the view.
Reimplemented from gccv::ItemClient.
char gcp::Electron::GetPosition | ( | double * | angle, |
double * | distance | ||
) |
angle | where to store the angle from east direction in the trigonometric convention. |
distance | where to store the distance from the center of the atom. |
bool gcp::Electron::IsPair | ( | ) | [inline] |
Definition at line 62 of file electron.h.
bool gcp::Electron::Load | ( | xmlNodePtr | node | ) | [virtual] |
node | a pointer to the xmlNode containing the serialized object. |
Used to load an Electron in memory. The Electron must already exist.
Reimplemented from gcu::Object.
std::string gcp::Electron::Name | ( | ) | [virtual] |
Reimplemented from gcu::Object.
bool gcp::Electron::OnSignal | ( | gcu::SignalId | Signal, |
gcu::Object * | Child | ||
) | [virtual] |
Signal | the appropriate SignalId |
Child | the child which emitted the signal or NULL. |
This function is called by the framework when a signal has been emitted for the object. Elecgtron don't have children, so that Child will be ignored. Only the gcp::OnDeleteSignal is significant for this class. It should not be called by a program; call Object::EmitSignal instead.
Reimplemented from gcu::Object.
xmlNodePtr gcp::Electron::Save | ( | xmlDocPtr | xml | ) | const [virtual] |
xml | the xmlDoc used to save the document. |
Used to save the Electron to the xmlDoc.
Reimplemented from gcu::Object.
void gcp::Electron::SetPosition | ( | unsigned char | Pos, |
double | angle = 0. , |
||
double | distance = 0. |
||
) |
Pos | one of POSITION_E, POSITION_N,... |
angle | the angle from the east direction in the trigonometric convention. |
distance | the distance from the center of the atom, or 0. if automatic. |
Sets the position of an electron relative to its parent atom.
void gcp::Electron::SetSelected | ( | int | state | ) | [virtual] |
state | the selection state of the Electron. |
Used to set the selection state of the Electron inside the widget. The values of state might be gcp::SelStateUnselected, gcp::SelStateSelected, gcp::SelStateUpdating, or gcp::SelStateErasing.
Reimplemented from gccv::ItemClient.
void gcp::Electron::Transform2D | ( | gcu::Matrix2D & | m, |
double | x, | ||
double | y | ||
) | [virtual] |
m | the Matrix2D of the transformation. |
x | the x component of the center of the transformation. |
y | the y component of the center of the transformation. |
Used to move and/or transform an Electron.
Reimplemented from gcu::Object.