Chemical reaction class. More...

#include <gcp/reaction.h>

Inheritance diagram for gcp::Reaction:

Public Member Functions
	Reaction ()
virtual	~Reaction ()
bool	Build (std::set< Object * > const &Children) throw (std::invalid_argument)
void	Transform2D (gcu::Matrix2D &m, double x, double y)
bool	BuildContextualMenu (gcu::UIManager UIManager, gcu::Object object, double x, double y)
bool	OnSignal (gcu::SignalId Signal, gcu::Object *Child)
bool	Load (xmlNodePtr node)
double	GetYAlign ()
std::string	Name ()
Public Member Functions inherited from gcp::Scheme
	Scheme (gcu::TypeId type)
virtual	~Scheme ()
Public Member Functions inherited from gcu::Object
	Object (TypeId Id=OtherType)
virtual	~Object ()
TypeId	GetType () const
void	SetId (gchar const *Id)
char const *	GetId () const
virtual void	AddChild (Object *object)
Object *	GetMolecule () const
Object *	GetReaction () const
Object *	GetGroup () const
Document *	GetDocument () const
Application *	GetApplication () const
Object *	GetParentOfType (TypeId Id) const
Object *	GetChild (const gchar *Id) const
Object *	GetFirstChild (std::map< std::string, Object * >::iterator &i)
Object *	GetNextChild (std::map< std::string, Object * >::iterator &i)
Object *	GetDescendant (const char *Id) const
Object *	GetParent () const
void	SetParent (Object *Parent)
virtual xmlNodePtr	Save (xmlDocPtr xml) const
virtual bool	GetCoords (double x, double y, double *z=NULL) const
virtual void	Move (double x, double y, double z=0.)
bool	SaveChildren (xmlDocPtr xml, xmlNodePtr node) const
void	SaveId (xmlNodePtr node) const
xmlNodePtr	GetNodeByProp (xmlNodePtr node, char const Property, char const Id)
xmlNodePtr	GetNextNodeByProp (xmlNodePtr node, char const Property, char const Id)
xmlNodePtr	GetNodeByName (xmlNodePtr node, char const *Name)
xmlNodePtr	GetNextNodeByName (xmlNodePtr node, char const *Name)
bool	HasChildren () const
unsigned	GetChildrenNumber () const
virtual Object *	GetAtomAt (double x, double y, double z=0.)
virtual bool	Build (std::set< Object * > const &Children) throw (std::invalid_argument)
void	EmitSignal (SignalId Signal)
void	Lock (bool state=true)
bool	IsLocked ()
Object *	GetFirstLink (std::set< Object * >::iterator &i)
Object *	GetNextLink (std::set< Object * >::iterator &i)
void	Link (Object *object)
void	Unlink (Object *object)
virtual void	OnUnlink (Object *object)
void	GetPossibleAncestorTypes (std::set< TypeId > &types) const
virtual bool	SetProperty (unsigned property, char const *value)
virtual std::string	GetProperty (unsigned property) const
virtual void	OnLoaded ()
void	SetDirty (bool dirty=true)
virtual void	Clear ()
std::string	Identity ()
virtual char const *	HasPropertiesDialog () const
virtual bool	CanSelect () const
virtual void	NotifyEmpty ()
void	ShowPropertiesDialog ()
bool	GetDirty (void) const

Additional Inherited Members
Static Public Member Functions inherited from gcu::Object
static TypeId	AddType (std::string TypeName, Object (CreateFunc)(), TypeId id=OtherType)
static void	AddAlias (TypeId id, std::string TypeName)
static Object *	CreateObject (const std::string &TypeName, Object *parent=NULL)
static TypeId	GetTypeId (const std::string &Name)
static std::string	GetTypeName (TypeId Id)
static void	AddMenuCallback (TypeId Id, BuildMenuCb cb)
static void	AddRule (TypeId type1, RuleId rule, TypeId type2)
static void	AddRule (const std::string &type1, RuleId rule, const std::string &type2)
static const std::set< TypeId > &	GetRules (TypeId type, RuleId rule)
static const std::set< TypeId > &	GetRules (const std::string &type, RuleId rule)
static void	SetCreationLabel (TypeId Id, std::string Label)
static const std::string &	GetCreationLabel (TypeId Id)
static const std::string &	GetCreationLabel (const std::string &TypeName)
static SignalId	CreateNewSignalId ()
Protected Member Functions inherited from gcp::Scheme
void	Align () throw (std::invalid_argument)

Detailed Description

Chemical reaction class.

This class is used for chemical reactions in GChemPaint. It can represent a whole reactions scheme with several steps, although only one step is currently really supported. Acceptable children for an instance of this class are instances of ReactionArrow and ReactionStep.

Definition at line 47 of file reaction.h.

Constructor & Destructor Documentation

gcp::Reaction::Reaction ( )

Constructs a new empty Reaction instance.

virtual gcp::Reaction::~Reaction ( )

virtual

The destructor.

Member Function Documentation

bool gcp::Reaction::Build ( std::set< Object * > const & Children ) throw (std::invalid_argument)

Parameters

Children the list of objects used as children to build the reaction

This method is called to build a reactiont from its children. It might fail if reactants are not properly aligned with the reaction arrows. Accepted children are molecules and texts to be used as reactants or products, and reaction arrows.

Returns: true in case of success and false if failed.

bool gcp::Reaction::BuildContextualMenu	(	gcu::UIManager *	UIManager,
		gcu::Object *	object,
		double	x,
		double	y
	)

virtual

Parameters

UIManager	the gcu::UIManager to populate.
object	the Object on which occured the mouse click.
x	x coordinate of the mouse click.
y	y coordinate of the mouse click.

This method is called to build a contextual menu for the reaction.

Returns: true if something is added to the UIManager, false otherwise.

Reimplemented from gcu::Object.

double gcp::Reaction::GetYAlign ( )

virtual

Used to retrieve the y coordinate for alignment.

Returns: y coordinate used for the reaction alignment.

Reimplemented from gcu::Object.

bool gcp::Reaction::Load ( xmlNodePtr node )

virtual

Parameters

node,: a pointer to the xmlNode containing the serialized reaction.

Used to load an reaction in memory.

Returns: true on succes, false otherwise.

Reimplemented from gcu::Object.

std::string gcp::Reaction::Name ( )

virtual

Returns: the localized object generic name.

Reimplemented from gcu::Object.

bool gcp::Reaction::OnSignal	(	gcu::SignalId	Signal,
		gcu::Object *	Child
	)

virtual

Parameters

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 reaction, when one of its children changed. It should not be called by a program; call Object::EmitSignal instead.

Returns: true if the signal should be propagated to the parent, false otherwise.

Reimplemented from gcu::Object.

void gcp::Reaction::Transform2D	(	gcu::Matrix2D &	m,
		double	x,
		double	y
	)

virtual

Parameters

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 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.

The documentation for this class was generated from the following file:

reaction.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation