fragment.h

Go to the documentation of this file.

// -*- C++ -*-

/*
 * GChemPaint library
 * fragment.h
 *
 * Copyright (C) 2002-2011 Jean Bréfort <jean.brefort@normalesup.org>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
 * USA
 */

#ifndef GCHEMPAINT_FRAGMENT_H
#define GCHEMPAINT_FRAGMENT_H

#include "text-object.h"
#include <gccv/item-client.h>
#include <gccv/text-tag.h>

namespace gccv {
        class Text;
}

namespace gcp {

extern gccv::Tag ChargeTag, StoichiometryTag;

class ChargeTextTag: public gccv::PositionTextTag
{
public:
        ChargeTextTag (double size);
        virtual ~ChargeTextTag ();

        TextTag *Restrict (TextTag *tag);
};

class StoichiometryTextTag: public gccv::PositionTextTag
{
public:
        StoichiometryTextTag (double size);
        virtual ~StoichiometryTextTag ();

        TextTag *Restrict (TextTag *tag);
};

class FragmentAtom;
class Atom;

class Fragment: public TextObject
{
public:
        Fragment ();
        Fragment (double x, double y);
        virtual ~Fragment ();

        void AddItem ();
        void UpdateItem ();
        void SetSelected (int state);
        xmlNodePtr Save (xmlDocPtr xml) const;
        xmlNodePtr SaveSelection (xmlDocPtr xml) const;
        bool Load (xmlNodePtr node);
        bool OnChanged (bool save);
        void AnalContent ();
        void AnalContent (unsigned start, unsigned &end);
        Object* GetAtomAt (double x, double y, double z = 0.);
        void Move (double x, double y, double z = 0);
        void Transform2D (gcu::Matrix2D& m, double x, double y);
        void OnChangeAtom ();
        Atom  *GetAtom () {return reinterpret_cast < Atom * > (m_Atom);}
        Atom const *GetAtom () const {return reinterpret_cast < Atom const * > (m_Atom);}
        int GetElementAtPos (unsigned start, unsigned &end);
        gccv::Anchor GetChargePosition (FragmentAtom *pAtom, unsigned char &Pos, double Angle, double &x, double &y);
        int GetAvailablePosition (double &x, double &y);
        bool GetPosition (double angle, double &x, double &y);
        bool Validate ();
        double GetYAlign ();

        bool SetProperty (unsigned property, char const *value);

        bool Analyze ();

        void Update ();

        gccv::Item *GetChargeItem ();

        std::string Name ();
        bool GetCoords (double *x, double *y, double *z = NULL) const;
        typedef enum {
                Invalid,
                Valid,
                Valid2D,
                Valid3D
        } Validity;

        typedef enum {
                AutoMode,
                NormalMode,
                SubscriptMode,
                SuperscriptMode,
                ChargeMode,
                StoichiometryMode
        } FragmentMode;

private:
        bool SavePortion (xmlDocPtr xml, xmlNodePtr node, unsigned start, unsigned end) const;

private:
        FragmentAtom *m_Atom;
        unsigned m_BeginAtom, m_EndAtom;
        double m_lbearing;
        double m_CHeight;
        bool m_Inversable;

GCU_RO_PROP (Validity, Valid)
GCU_PROP (FragmentMode, Mode)
};

}       //      namespace gcp

#endif  //GCHEMPAINT_FRAGMENT_H