GElement.h

/***************************************************************************
 *   Copyright (C) 2003-2005 by Raphael Langerhorst                        *
 *   raphael-langerhorst@gmx.at                                            *
 *                                                                         *
 *   Permission is hereby granted, free of charge, to any person obtaining *
 *   a copy of this software and associated documentation files (the       *
 *   "Software"), to deal in the Software without restriction, including   *
 *   without limitation the rights to use, copy, modify, merge, publish,   *
 *   distribute, sublicense, and/or sell copies of the Software, and to    *
 *   permit persons to whom the Software is furnished to do so, subject to *
 *   the following conditions:                                             *
 *                                                                         *
 *   The above copyright notice and this permission notice shall be        *
 *   included in all copies or substantial portions of the Software.       *
 *                                                                         *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,       *
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF    *
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR     *
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR *
 *   OTHER DEALINGS IN THE SOFTWARE.                                       *
 ***************************************************************************/


#ifndef GELEMENTH
#define GELEMENTH

#include <QDataStream>
#include <QDateTime>
#include <QObject>
// #include <q3ptrlist.h>
#include <QEvent>
#include <qdom.h>
#include <QCustomEvent>
#include <QStringList>


namespace GCS
{

class GObject;
class GEnergy;
class GForm;
class GMatrix44;
class GElementID;
class GElementInfluence;
class GAgent;

class GElement : public QObject
{
  //defines GElement to be a Q_OBJECT;
  //this means that the signal and slot mechanism provided by Qt
  //can be used;
  Q_OBJECT

  private:

    GObject* Object;

    QList<GAgent*> Agents;
    
    QDateTime ParkTime;
    
  protected:
  
    virtual ~GElement();

  public:

    GElement(GObject* object, const QDateTime& park_time = QDateTime::currentDateTime());

    const GElementID& getElementID() const;
    
    QDateTime getParkTime() const;

    bool isParked();
    
    QList<const GAgent*> getAgents() const;
    
    const GObject* getObject() const;
    
    GObject* getObject();

    QStringList getAvailableActions() const;
    
    QString getActionDescription(const QString& action) const;
    
    virtual void customEvent(QEvent* event);
    
    typedef enum {ELEMENTCHANGED=65031, SENDINFLUENCE=65032, RADIATEINFLUENCE=65033,
                  PARENTCHANGED=65034, INFLUENCERECEIVED=65035, ACTIONPERFORMED=65036,
                  ENERGYCHANGED=65037, FORMCHANGED=65038, ELEMENTDATACHANGED=65039,
                  CHILDCREATED=65040, CHILDREMOVED=65041, DELETESELF=65042} ElementSignalType;
    
  protected slots:
    
    //BEGIN slots used internally to synchronize agent signals into the main thread
    
    void collectElementChanged();
    
    void collectSendInfluence(const GCS::GElementInfluence& influence,
                              const GCS::GElementID& destination);
    
    void collectRadiateInfluence(const GCS::GElementInfluence& influence,
                                 double radius_factor);
    
    void collectParentChanged(const GCS::GElementID& oldParent, const GCS::GElementID& newParent, const GCS::GMatrix44& transformation);
    
    void collectInfluenceReceived(const GCS::GElementInfluence& influence);
    
    void collectActionPerformed(const QString& action, QStringList params, const QString& agent);
    
    void collectEnergyChanged(const GCS::GEnergy& changedEnergy);
    
    void collectFormChanged(const GCS::GForm& changedForm);
    
    void collectElementDataChanged(const QString& xmlpath);
    
    void collectChildCreated(GCS::GElement* newElement);
    
    void collectChildRemoved(const GCS::GElementID& childID);
    
    //END slots used internally to synchronize agent signals into the main thread
    
    void checkReadyDelete();

    
  public slots:
  
    virtual void deleteSelf();

    void receiveInfluence(const GCS::GElementInfluence&);
    
    void performAction(const QString& action, QStringList params, const QString& agent = QString());

    void addAgent(GCS::GAgent* agent);
    
    void removeAgent(GCS::GAgent* agent, bool del=FALSE);

  signals:  // signals used inside the element
  
    void park();

    void execute(double seconds_elapsed);

    void forwardInfluenceInternal(const GCS::GElementInfluence&);
    
    void notifyReparentingInternal(const GCS::GElementID& old_parent, const GCS::GElementID& new_parent, const GCS::GMatrix44& transformation);
    
    
  public: //these two methods are necessary to raise internal signals;
    
    void parkElement();
    
    void executeElement(double seconds_delta_t_offset = 0);
    
  signals:  // signals related to influence
    
    void sendInfluence(const GCS::GElementInfluence& influence, const GCS::GElementID& destination);

    void radiateInfluence(const GCS::GElementInfluence& influence, double radius_factor);

  signals:  // signals used for border communication (GWE)
    
    void elementChanged(const GCS::GElementID& element);
    
    //BEGIN signals that are important for consistent distributed data management
    
    void parentChanged(const GCS::GElementID& newParent, const GCS::GElementID& oldParent, const GCS::GMatrix44& transformation);
    
    void influenceReceived(const GCS::GElementInfluence& influence);
    
    void actionPerformed(const QString& action, QStringList params, const QString& agent);
    
    //END signals that are important for consistent distributed data management
    
    //signals from GAgent
    
    void energyChanged(const GCS::GEnergy& changedEnergy);

    void formChanged(const GCS::GForm& changedForm);

    void elementDataChanged(const QString& xmlpath);
    
    void childElementCreated(GCS::GElement* newElement);
    
    void childElementRemoved(const GCS::GElementID& childID);
};

}

#endif

---