include/symbology/compositeSymbol.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2006 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: compositeSymbol.h,v $ $Revision: 1.52 $ $State: Exp $
*******************************************************************************/


#ifndef DtCompositeSymbol_H_
#define DtCompositeSymbol_H_

#include "symbology/symbol.h"
#include "symbology/symbologyDefines.h"

class DtLineSymbol;

const int DtShowSymbolIndicatorsAlways = 0;
const int DtShowSymbolIndicatorsNever = 1;
const int DtShowSymbolIndicatorsWhenSelected = 2;


class DT_DLL_symbology DtCompositeSymbol : public DtSymbol
{
   Q_OBJECT

public:
   DtCompositeSymbol(const DtCompositeSymbol& orig);
   DtCompositeSymbol& operator=(const DtCompositeSymbol& orig);
   virtual ~DtCompositeSymbol();
   
   DtCompositeSymbol( DtSymbolDrawer & drawer );
   DtCompositeSymbol( DtSymbolDrawer & drawer,
                   const DtDisplayPoint & center);

   virtual DtSymbol* clone() const;

   virtual bool setLocationData(const QPolygon*);

   void shift(QPoint p);

   //Draw -> draws the children not itself... 
   virtual void draw(QPainter& paint) const;
   virtual void drawHidden(QPainter& paint) const;

   virtual const DtDisplayPoint centerPoint() const;

   virtual bool select(const QPoint& point);

   virtual void addSymbol(DtSymbol* symbol, bool isALabel = false);

   virtual void removeSymbol(const DtSymbol* symbol, bool deleteSymbol = true, bool resetMainSymbol = false);
   virtual void removeSymbol(int iIndex, bool deleteSymbol = true, bool resetMainSymbol = false);

   virtual void removeAllSymbols(const QVector<DtSymbol*>& except = QVector<DtSymbol*>());

   virtual DtSymbol* setMainSymbol(DtSymbol* symbol);
   virtual DtSymbol* mainSymbol() const;

   virtual DtSymbol* getSymbolByName(const QString& name);

   virtual bool isComposite() {return true;}

   virtual QSize bbox() const;

   virtual QRect selBbox() const;

   virtual bool overlapsSymbol(const DtSymbol & aSymbol, 
      const DtSymbol_OverlapTest aTest = DtSymbol_BoxPieces,
      const float aTolerance = 0) const;

   //This function JUST compares the labels of the object for
   //overlap as opposed to the object itself
   virtual bool labelsOverlapsSymbol(const DtSymbol & aSymbol, 
      const DtSymbol_OverlapTest aTest = DtSymbol_BoundingBox,
      const float aTolerance = 0) const;

   virtual DtSymbolList* childrenList() const;
   virtual DtSymbolList* labelList() const;

   virtual bool show(DtShowHideContext module);

   virtual bool hide(DtShowHideContext module);

   virtual void setDrawOrder();

   virtual DtSymbol* editableSymbol();

   virtual int labelOffset(const DtSymbol* s) const;
   virtual void setLabelOffset(int i);

   virtual const QPoint& lowestLabelOffset() const;

   virtual void setTransparencyLevel(int i);

   virtual void hideAllChildren(DtShowHideContext iModule = DtDefaultShowHideContext);

   virtual void showAllChildren(DtShowHideContext iModule = DtDefaultShowHideContext);

   virtual void setShadowText(bool b);

   virtual void blockSignals(bool);

   virtual bool originIsCenterOfMass() const;

   static DtSymbol* create(DtSymbolDrawer& drawer);
   virtual void setCacheSymbolAsBitmap(bool);

   virtual void setShowIndicatorOption(int);
   int showIndicatorOption() const;

   virtual DtShowHideContext mapIndicatorOptionToContext(int) const;
   virtual void setHighlight(const bool highlight);

   virtual bool editMode();
   virtual void setEditMode(bool onOff);

   virtual void reset();

protected:
   virtual bool transparentCacheChanged() const;
   virtual void cacheTransparentVariables();

protected slots:
   virtual void symbolDestroyed(const DtSymbol *s);

   virtual void symbolRemoved(const DtSymbol* s);

protected:
   virtual void setChildrenList(DtSymbolList* list);

   virtual bool forceUpdate() const;

   virtual void draw(DtSymbol* symbol, QPainter& paint) const;
   virtual void drawHidden(DtSymbol* symbol, QPainter& paint) const;

   virtual void setScaleBy(double factor);
   virtual bool isScalable() const;

   virtual void setupSelect();
   virtual void selectSymbols();

   virtual void wasHidden(DtSymbol* sym);
   virtual void wasShown(DtSymbol* sym);

private:
   DtCompositeSymbol();

protected:
   DtSymbolList* myChildrenList;
   DtSymbolList* myLabelList;
   DtSymbol* myMainSymbol;
   DtSymbolList* myDrawOrder;
   DtSymbolList* mySelectedChildren;
   int myLabelOffset;
   QPoint myLastParentOffset;
   bool myShadowText;
   int myShowIndicatorOption;
};

inline int DtCompositeSymbol::showIndicatorOption() const
{
   return myShowIndicatorOption;
}

#endif