gcp::Arrow Class Reference

Inheritance diagram for gcp::Arrow:

gcu::Object gcp::MesomeryArrow gcp::ReactionArrow

List of all members.

Public Member Functions

virtual bool Load (xmlNodePtr)
virtual void SetSelected (GtkWidget *w, int state)
virtual void Move (double x, double y, double z=0)
virtual void Transform2D (Matrix2D &m, double x, double y)
virtual double GetYAlign ()

Protected Attributes

double m_x
double m_y
double m_width
double m_height


Detailed Description

Definition at line 41 of file arrow.h.


Member Function Documentation

virtual bool gcp::Arrow::Load ( xmlNodePtr  node  )  [virtual]

Parameters:
node,: a pointer to the xmlNode containing the serialized object.
Used to load an Object in memory. The Object must already exist.

Example:

        std::string str = (const char*)node->name;
        Object* pObject = Object::CreateObject(str, this);
        if (pObject) {
                if (!pObject->Load(node)) delete Object; 
        } else
                cerr << "Warning: unknown object: " << str << endl;

Returns:
true on succes, false otherwise.

Reimplemented from gcu::Object.

Reimplemented in gcp::MesomeryArrow, and gcp::ReactionArrow.

virtual void gcp::Arrow::SetSelected ( GtkWidget *  w,
int  state 
) [virtual]

Parameters:
w,: the GtkWidget inside which the Object is displayed.
state,: the selection state of the Object.
Used to set the selection state of the Object inside the widget. The values of state are application dependant and have no default value.

Reimplemented from gcu::Object.

Reimplemented in gcp::ReactionArrow.

virtual void gcp::Arrow::Move ( double  x,
double  y,
double  z = 0 
) [virtual]

Parameters:
x,: the x component of the transation vector.
y,: the y component of the transation vector.
z,: the z component of the transation vector.
Used to move an object. This virtual method should most often be overrided by Object derived classes for which it makes sense. The base Object class has no coordinates and the default method only loads its id and children.

Reimplemented from gcu::Object.

Reimplemented in gcp::ReactionArrow.

virtual void gcp::Arrow::Transform2D ( Matrix2D m,
double  x,
double  y 
) [virtual]

Parameters:
m,: the 2D Matrix 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 object. This virtual method must be overrided by Object derived classes for which it makes sense. The base Object class has no coordinates and the default method calls the corresponding method for every child.

Reimplemented from gcu::Object.

virtual double gcp::Arrow::GetYAlign (  )  [virtual]

Used to retreive the y coordinate for alignment. The default implementation returns 0.0 and every derived class for which alignment has a meaning should implement this method.

Returns:
y coordinate used for objects alignment.

Reimplemented from gcu::Object.


The documentation for this class was generated from the following file:
Generated on Sun Sep 16 14:21:56 2007 for The Gnome Chemistry Utils by  doxygen 1.5.3