RDocumentInterface.h

Go to the documentation of this file.

 
#ifndef RDOCUMENTINTERFACE_H
#define RDOCUMENTINTERFACE_H
 
#include "core_global.h"
 
#include <QList>
#include <QMap>
#include <QStack>
#include <QQueue>
 
#include "RAction.h"
#include "RLineweight.h"
#include "RUcs.h"
#include "RSnap.h"
 
#define RDEFAULT_QLIST_QREAL QList<qreal>()
#ifndef RDEFAULT_MIN1
#define RDEFAULT_MIN1 -1
#endif
 
#ifndef RDEFAULT_QVARIANTMAP
#define RDEFAULT_QVARIANTMAP QVariantMap()
#endif
 
class RBlock;
class RBlockListener;
class RBox;
class RColor;
class RCommandEvent;
class RCoordinateEvent;
class RCoordinateListener;
class RDocument;
class RDocumentInterface;
class REntity;
class RGraphicsScene;
class RGraphicsSceneDrawable;
class RGraphicsView;
class RInputEvent;
class RLayer;
class RLayerListener;
class RLinetypePattern;
class RMouseEvent;
class RObject;
class ROperation;
class RPropertyEvent;
class RRefPoint;
class RScriptHandler;
class RShape;
class RSnapRestriction;
class RStorage;
class RTabletEvent;
class RTerminateEvent;
class RTransaction;
class RTransactionListener;
class RVector;
class RViewportEntity;
class RWheelEvent;
 
 
 
class QCADCORE_EXPORT RDocumentInterface {
public:
    enum IoErrorCode {
        IoErrorNoError,
        IoErrorNoImporterFound,
        IoErrorZeroSize,
        IoErrorNotFound,
        IoErrorPermission,
        IoErrorGeneralImportError,
        IoErrorGeneralImportUrlError
    };
 
public:
    RDocumentInterface(RDocument& document);
    ~RDocumentInterface();
 
    void clearCaches();
 
    RDocument& getDocument();
    RStorage& getStorage();
    QList<RGraphicsScene*> getGraphicsScenes();
    RGraphicsView* getGraphicsViewWithFocus();
    RGraphicsScene* getGraphicsSceneWithFocus();
 
    void addCoordinateListener(RCoordinateListener* l);
    void removeCoordinateListener(RCoordinateListener* l);
    void notifyCoordinateListeners();
 
    void addLayerListener(RLayerListener* l);
    void removeLayerListener(RLayerListener* l);
    void notifyLayerListeners(QList<RObject::Id>& layerIds);
 
    void addBlockListener(RBlockListener* l);
    void removeBlockListener(RBlockListener* l);
    void notifyBlockListeners(RDocumentInterface* documentInterface);
    void notifyBlockListenersCurrentBlock(RDocumentInterface* documentInterface);
 
    int addTransactionListener(RTransactionListener* l);
    void removeTransactionListener(int key);
    void removeTransactionListener(RTransactionListener* l);
    void notifyTransactionListeners(RTransaction* t);
 
    void clear(bool beforeLoad=false);
 
    void deleteScriptHandler(const QString& extension);
    RScriptHandler* getScriptHandler(const QString& extension);
    bool isScriptRunning();
 
    void setDefaultAction(RAction* action);
    RAction* getDefaultAction() const;
    void setCurrentAction(RAction* action);
    void terminateCurrentAction();
    void queueAction(RAction* action);
    void killAllActions();
 
    RAction* getCurrentAction();
    bool hasCurrentAction() const;
    RAction* getCurrentStatefulAction();
    bool hasCurrentStatefulAction() const;
 
    void suspend();
    void resume();
 
    void setClickMode(RAction::ClickMode m);
    RAction::ClickMode getClickMode();
 
    void terminateEvent(RTerminateEvent& event);
 
    void keyPressEvent(QKeyEvent& event);
    void keyReleaseEvent(QKeyEvent& event);
    void mouseMoveEvent(RMouseEvent& event);
    void mousePressEvent(RMouseEvent& event);
    void mouseReleaseEvent(RMouseEvent& event);
    void mouseDoubleClickEvent(RMouseEvent& event);
    void coordinateEvent(RCoordinateEvent& event);
    void coordinateEventPreview(RCoordinateEvent& event);
    void commandEvent(RCommandEvent& event);
    void commandEventPreview(RCommandEvent& event);
    void wheelEvent(RWheelEvent& event);
    void tabletEvent(RTabletEvent& event);
    void swipeGestureEvent(QSwipeGesture& gesture);
    void panGestureEvent(QPanGesture& gesture);
    void pinchGestureEvent(QPinchGesture& gesture);
 
    void propertyChangeEvent(RPropertyEvent& event);
    void ucsSetEvent(const QString& ucsName);
    void zoomChangeEvent(RGraphicsView& view);
 
    void enableUpdates();
    void disableUpdates();
 
    void enableRegeneration();
    void disableRegeneration();
 
    void enableMouseTracking();
    void disableMouseTracking();
 
    void setAllowSnapInterruption(bool on);
 
    void updateAllEntities();
 
    void regenerateScenes(bool undone = false, bool invisible = false);
    void regenerateScenes(QSet<RObject::Id>& entityIds, bool updateViews);
    void regenerateScenes(RObject::Id entityId, bool updateViews);
 
    void updateSelectionStatus(QSet<RObject::Id>& entityIds, bool updateViews);
    void updateSelectionStatus(RObject::Id entityId, bool updateViews);
 
    void regenerateViews(bool force=false);
    void regenerateViews(QSet<RObject::Id>& entityIds);
    void repaintViews();
 
    void registerScene(RGraphicsScene& scene);
    void unregisterScene(RGraphicsScene& scene);
 
    void setCursor(const QCursor& cursor, bool global = true);
 
    RDocumentInterface::IoErrorCode importUrl(
        const QUrl& url, const QString& nameFilter = "", bool notify = true, const QVariantMap& params = RDEFAULT_QVARIANTMAP);
    RDocumentInterface::IoErrorCode importFile(
        const QString& fileName, const QString& nameFilter = "", bool notify = true, const QVariantMap& params = RDEFAULT_QVARIANTMAP);
 
    QString getCorrectedFileName(const QString& fileName, const QString& fileVersion);
    bool exportFile(const QString& fileName, const QString& fileVersion = "", bool resetModified = true);
 
    void tagState(const QString& tag = "");
    void undoToTag(const QString& tag = "");
    void undo();
    void redo();
    void flushTransactions();
    void flushRedo();
 
    void setSnap(RSnap* snap);
    RSnap* getSnap();
 
    RSnap::Status getSnapStatus() const {
        return lastSnapState;
    }
 
    void setSnapRestriction(RSnapRestriction* snapRestriction);
    RSnapRestriction* getSnapRestriction();
 
    RVector snap(RMouseEvent& event, bool preview = false);
    RVector restrictOrtho(const RVector& position, const RVector& relativeZero, RS::OrthoMode mode = RS::Orthogonal);
 
    RObject::Id getClosestEntity(RInputEvent& event);
    RObject::Id getClosestEntity(const RVector& position,
        double range, double strictRange = RMAXDOUBLE,
        bool includeLockedLayers = true,
        bool selectedOnly = false);
    void highlightEntity(RObject::Id entityId);
    void highlightReferencePoint(const RRefPoint& position);
    int selectEntities(const QSet<RObject::Id>& entityIds, bool add = false);
    void selectEntity(RObject::Id entityId, bool add = false);
    int deselectEntities(const QSet<RObject::Id>& entityIds);
    void deselectEntity(RObject::Id entityId);
    void selectBoxXY(const RBox& box, bool add = false);
    void selectAll();
    void deselectAll();
    void clearSelection();
    bool hasSelection();
 
    void addZoomBoxToPreview(const RBox& box);
    void addShapeToPreview(RShape& shape, const RColor& color,
            const QBrush& brush, RLineweight::Lineweight lineweight,
            Qt::PenStyle style, const QList<qreal>& dashValues = RDEFAULT_QLIST_QREAL);
    void addAuxShapeToPreview(RShape& shape);
    //void addEntityToPreview(REntity& entity);
    void addDrawableToPreview(RGraphicsSceneDrawable& drawable);
    void beginPreview();
    void endPreview();
    void clearPreview();
    bool isPreviewEmpty();
    void keepPreview();
 
    void showPropertiesOf(REntity& entity);
    void clearProperties();
 
    void zoomIn();
    void zoomOut();
    void autoZoom(int margin = RDEFAULT_MIN1);
    bool zoomToSelection();
    void zoomTo(const RBox& region, int margin = 0);
    void zoomPrevious();
 
    void previewOperation(ROperation* operation);
    RTransaction applyOperation(ROperation* operation);
 
    void objectChangeEvent(RTransaction& transaction);
 
    RVector getRelativeZero() const;
    RVector getLastPosition() const;
    void setRelativeZero(const RVector& p);
 
    void lockRelativeZero();
    void unlockRelativeZero();
    bool isRelativeZeroLocked() const;
 
    void lockSnap();
    void unlockSnap();
    void toggleSnapLock();
    bool isSnapLocked() const;
 
    RVector getCursorPosition() const;
    void setCursorPosition(const RVector& p);
    void setCursorOverride(bool on);
    bool getCursorOverride() const;
 
    void deleteTerminatedActions();
 
    void setCurrentColor(const RColor& color);
    RColor getCurrentColor();
 
    void setCurrentLineweight(RLineweight::Lineweight lw);
    RLineweight::Lineweight getCurrentLineweight();
 
    void setCurrentLinetype(RObject::Id ltId);
    void setCurrentLinetypePattern(const RLinetypePattern& p);
    RObject::Id getCurrentLinetypeId();
    RLinetypePattern getCurrentLinetypePattern();
 
    void setCurrentLayer(RObject::Id layerId);
    void setCurrentLayer(const RLayer& layer);
    void setCurrentLayer(const QString& layerName);
 
    void setCurrentBlock(RObject::Id blockId);
    void setCurrentBlock(const RBlock& block);
    void setCurrentBlock(const QString& blockName);
 
    void setCurrentViewport(const RViewportEntity& viewport);
    void unsetCurrentViewport();
 
    void setCurrentView(const QString& viewName);
 
    void setCurrentUcs(const RUcs& ucs);
    void setCurrentUcs(const QString& ucsName);
    RUcs getCurrentUcs();
    QString getCurrentUcsName();
 
    RGraphicsView* getLastKnownViewWithFocus();
    void setLastKnownViewWithFocus(RGraphicsView* view);
 
    static RDocumentInterface& getClipboard();
    static void deleteClipboard();
    bool isClipboard() {
        return this==clipboard;
    }
    bool isSuspended() {
        return suspended;
    }
    void setNotifyListeners(bool on);
    bool getNotifyListeners() const {
        return notifyGlobalListeners;
    }
 
    bool isDeleting() const {
        return deleting;
    }
 
    QVariant eval(const QString& ext, const QString& script);
 
//    QTransform getInputTransform() const {
//        return inputTransform;
//    }
 
//    void setInputTransform(const QTransform& t) {
//        inputTransform = t;
//    }
 
private:
    void handleClickEvent(RAction& action, RMouseEvent& event);
    void previewClickEvent(RAction& action, RMouseEvent& event);
 
private:
    RDocument& document;
    QList<RGraphicsScene*> scenes;
    RGraphicsView* lastKnownViewWithFocus;
    QMap<QString, RScriptHandler*> scriptHandlers;
 
    RAction* defaultAction;
    QStack<RAction*> currentActions;
    QQueue<RAction*> queuedActions;
 
    QList<RCoordinateListener*> coordinateListeners;
    QList<RLayerListener*> layerListeners;
    QList<RBlockListener*> blockListeners;
    QMap<int, RTransactionListener*> transactionListeners;
 
    RSnap* currentSnap;
    RSnapRestriction* currentSnapRestriction;
    RSnap::Status lastSnapState;
 
    RVector lastPosition;
    RVector relativeZero;
    bool relativeZeroLocked;
    bool snapLocked;
    RVector cursorPosition;
    RUcs currentUcs;
    QString currentUcsName;
    bool suspended;
 
    bool allowUpdate;
    bool allowRegeneration;
 
    bool notifyGlobalListeners;
    bool deleting;
    bool cursorOverride;
 
    bool keepPreviewOnce;
    bool mouseTrackingEnabled;
    bool allowSnapInterruption;
 
    QMap<QString, int> tags;
 
    RDocument* previewDocument;
 
    // transform for all input coordinates:
//    QTransform inputTransform;
 
    static RDocumentInterface* clipboard;
};
 
Q_DECLARE_METATYPE(RDocumentInterface::IoErrorCode)
Q_DECLARE_METATYPE(RDocumentInterface*)
 
#endif